NPHCDA Immunization FHIR IG
0.9.0 - ci-build
NPHCDA Immunization FHIR IG
0.9.0 - ci-build
NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.9.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/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions
| Official URL: https://nphcda.gov.ng/ig/StructureDefinition/NgImmImmunization | Version: 0.9.0 | |||
| Draft as of 2026-10-07 | Computable Name: NgImmImmunization | |||
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:  |
|---|---|---|---|---|
  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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
   extension:contraindications |
0..* | CodeableConcept | NG-Imm Vaccine Contraindications URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindications Binding: NG-Imm Vaccine Contraindication VS (extensible) | |
 extension:contraindicated |
0..* | boolean | NG-Imm Immunization Contraindicated URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindicated | |
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
 identifier |
0..1 | Identifier | Business identifier | |
| status |
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 IMMZ.D.DE4 Vaccine Local ValueSet (required) | |
 patient |
1..1 | Reference(NG-Imm Patient) | Who was immunized | |
| occurrence[x] |
1..1 | dateTime | Vaccine administration date | |
| manufacturer |
0..1 | Reference(NG-Imm Organization) | Manufacturer description and identity | |
| lotNumber |
1..1 | string | Vaccine batch number | |
| expirationDate |
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 |
C | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 |
| performer |
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-Imm Practitioner) | Information of reporting officer | |
| isSubpotent |
0..1 | boolean | Dose potency | |
 protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |
 Slices for extension |
0..* | 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 | |
| extension:nextDoseDate |
0..1 | date | NG-Imm Next Dose Date URL: https://nphcda.gov.ng/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 | |||
| Documentation for this format | ||||
| 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 IMMZ.D.DE4 Vaccine Local ValueSet | 📦0.9.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()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| Slices for extension |
0..* | 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 | |
| extension:contraindications |
0..* | CodeableConcept | NG-Imm Vaccine Contraindications URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindications Binding: NG-Imm Vaccine Contraindication VS (extensible) | |
| extension:contraindicated |
0..* | boolean | NG-Imm Immunization Contraindicated URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindicated | |
 identifier |
