Nigeria Immunization FHIR IG
0.1.0 - ci-build Nigeria flag

Nigeria Immunization FHIR IG, published by intellisoftkenya.com. 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/IntelliSOFT-Consulting/Nigeria-Immunization-FHIR-IG/ and changes regularly. See the Directory of published versions

Resource Profile: Immunization Profile - NEIR

Official URL: http://nhin.example.ng/StructureDefinition/NEIRImmunization Version: 0.1.0
Draft as of 2025-08-11 Computable Name: NEIRImmunization

Nigerian Registry Profile for Immunization.

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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier Business identifier
... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: NEIR ValueSet for vaccine codes (required)
... patient SΣ 1..1 Reference(Patient Profile - NEIR) Who was immunized
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
.... reference SΣC 1..1 string Manufacturer ID
.... display SΣ 1..1 string Name of the Manufacturer
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 1..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
..... display SΣ 0..1 string Vaccinator Name
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Immunization.vaccineCoderequiredNEIRVaccineCodesVS(a valid code from IMMZ.Z CodeSystem for Vaccine Library)
http://nhin.example.ng/ValueSet/NEIRVaccineCodesVS
From this IG
Immunization.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization Immunization
... identifier S 0..* Identifier Business identifier
... status S 1..1 code completed | entered-in-error | not-done
... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
... patient S 1..1 Reference(Patient Profile - NEIR) Who was immunized
... occurrence[x] 1..1 dateTime Vaccine administration date
... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
.... reference S 1..1 string Manufacturer ID
.... display S 1..1 string Name of the Manufacturer
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
... performer S 1..* BackboneElement Who performed event
.... actor S 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
..... display S 0..1 string Vaccinator Name
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Immunization.vaccineCoderequiredNEIRVaccineCodesVS(a valid code from IMMZ.Z CodeSystem for Vaccine Library)
http://nhin.example.ng/ValueSet/NEIRVaccineCodesVS
From this IG
Immunization.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: NEIR ValueSet for vaccine codes (required)
... patient SΣ 1..1 Reference(Patient Profile - NEIR) 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 S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Manufacturer ID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 1..1 string Name of the Manufacturer
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 1..* 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 What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
.... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Vaccinator Name
... 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(Observation) 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
.... extension 0..* Extension Additional content defined by implementations
.... 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 S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... 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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Immunization.vaccineCoderequiredNEIRVaccineCodesVS(a valid code from IMMZ.Z CodeSystem for Vaccine Library)
http://nhin.example.ng/ValueSet/NEIRVaccineCodesVS
From this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Immunization.manufacturer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Immunization.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From the FHIR Standard
Immunization.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier Business identifier
... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: NEIR ValueSet for vaccine codes (required)
... patient SΣ 1..1 Reference(Patient Profile - NEIR) Who was immunized
... occurrence[x] Σ 1..1 dateTime Vaccine administration date
... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
.... reference SΣC 1..1 string Manufacturer ID
.... display SΣ 1..1 string Name of the Manufacturer
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 1..* BackboneElement Who performed event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
..... display SΣ 0..1 string Vaccinator Name
... isSubpotent ?!Σ 0..1 boolean Dose potency
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... doseNumber[x] 1..1 Dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Immunization.vaccineCoderequiredNEIRVaccineCodesVS(a valid code from IMMZ.Z CodeSystem for Vaccine Library)
http://nhin.example.ng/ValueSet/NEIRVaccineCodesVS
From this IG
Immunization.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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 Immunization
... identifier S 0..* Identifier Business identifier
... status S 1..1 code completed | entered-in-error | not-done
... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
... patient S 1..1 Reference(Patient Profile - NEIR) Who was immunized
... occurrence[x] 1..1 dateTime Vaccine administration date
... location S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
.... reference S 1..1 string Manufacturer ID
.... display S 1..1 string Name of the Manufacturer
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
... performer S 1..* BackboneElement Who performed event
.... actor S 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
..... display S 0..1 string Vaccinator Name
... protocolApplied S 0..* BackboneElement Protocol followed by the provider
.... targetDisease S 1..1 CodeableConcept Vaccine preventatable disease being targetted

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Immunization.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Immunization.vaccineCoderequiredNEIRVaccineCodesVS(a valid code from IMMZ.Z CodeSystem for Vaccine Library)
http://nhin.example.ng/ValueSet/NEIRVaccineCodesVS
From this IG
Immunization.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG

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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier S 0..* Identifier Business identifier
... status ?!SΣ 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
... statusReason 0..1 CodeableConcept Reason not done
Binding: NEIR ValueSet for Immunization Not Done (required)
... vaccineCode SΣ 1..1 CodeableConcept Vaccine Administered
Binding: NEIR ValueSet for vaccine codes (required)
... patient SΣ 1..1 Reference(Patient Profile - NEIR) 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 S 1..1 Reference(NEIRLocation Profile) Where Vaccination was administered
... manufacturer S 1..1 Reference(Organization) Vaccine manufacturer
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Manufacturer ID
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display SΣ 1..1 string Name of the Manufacturer
... lotNumber S 1..1 string Vaccine batch number
... expirationDate S 1..1 date Vaccine expiration date
... site S 1..1 CodeableConcept Body site vaccine was administered
Binding: IMMZ.D.DE21 ValueSet for Site Administered (required)
... route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
... doseQuantity S 1..1 SimpleQuantity Amount of vaccine administered
... performer SΣ 1..* 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 What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
.... actor SΣ 1..1 Reference(NEIRPractitioner Profile) Individual or organization who was performing
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display SΣ 0..1 string Vaccinator Name
... 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(Observation) 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
.... extension 0..* Extension Additional content defined by implementations
.... 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 S 1..1 CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
.... 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

