StructureDefinition-shc-vaccination-ad

Sourcehl7.fhir.uv.shc-vaccination#current:SMART Health Cards: Vaccination & Testing Implementation Guide (v4.0.1)
resourceTypeStructureDefinition
idshc-vaccination-ad
canonicalhttp://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad
version1.0.0-rc
statusdraft
publisherHL7 International - Public Health Work Group
nameSHCVaccinationAD
titleVaccination Profile - Allowable Data
date2023-08-04T14:31:12+00:00
descriptionDefines a [fallback (AD) profile](./profiles.html#conformance-to-profiles) representing a vaccination in a health card. [See here for implementation details](./vaccination.html).
jurisdictionsuv
fhirVersion4.0.1
kindresource
abstractfalse
sdTtypeImmunization
derivationconstraint
basehttp://hl7.org/fhir/StructureDefinition/Immunization
Usages
Name Flags Card. Type Description & Constraints doco
. . Immunization Immunization
. . . id Should not be populated
. . . meta S
. . . . security S ..1 Limited security label to convey identity level of assurance for patient referenced by this resource.
Binding: Identity Assurance Level ( required )
. . . status S Whether or not the vaccination was completed
Fixed Value: completed
. . . statusReason .. 0
. . . vaccineCode S Codes identifying the vaccine product administered
Binding: Immunization / All / CVX ( example )
. . . . Slices for coding S 1 .. Slice: Unordered, Closed by value:system
. . . . . coding:cvx 0..1 CVX code identifying the administered vaccine product
Binding: Immunization / All / CVX ( required )
. . . . . . system 1.. Fixed Value: http://hl7.org/fhir/sid/cvx
. . . . . coding:snomed 0..1 SNOMED CT code identifying the administered vaccine product
Binding: Immunization / All / SNOMED CT ( required )
. . . . . . system 1.. Fixed Value: http://snomed.info/sct
. . . . . coding:icd11 0..1 ICD-11 MMS code identifying the administered vaccine product
Binding: Immunization / All / ICD-11 ( required )
. . . . . . system 1.. Fixed Value: http://id.who.int/icd/release/11/mms
. . . patient S Reference (Patient Profile - General - Allowable Data)
. . . . reference 1.. This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle.
. . . . type .. 0
. . . . identifier .. 0
. . . . display .. 0
. . . occurrence[x] S C dateTime vc-polymorphic-date-invariant: All timestamps SHOULD be represented as Dates (YYYY-MM-DD only).
. . . primarySource Information in this record from person who administered vaccine?
. . . manufacturer
. . . . identifier Only populate when vaccine type is not provided in vaccineCode
. . . . . system C 1.. Code identifying vaccine manufacturer
shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers
. . . . . value 1..
. . . lotNumber S C String representing lot number like `0123L45A`
vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization.
vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc.
. . . performer S ..1
. . . . actor S Reference ( Organization ) Organization which was responsible for vaccine administration.
. . . . . display S C 1.. Short, human-readable text representation of the organization.
vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization.
. . . isSubpotent S C Set to `true` if dose is subpotent; omit otherwise
vc-shall-be-true-if-populated-invariant: Shall be `true` if populated
. . . protocolApplied .. 0

doco Documentation for this format

Produced 08 Sep 2023