0..1 | Identifier | Business identifier | |
| status |
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 IMMZ.D.DE4 Vaccine Local ValueSet (required) | |
| patient |
1..1 | Reference(NG-Imm Patient) | Who was immunized | |
| occurrence[x] |
1..1 | dateTime | Vaccine administration date | |
| manufacturer |
0..1 | Reference(NG-Imm Organization) | Manufacturer description and identity | |
| lotNumber |
1..1 | string | Vaccine batch number | |
| expirationDate |
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 |
1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |
| performer |
0..* | BackboneElement | Who performed event | |
| function |
0..1 | CodeableConcept | Designation of reporting officer Binding: ImmunizationFunctionCodes (extensible) | |
| actor |
1..1 | Reference(NG-Imm Practitioner) | Information of reporting officer | |
| reaction |
||||
| detail |
0..1 | Reference(NG-Imm ClientRegistUpdate-Observations) | Additional information on reaction | |
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |
| Slices for extension |
0..* | 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 | |
| extension:nextDoseDate |
0..1 | date | NG-Imm Next Dose Date URL: https://nphcda.gov.ng/ig/StructureDefinition/next-dose-date | |
| targetDisease |
0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |
| Documentation for this format | ||||
| 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 IMMZ.D.DE4 Vaccine Local ValueSet | 📦0.9.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: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:contraindications |
0..* | CodeableConcept | NG-Imm Vaccine Contraindications URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindications Binding: NG-Imm Vaccine Contraindication VS (extensible) | |||||
| extension:contraindicated |
0..* | boolean | NG-Imm Immunization Contraindicated URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindicated | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..1 | Identifier | Business identifier | |||||
| status |
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 IMMZ.D.DE4 Vaccine Local ValueSet (required) | |||||
| patient |
1..1 | Reference(NG-Imm 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-Imm Organization) | Manufacturer description and identity | |||||
| lotNumber |
1..1 | string | Vaccine batch number | |||||
| expirationDate |
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 |
C | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 | ||||
| performer |
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-Imm 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-Imm ClientRegistUpdate-Observations) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:nextDoseDate |
0..1 | date | NG-Imm Next Dose Date URL: https://nphcda.gov.ng/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 | |||||||
| Documentation for this format | ||||||||
| 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()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
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: |
|---|---|---|---|---|
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |
| extension:contraindications |
0..* | CodeableConcept | NG-Imm Vaccine Contraindications URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindications Binding: NG-Imm Vaccine Contraindication VS (extensible) | |
| extension:contraindicated |
0..* | boolean | NG-Imm Immunization Contraindicated URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindicated | |
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |
| identifier |
0..1 | Identifier | Business identifier | |
| status |
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 IMMZ.D.DE4 Vaccine Local ValueSet (required) | |
| patient |
1..1 | Reference(NG-Imm Patient) | Who was immunized | |
| occurrence[x] |
1..1 | dateTime | Vaccine administration date | |
| manufacturer |
0..1 | Reference(NG-Imm Organization) | Manufacturer description and identity | |
| lotNumber |
1..1 | string | Vaccine batch number | |
| expirationDate |
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 |
C | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 |
| performer |
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-Imm Practitioner) | Information of reporting officer | |
| isSubpotent |
0..1 | boolean | Dose potency | |
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |
| Slices for extension |
0..* | 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 | |
| extension:nextDoseDate |
0..1 | date | NG-Imm Next Dose Date URL: https://nphcda.gov.ng/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 | |||
| Documentation for this format | ||||
| 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 IMMZ.D.DE4 Vaccine Local ValueSet | 📦0.9.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()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
Differential View
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Immunization |
0..* | Immunization | Immunization event information | |
| Slices for extension |
0..* | 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 | |
| extension:contraindications |
0..* | CodeableConcept | NG-Imm Vaccine Contraindications URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindications Binding: NG-Imm Vaccine Contraindication VS (extensible) | |
| extension:contraindicated |
0..* | boolean | NG-Imm Immunization Contraindicated URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindicated | |
| identifier |
0..1 | Identifier | Business identifier | |
| status |
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 IMMZ.D.DE4 Vaccine Local ValueSet (required) | |
| patient |
1..1 | Reference(NG-Imm Patient) | Who was immunized | |
| occurrence[x] |
1..1 | dateTime | Vaccine administration date | |
| manufacturer |
0..1 | Reference(NG-Imm Organization) | Manufacturer description and identity | |
| lotNumber |
1..1 | string | Vaccine batch number | |
| expirationDate |
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 |
1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered | |
| performer |
0..* | BackboneElement | Who performed event | |
| function |
0..1 | CodeableConcept | Designation of reporting officer Binding: ImmunizationFunctionCodes (extensible) | |
| actor |
1..1 | Reference(NG-Imm Practitioner) | Information of reporting officer | |
| reaction |
||||
| detail |
0..1 | Reference(NG-Imm ClientRegistUpdate-Observations) | Additional information on reaction | |
| protocolApplied |
0..* | BackboneElement | Protocol followed by the provider | |
| Slices for extension |
0..* | 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 | |
| extension:nextDoseDate |
0..1 | date | NG-Imm Next Dose Date URL: https://nphcda.gov.ng/ig/StructureDefinition/next-dose-date | |
| targetDisease |
0..* | CodeableConcept | Vaccine preventable disease being targeted Binding: ImmunizationTargetDiseaseCodes (example) | |
| Documentation for this format | ||||
| 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 IMMZ.D.DE4 Vaccine Local ValueSet | 📦0.9.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: | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:contraindications |
0..* | CodeableConcept | NG-Imm Vaccine Contraindications URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindications Binding: NG-Imm Vaccine Contraindication VS (extensible) | |||||
| extension:contraindicated |
0..* | boolean | NG-Imm Immunization Contraindicated URL: https://nphcda.gov.ng/ig/StructureDefinition/contraindicated | |||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||
| identifier |
0..1 | Identifier | Business identifier | |||||
| status |
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 IMMZ.D.DE4 Vaccine Local ValueSet (required) | |||||
| patient |
1..1 | Reference(NG-Imm 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-Imm Organization) | Manufacturer description and identity | |||||
| lotNumber |
1..1 | string | Vaccine batch number | |||||
| expirationDate |
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 |
C | 1..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 | ||||
| performer |
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-Imm 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-Imm ClientRegistUpdate-Observations) | Additional information on reaction | |||||
| reported |
0..1 | boolean | Indicates self-reported reaction | |||||
| protocolApplied |
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 Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
| extension:nextDoseDate |
0..1 | date | NG-Imm Next Dose Date URL: https://nphcda.gov.ng/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 | |||||||
| Documentation for this format | ||||||||
| 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()
|
| sqty-1 | error | Immunization.doseQuantity | The comparator is not used on a SimpleQuantity |
comparator.empty()
|
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