PathConformanceValueSetURI
Immunization.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
http://hl7.org/fhir/ValueSet/immunization-status|4.0.1
From the FHIR Standard
Immunization.statusReasonrequiredNEIRImmunizationNotDoneReasonsVS(a valid code from NEIR CodeSystem for Immunization Not Done)
http://nhin.example.ng/ValueSet/NEIRImmunizationNotDoneReasonsVS
From this IG
Immunization.vaccineCoderequiredNEIRVaccineCodesVS(a valid code from IMMZ.Z CodeSystem for Vaccine Library)
http://nhin.example.ng/ValueSet/NEIRVaccineCodesVS
From this IG
Immunization.reportOriginexampleImmunizationOriginCodes
http://hl7.org/fhir/ValueSet/immunization-origin
From the FHIR Standard
Immunization.manufacturer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Immunization.siterequiredIMMZDSiteAdministered
http://nhin.example.ng/ValueSet/IMMZDSiteAdministered
From this IG
Immunization.routeexampleImmunizationRouteCodes
http://hl7.org/fhir/ValueSet/immunization-route
From the FHIR Standard
Immunization.performer.functionextensibleImmunizationFunctionCodes
http://hl7.org/fhir/ValueSet/immunization-function
From the FHIR Standard
Immunization.performer.actor.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
Immunization.reasonCodeexampleImmunizationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-reason
From the FHIR Standard
Immunization.subpotentReasonexampleImmunizationSubpotentReason
http://hl7.org/fhir/ValueSet/immunization-subpotent-reason
From the FHIR Standard
Immunization.programEligibilityexampleImmunizationProgramEligibility
http://hl7.org/fhir/ValueSet/immunization-program-eligibility
From the FHIR Standard
Immunization.fundingSourceexampleImmunizationFundingSource
http://hl7.org/fhir/ValueSet/immunization-funding-source
From the FHIR Standard
Immunization.protocolApplied.targetDiseaseexampleImmunizationTargetDiseaseCodes
http://hl7.org/fhir/ValueSet/immunization-target-disease
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf 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-4errorImmunizationIf 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-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()

This structure is derived from Immunization

 

Other representations of profile: CSV, Excel, Schematron