DHIN 2025Connectathon FHIR IG
0.1.0 - draft

DHIN 2025Connectathon FHIR IG, published by DHIN. 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/Nigeria-FHIR-Community/2025Connectathon/ and changes regularly. See the Directory of published versions

Resource Profile: NG Immunization

Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/NgImmunization Version: 0.1.0
Draft as of 2025-10-21 Computable Name: NgImmunization

Nigerian Profile for Immunization resource.

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: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:contraindications S 0..* CodeableConcept NG Vaccine Contraindications
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications
Binding: NG Vaccine Contraindication VS (extensible)
.... extension:contraindicated S 0..* boolean NG Immunization Contraindicated
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Status of Immunization e.g. completed| entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason immunization was not done (or was missed)
Binding: ImmunizationStatusReasonCodes (extensible)
... vaccineCode Σ 1..1 CodeableConcept Vaccine Product Administered
Binding: NG Vaccine Local ValueSet (required)
... patient Σ 1..1 Reference(NG Patient) Who was immunized
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... manufacturer 0..1 Reference(NG Organization) Manufacturer description and identity
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (preferred)
... doseQuantity S 1..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer SΣ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Designation of reporting officer
Binding: ImmunizationFunctionCodes (extensible)
.... actor Σ 1..1 Reference(NG Practitioner) Information of reporting officer
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:nextDoseDate S 0..1 date NG Next Dose Date
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📦4.0.1 FHIR Std.
Immunization.vaccineCode Base required NG Vaccine Local ValueSet 📦0.1.0 This IG
Immunization.site Base preferred Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base preferred Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:contraindications S 0..* CodeableConcept NG Vaccine Contraindications
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications
Binding: NG Vaccine Contraindication VS (extensible)
.... extension:contraindicated S 0..* boolean NG Immunization Contraindicated
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated
... identifier 0..1 Identifier Business identifier
... status S 1..1 code Status of Immunization e.g. completed| entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... vaccineCode 1..1 CodeableConcept Vaccine Product Administered
Binding: NG Vaccine Local ValueSet (required)
... patient 1..1 Reference(NG Patient) Who was immunized
... occurrence[x] 1..1 dateTime Vaccine administration date
... manufacturer 0..1 Reference(NG Organization) Manufacturer description and identity
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (preferred)
... doseQuantity S 1..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer S 0..* BackboneElement Who performed event
.... function 0..1 CodeableConcept Designation of reporting officer
Binding: ImmunizationFunctionCodes (extensible)
.... actor 1..1 Reference(NG Practitioner) Information of reporting officer
... reaction
.... detail 0..1 Reference(NG Observations) Additional information on reaction
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:nextDoseDate S 0..1 date NG Next Dose Date
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📦4.0.1 FHIR Std.
Immunization.vaccineCode Base required NG Vaccine Local ValueSet 📦0.1.0 This IG
Immunization.site Base preferred Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base preferred Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:contraindications S 0..* CodeableConcept NG Vaccine Contraindications
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications
Binding: NG Vaccine Contraindication VS (extensible)
.... extension:contraindicated S 0..* boolean NG Immunization Contraindicated
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..1 Identifier Business identifier
... status ?!SΣ 1..1 code Status of Immunization e.g. completed| entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason immunization was not done (or was missed)
Binding: ImmunizationStatusReasonCodes (extensible)
... vaccineCode Σ 1..1 CodeableConcept Vaccine Product Administered
Binding: NG Vaccine Local ValueSet (required)
... patient Σ 1..1 Reference(NG Patient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(NG Organization) Manufacturer description and identity
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (preferred)
... doseQuantity S 1..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer SΣ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Designation of reporting officer
Binding: ImmunizationFunctionCodes (extensible)
.... actor Σ 1..1 Reference(NG Practitioner) Information of reporting officer
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(NG Observations) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:nextDoseDate S 0..1 date NG Next Dose Date
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📦4.0.1 FHIR Std.
Immunization.vaccineCode Base required NG Vaccine Local ValueSet 📦0.1.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base preferred Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base preferred Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:contraindications S 0..* CodeableConcept NG Vaccine Contraindications
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications
Binding: NG Vaccine Contraindication VS (extensible)
.... extension:contraindicated S 0..* boolean NG Immunization Contraindicated
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code Status of Immunization e.g. completed| entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason immunization was not done (or was missed)
Binding: ImmunizationStatusReasonCodes (extensible)
... vaccineCode Σ 1..1 CodeableConcept Vaccine Product Administered
Binding: NG Vaccine Local ValueSet (required)
... patient Σ 1..1 Reference(NG Patient) Who was immunized
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... manufacturer 0..1 Reference(NG Organization) Manufacturer description and identity
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (preferred)
... doseQuantity S 1..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer SΣ 0..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Designation of reporting officer
Binding: ImmunizationFunctionCodes (extensible)
.... actor Σ 1..1 Reference(NG Practitioner) Information of reporting officer
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:nextDoseDate S 0..1 date NG Next Dose Date
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📦4.0.1 FHIR Std.
Immunization.vaccineCode Base required NG Vaccine Local ValueSet 📦0.1.0 This IG
Immunization.site Base preferred Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base preferred Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:contraindications S 0..* CodeableConcept NG Vaccine Contraindications
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications
Binding: NG Vaccine Contraindication VS (extensible)
.... extension:contraindicated S 0..* boolean NG Immunization Contraindicated
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated
... identifier 0..1 Identifier Business identifier
... status S 1..1 code Status of Immunization e.g. completed| entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... vaccineCode 1..1 CodeableConcept Vaccine Product Administered
Binding: NG Vaccine Local ValueSet (required)
... patient 1..1 Reference(NG Patient) Who was immunized
... occurrence[x] 1..1 dateTime Vaccine administration date
... manufacturer 0..1 Reference(NG Organization) Manufacturer description and identity
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (preferred)
... doseQuantity S 1..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer S 0..* BackboneElement Who performed event
.... function 0..1 CodeableConcept Designation of reporting officer
Binding: ImmunizationFunctionCodes (extensible)
.... actor 1..1 Reference(NG Practitioner) Information of reporting officer
... reaction
.... detail 0..1 Reference(NG Observations) Additional information on reaction
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:nextDoseDate S 0..1 date NG Next Dose Date
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📦4.0.1 FHIR Std.
Immunization.vaccineCode Base required NG Vaccine Local ValueSet 📦0.1.0 This IG
Immunization.site Base preferred Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base preferred Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* Immunization Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:contraindications S 0..* CodeableConcept NG Vaccine Contraindications
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications
Binding: NG Vaccine Contraindication VS (extensible)
.... extension:contraindicated S 0..* boolean NG Immunization Contraindicated
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..1 Identifier Business identifier
... status ?!SΣ 1..1 code Status of Immunization e.g. completed| entered-in-error | not-done
Binding: ImmunizationStatusCodes (required)
... statusReason 0..1 CodeableConcept Reason immunization was not done (or was missed)
Binding: ImmunizationStatusReasonCodes (extensible)
... vaccineCode Σ 1..1 CodeableConcept Vaccine Product Administered
Binding: NG Vaccine Local ValueSet (required)
... patient Σ 1..1 Reference(NG Patient) Who was immunized
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location) Where immunization occurred
... manufacturer 0..1 Reference(NG Organization) Manufacturer description and identity
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (preferred)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (preferred)
... doseQuantity S 1..1 SimpleQuantity(4.0.1) Amount of vaccine administered
... performer SΣ 0..* BackboneElement Who performed event
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function Σ 0..1 CodeableConcept Designation of reporting officer
Binding: ImmunizationFunctionCodes (extensible)
.... actor Σ 1..1 Reference(NG Practitioner) Information of reporting officer
... note Σ 0..* Annotation Additional immunization notes
... reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
... reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
... isSubpotent ?!Σ 0..1 boolean Dose potency
... subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
... education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... documentType 0..1 string Educational material document identifier
.... reference 0..1 uri Educational material reference pointer
.... publicationDate 0..1 dateTime Educational material publication date
.... presentationDate 0..1 dateTime Educational material presentation date
... programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
... fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
... reaction 0..* BackboneElement Details of a reaction that follows immunization
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... date 0..1 dateTime When reaction started
.... detail 0..1 Reference(NG Observations) Additional information on reaction
.... reported 0..1 boolean Indicates self-reported reaction
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:nextDoseDate S 0..1 date NG Next Dose Date
URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... series 0..1 string Name of vaccine series
.... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: ImmunizationTargetDiseaseCodes (example)
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📦4.0.1 FHIR Std.
Immunization.statusReason Base extensible Immunization Status Reason Codes 📦4.0.1 FHIR Std.
Immunization.vaccineCode Base required NG Vaccine Local ValueSet 📦0.1.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.site Base preferred Codes for Immunization Site of Administration 📦4.0.1 FHIR Std.
Immunization.route Base preferred Immunization Route Codes 📦4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📦4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📦4.0.1 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().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(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()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

 

Other representations of profile: CSV, Excel, Schematron