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
Official URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/NgImmunization | Version: 0.1.0 | |||
Draft as of 2025-10-02 | Computable Name: NgImmunization |
Nigerian Profile for Immunization resource.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Immunization | Immunization event information | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NG Vaccine Contraindications URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications Binding: NG Vaccine Contraindication VS (extensible) |
![]() ![]() ![]() ![]() |
S | 0..* | boolean | NG Immunization Contraindicated URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
0..1 | Identifier | Business identifier | |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Status of Immunization e.g. completed| entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason immunization was not done (or was missed) Binding: ImmunizationStatusReasonCodes (extensible) | |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Vaccine Product Administered Binding: NG Vaccine Local ValueSet (required) |
![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Patient) | Who was immunized |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() |
0..1 | Reference(NG Organization) | Manufacturer description and identity | |
![]() ![]() ![]() |
S | 1..1 | string | Vaccine batch number |
![]() ![]() ![]() |
S | 1..1 | date | Vaccine expiration date |
![]() ![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (preferred) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (preferred) | |
![]() ![]() ![]() |
S | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Designation of reporting officer Binding: ImmunizationFunctionCodes (extensible) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Practitioner) | Information of reporting officer |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Protocol followed by the provider |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date | NG Next Dose Date URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |
![]() ![]() ![]() ![]() |
1..1 | Dose number within series | ||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() |
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. |
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
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. |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Immunization | Immunization event information | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NG Vaccine Contraindications URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications Binding: NG Vaccine Contraindication VS (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | boolean | NG Immunization Contraindicated URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifier | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Status of Immunization e.g. completed| entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason immunization was not done (or was missed) Binding: ImmunizationStatusReasonCodes (extensible) | |||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Vaccine Product Administered Binding: NG Vaccine Local ValueSet (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Patient) | Who was immunized | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
![]() ![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() |
0..1 | Reference(NG Organization) | Manufacturer description and identity | |||||
![]() ![]() ![]() |
S | 1..1 | string | Vaccine batch number | ||||
![]() ![]() ![]() |
S | 1..1 | date | Vaccine expiration date | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (preferred) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (preferred) | |||||
![]() ![]() ![]() |
S | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Designation of reporting officer Binding: ImmunizationFunctionCodes (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Practitioner) | Information of reporting officer | ||||
![]() ![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(NG Observations) | Additional information on reaction | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Protocol followed by the provider | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date | NG Next Dose Date URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
![]() ![]() ![]() ![]() |
1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() |
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. |
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()
|
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Immunization | Immunization event information | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NG Vaccine Contraindications URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications Binding: NG Vaccine Contraindication VS (extensible) |
![]() ![]() ![]() ![]() |
S | 0..* | boolean | NG Immunization Contraindicated URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
0..1 | Identifier | Business identifier | |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Status of Immunization e.g. completed| entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason immunization was not done (or was missed) Binding: ImmunizationStatusReasonCodes (extensible) | |
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Vaccine Product Administered Binding: NG Vaccine Local ValueSet (required) |
![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Patient) | Who was immunized |
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date |
![]() ![]() ![]() |
0..1 | Reference(NG Organization) | Manufacturer description and identity | |
![]() ![]() ![]() |
S | 1..1 | string | Vaccine batch number |
![]() ![]() ![]() |
S | 1..1 | date | Vaccine expiration date |
![]() ![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (preferred) | |
![]() ![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (preferred) | |
![]() ![]() ![]() |
S | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered |
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Designation of reporting officer Binding: ImmunizationFunctionCodes (extensible) |
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Practitioner) | Information of reporting officer |
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Protocol followed by the provider |
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date | NG Next Dose Date URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |
![]() ![]() ![]() ![]() |
1..1 | Dose number within series | ||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() |
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. |
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
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | Immunization | Immunization event information | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | NG Vaccine Contraindications URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindications Binding: NG Vaccine Contraindication VS (extensible) | ||||
![]() ![]() ![]() ![]() |
S | 0..* | boolean | NG Immunization Contraindicated URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/contraindicated | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
0..1 | Identifier | Business identifier | |||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | Status of Immunization e.g. completed| entered-in-error | not-done Binding: ImmunizationStatusCodes (required) | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Reason immunization was not done (or was missed) Binding: ImmunizationStatusReasonCodes (extensible) | |||||
![]() ![]() ![]() |
Σ | 1..1 | CodeableConcept | Vaccine Product Administered Binding: NG Vaccine Local ValueSet (required) | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Patient) | Who was immunized | ||||
![]() ![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
![]() ![]() ![]() |
Σ | 1..1 | dateTime | Vaccine administration date | ||||
![]() ![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Indicates context the data was recorded in | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location) | Where immunization occurred | |||||
![]() ![]() ![]() |
0..1 | Reference(NG Organization) | Manufacturer description and identity | |||||
![]() ![]() ![]() |
S | 1..1 | string | Vaccine batch number | ||||
![]() ![]() ![]() |
S | 1..1 | date | Vaccine expiration date | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (preferred) | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (preferred) | |||||
![]() ![]() ![]() |
S | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Who performed event | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Designation of reporting officer Binding: ImmunizationFunctionCodes (extensible) | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(NG Practitioner) | Information of reporting officer | ||||
![]() ![]() ![]() |
Σ | 0..* | Annotation | Additional immunization notes | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
![]() ![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | boolean | Dose potency | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
![]() ![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Educational material document identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When reaction started | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(NG Observations) | Additional information on reaction | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | |||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Protocol followed by the provider | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | date | NG Next Dose Date URL: https://sandbox.dhin-hie.org/ig/StructureDefinition/next-dose-date | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccine series | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |||||
![]() ![]() ![]() ![]() |
1..1 | Dose number within series | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() |
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. |
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()
|
This structure is derived from Immunization
Summary
Mandatory: 3 elements
Must-Support: 9 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron