Nigeria Immunization FHIR IG
0.1.0 - ci-build
Nigeria Immunization FHIR IG
0.1.0 - ci-build
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
| Official URL: http://nhin.example.ng/StructureDefinition/NEIRImmunizationRecommendation | Version: 0.1.0 | |||
| Draft as of 2025-08-11 | Computable Name: NEIRImmunizationRecommendation | |||
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.
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:   |
|---|---|---|---|---|
  ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
SΣ | 1..1 | Identifier | Business identifier |
 patient |
Σ | 1..1 | Reference(Patient) | Who this profile is for |
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created |
| authority |
S | 0..1 | Reference(Organization) | Who is responsible for protocol |
 recommendation |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. |
| targetDisease |
Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets. |
| contraindicatedVaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. |
| forecastStatus |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
| forecastReason |
Σ | 1..1 | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. |
 dateCriterion |
1..1 | BackboneElement | Dates governing proposed immunization | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). | |
 value |
1..1 | dateTime | Recommended date | |
| description |
1..1 | string | Protocol details | |
| series |
1..1 | string | Name of vaccination series | |
 Slices for doseNumber[x] |
Σ | 1..1 | string | Recommended dose number within series Slice: Unordered, Closed by type:$this |
  doseNumber[x]:doseNumberString |
Σ | 1..1 | string | Recommended dose number within series |
| Slices for seriesDoses[x] |
1..1 | string | Recommended number of doses for immunity Slice: Unordered, Closed by type:$this | |
| seriesDoses[x]:seriesDosesString |
1..1 | string | Recommended number of doses for immunity | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.targetDisease | example | ImmunizationRecommendationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-target-diseaseFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reasonFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
 identifier |
