GDHCN Trust Network - Personal Health Wallet
0.1.0 - ci-build International flag

GDHCN Trust Network - Personal Health Wallet, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust-phw/ and changes regularly. See the Directory of published versions

Resource Profile: DVC Immunization

Official URL: http://smart.who.int/trust-phw/StructureDefinition/DVCImmunization Version: 0.1.0
Active as of 2026-10-23 Computable Name: DVCImmunization

This profile represents a vaccination record for Digital Vaccine Certificates

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID This element must be supported. 1..1 Coding, Reference(Medication Catalog Item) Extension
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine administered
Binding: VaccineAdministeredValueSet (example)
Immunization.lotNumber This element must be supported. 0..1 string Vaccine lot number
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization Immunization
Immunization.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID This element must be supported. 1..1 Coding, Reference(Medication Catalog Item) Extension
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.lotNumber This element must be supported. 0..1 string Vaccine lot number
Immunization.occurrence[x] 1..1 dateTime Vaccine administration date
Immunization.performer.actor 1..1 Reference(mCSD Practitioner(4.0.0) | mCSD Organization for Jurisdictions(4.0.0)) Individual or organization who was performing

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID This element must be supported. 1..1 Coding, Reference(Medication Catalog Item) Extension
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Business identifier
Immunization.basedOn This element is included in summaries. 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Authority that the immunization event is based on
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason for current status
Binding: ImmunizationStatusReasonCodes (example)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine administered
Binding: VaccineAdministeredValueSet (example)
Immunization.administeredProduct 0..1 CodeableReference(Medication) Product that was administered
Immunization.manufacturer 0..1 CodeableReference(Organization) Vaccine manufacturer
Immunization.lotNumber This element must be supported. 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.supportingInformation 0..* Reference(Resource) Additional information in support of the immunization
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.primarySource This element is included in summaries. 0..1 boolean Indicates context the data was captured in
Immunization.informationSource 0..1 CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Indicates the source of a reported record
Binding: ImmunizationOriginCodes (example)
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example)
Immunization.doseQuantity C 0..1 SimpleQuantity(5.0.0) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
Immunization.performer.actor This element is included in summaries. 1..1 Reference(mCSD Practitioner(4.0.0) | mCSD Organization for Jurisdictions(4.0.0)) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Why immunization occurred
Binding: ImmunizationReasonCodes (example)
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.programEligibility 0..* BackboneElement Patient eligibility for a specific vaccination program
Immunization.programEligibility.id 0..1 string Unique id for inter-element referencing
Immunization.programEligibility.extension 0..* Extension Additional content defined by implementations
Immunization.programEligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.programEligibility.program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
Immunization.programEligibility.programStatus 1..1 CodeableConcept The patient's eligibility status for the program
Binding: ImmunizationProgramEligibility (example)
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example)
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.manifestation 0..1 CodeableReference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)
Immunization.protocolApplied.doseNumber 1..1 string Dose number within series
Immunization.protocolApplied.seriesDoses 0..1 string Recommended number of doses for immunity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base required All Languages 📍5.0.0 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.
Immunization.informationSource Base example Immunization Origin Codes 📍5.0.0 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍5.0.0 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍5.0.0 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍5.0.0 FHIR Std.
Immunization.reason Base example Immunization Reason Codes 📍5.0.0 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍5.0.0 FHIR Std.
Immunization.programEligibility.​program Base example Vaccine Funding Programs 📍5.0.0 FHIR Std.
Immunization.programEligibility.​programStatus Base example Immunization Program Eligibility 📍5.0.0 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍5.0.0 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Immunization

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID This element must be supported. 1..1 Coding, Reference(Medication Catalog Item) Extension
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine administered
Binding: VaccineAdministeredValueSet (example)
Immunization.lotNumber This element must be supported. 0..1 string Vaccine lot number
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization Immunization
Immunization.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID This element must be supported. 1..1 Coding, Reference(Medication Catalog Item) Extension
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.lotNumber This element must be supported. 0..1 string Vaccine lot number
Immunization.occurrence[x] 1..1 dateTime Vaccine administration date
Immunization.performer
Immunization.performer.actor 1..1 Reference(mCSD Practitioner(4.0.0) | mCSD Organization for Jurisdictions(4.0.0)) Individual or organization who was performing

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Immunization.Slices for extension.extension:productID This element must be supported. 1..1 Coding, Reference(Medication Catalog Item) Extension
URL: http://smart.who.int/pcmt/StructureDefinition/ProductID
Immunization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Business identifier
Immunization.basedOn This element is included in summaries. 0..* Reference(CarePlan | MedicationRequest | ServiceRequest | ImmunizationRecommendation) Authority that the immunization event is based on
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
Immunization.statusReason 0..1 CodeableConcept Reason for current status
Binding: ImmunizationStatusReasonCodes (example)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine administered
Binding: VaccineAdministeredValueSet (example)
Immunization.administeredProduct 0..1 CodeableReference(Medication) Product that was administered
Immunization.manufacturer 0..1 CodeableReference(Organization) Vaccine manufacturer
Immunization.lotNumber This element must be supported. 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.supportingInformation 0..* Reference(Resource) Additional information in support of the immunization
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.primarySource This element is included in summaries. 0..1 boolean Indicates context the data was captured in
Immunization.informationSource 0..1 CodeableReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) Indicates the source of a reported record
Binding: ImmunizationOriginCodes (example)
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example)
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example)
Immunization.doseQuantity C 0..1 SimpleQuantity(5.0.0) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible)
Immunization.performer.actor This element is included in summaries. 1..1 Reference(mCSD Practitioner(4.0.0) | mCSD Organization for Jurisdictions(4.0.0)) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reason 0..* CodeableReference(Condition | Observation | DiagnosticReport) Why immunization occurred
Binding: ImmunizationReasonCodes (example)
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.programEligibility 0..* BackboneElement Patient eligibility for a specific vaccination program
Immunization.programEligibility.id 0..1 string Unique id for inter-element referencing
Immunization.programEligibility.extension 0..* Extension Additional content defined by implementations
Immunization.programEligibility.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.programEligibility.program 1..1 CodeableConcept The program that eligibility is declared for
Binding: CodesForVaccineFundingPrograms (example)
Immunization.programEligibility.programStatus 1..1 CodeableConcept The patient's eligibility status for the program
Binding: ImmunizationProgramEligibility (example)
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example)
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.manifestation 0..1 CodeableReference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)
Immunization.protocolApplied.doseNumber 1..1 string Dose number within series
Immunization.protocolApplied.seriesDoses 0..1 string Recommended number of doses for immunity

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base required All Languages 📍5.0.0 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍5.0.0 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍5.0.0 FHIR Std.
Immunization.vaccineCode Base example Vaccine Administered Value Set 📍5.0.0 FHIR Std.
Immunization.informationSource Base example Immunization Origin Codes 📍5.0.0 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍5.0.0 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍5.0.0 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍5.0.0 FHIR Std.
Immunization.reason Base example Immunization Reason Codes 📍5.0.0 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍5.0.0 FHIR Std.
Immunization.programEligibility.​program Base example Vaccine Funding Programs 📍5.0.0 FHIR Std.
Immunization.programEligibility.​programStatus Base example Immunization Program Eligibility 📍5.0.0 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍5.0.0 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

This structure is derived from Immunization

 

Other representations of profile: CSV, Excel, Schematron