S | 1..1 | Identifier | Business identifier |
| date |
S | 1..1 | dateTime | Date recommendation(s) created |
| authority |
S | 0..1 | Reference(Organization) | Who is responsible for protocol |
| recommendation |
||||
| vaccineCode |
1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to | |
| targetDisease |
1..1 | CodeableConcept | Disease to be immunized against | |
| contraindicatedVaccineCode |
1..1 | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation | |
| forecastReason |
1..1 | CodeableConcept | Vaccine administration status reason | |
| dateCriterion |
1..1 | BackboneElement | Dates governing proposed immunization | |
| description |
1..1 | string | Protocol details | |
| series |
1..1 | string | Name of vaccination series | |
| Slices for doseNumber[x] |
1..1 | string | Recommended dose number within series Slice: Unordered, Open by type:$this | |
| doseNumber[x]:doseNumberString |
1..1 | string | Recommended dose number within series | |
| Slices for seriesDoses[x] |
1..1 | string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |
| seriesDoses[x]:seriesDosesString |
1..1 | string | Recommended number of doses for immunity | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..1 | Identifier | Business identifier | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who this profile is for | ||||
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created | ||||
| authority |
S | 0..1 | Reference(Organization) | Who is responsible for protocol | ||||
| recommendation |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-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 | ||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
| targetDisease |
Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets. | ||||
| contraindicatedVaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
| forecastStatus |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
| forecastReason |
Σ | 1..1 | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
| dateCriterion |
1..1 | BackboneElement | Dates governing proposed 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 | ||||
| code |
1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). | |||||
| value |
1..1 | dateTime | Recommended date | |||||
| description |
1..1 | string | Protocol details | |||||
| series |
1..1 | string | Name of vaccination series | |||||
| Slices for doseNumber[x] |
Σ | 1..1 | string | Recommended dose number within series Slice: Unordered, Closed by type:$this | ||||
| doseNumber[x]:doseNumberString |
Σ | 1..1 | string | Recommended dose number within series | ||||
| Slices for seriesDoses[x] |
1..1 | string | Recommended number of doses for immunity Slice: Unordered, Closed by type:$this | |||||
| seriesDoses[x]:seriesDosesString |
1..1 | string | Recommended number of doses for immunity | |||||
| supportingImmunization |
0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
| supportingPatientInformation |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ImmunizationRecommendation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.targetDisease | example | ImmunizationRecommendationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-target-diseaseFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reasonFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
This structure is derived from ImmunizationRecommendation
Summary
Mandatory: 12 elements
Must-Support: 3 elements
Slices
This structure defines the following Slices:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
SΣ | 1..1 | Identifier | Business identifier |
| patient |
Σ | 1..1 | Reference(Patient) | Who this profile is for |
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created |
| authority |
S | 0..1 | Reference(Organization) | Who is responsible for protocol |
| recommendation |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. |
| targetDisease |
Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets. |
| contraindicatedVaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. |
| forecastStatus |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
| forecastReason |
Σ | 1..1 | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. |
| dateCriterion |
1..1 | BackboneElement | Dates governing proposed immunization | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| code |
1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). | |
| value |
1..1 | dateTime | Recommended date | |
| description |
1..1 | string | Protocol details | |
| series |
1..1 | string | Name of vaccination series | |
| Slices for doseNumber[x] |
Σ | 1..1 | string | Recommended dose number within series Slice: Unordered, Closed by type:$this |
| doseNumber[x]:doseNumberString |
Σ | 1..1 | string | Recommended dose number within series |
| Slices for seriesDoses[x] |
1..1 | string | Recommended number of doses for immunity Slice: Unordered, Closed by type:$this | |
| seriesDoses[x]:seriesDosesString |
1..1 | string | Recommended number of doses for immunity | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.targetDisease | example | ImmunizationRecommendationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-target-diseaseFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reasonFrom the FHIR Standard | |
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
Differential View
This structure is derived from ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
| identifier |
S | 1..1 | Identifier | Business identifier |
| date |
S | 1..1 | dateTime | Date recommendation(s) created |
| authority |
S | 0..1 | Reference(Organization) | Who is responsible for protocol |
| recommendation |
||||
| vaccineCode |
1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to | |
| targetDisease |
1..1 | CodeableConcept | Disease to be immunized against | |
| contraindicatedVaccineCode |
1..1 | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation | |
| forecastReason |
1..1 | CodeableConcept | Vaccine administration status reason | |
| dateCriterion |
1..1 | BackboneElement | Dates governing proposed immunization | |
| description |
1..1 | string | Protocol details | |
| series |
1..1 | string | Name of vaccination series | |
| Slices for doseNumber[x] |
1..1 | string | Recommended dose number within series Slice: Unordered, Open by type:$this | |
| doseNumber[x]:doseNumberString |
1..1 | string | Recommended dose number within series | |
| Slices for seriesDoses[x] |
1..1 | string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |
| seriesDoses[x]:seriesDosesString |
1..1 | string | Recommended number of doses for immunity | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| ImmunizationRecommendation |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 1..1 | Identifier | Business identifier | ||||
| patient |
Σ | 1..1 | Reference(Patient) | Who this profile is for | ||||
| date |
SΣ | 1..1 | dateTime | Date recommendation(s) created | ||||
| authority |
S | 0..1 | Reference(Organization) | Who is responsible for protocol | ||||
| recommendation |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-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 | ||||
| vaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine or vaccine group recommendation applies to Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
| targetDisease |
Σ | 1..1 | CodeableConcept | Disease to be immunized against Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets. | ||||
| contraindicatedVaccineCode |
Σ | 1..1 | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
| forecastStatus |
?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
| forecastReason |
Σ | 1..1 | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
| dateCriterion |
1..1 | BackboneElement | Dates governing proposed 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 | ||||
| code |
1..1 | CodeableConcept | Type of date Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.). | |||||
| value |
1..1 | dateTime | Recommended date | |||||
| description |
1..1 | string | Protocol details | |||||
| series |
1..1 | string | Name of vaccination series | |||||
| Slices for doseNumber[x] |
Σ | 1..1 | string | Recommended dose number within series Slice: Unordered, Closed by type:$this | ||||
| doseNumber[x]:doseNumberString |
Σ | 1..1 | string | Recommended dose number within series | ||||
| Slices for seriesDoses[x] |
1..1 | string | Recommended number of doses for immunity Slice: Unordered, Closed by type:$this | |||||
| seriesDoses[x]:seriesDosesString |
1..1 | string | Recommended number of doses for immunity | |||||
| supportingImmunization |
0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
| supportingPatientInformation |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| ImmunizationRecommendation.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard
| ||||
| ImmunizationRecommendation.recommendation.vaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.targetDisease | example | ImmunizationRecommendationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-target-diseaseFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | example | VaccineAdministeredValueSethttp://hl7.org/fhir/ValueSet/vaccine-codeFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastStatus | example | ImmunizationRecommendationStatusCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-statusFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.forecastReason | example | ImmunizationRecommendationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-reasonFrom the FHIR Standard | ||||
| ImmunizationRecommendation.recommendation.dateCriterion.code | example | ImmunizationRecommendationDateCriterionCodeshttp://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterionFrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | ImmunizationRecommendation | 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 | ImmunizationRecommendation | 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 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | ImmunizationRecommendation | 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() | |
| imr-1 | error | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() |
This structure is derived from ImmunizationRecommendation
Summary
Mandatory: 12 elements
Must-Support: 3 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron