Atrius India Core FHIR Implementation Guide
0.1.0 - ci-build

Atrius India Core FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Atrius India Core ImmunizationRecommendation

Official URL: https://atrius.in/fhir/r4/atrius-in/StructureDefinition/atrius-in-immunizationrecommendation Version: 0.1.0
Draft as of 2026-07-24 Computable Name: AtriusInImmunizationRecommendation
Other Identifiers: OID:1.3.6.1.4.1.66219.1.42.65

Atrius India Core profile. Parent: FHIR R4. Structurally aligned with QI-Core. India terminology via NDHM ValueSets where noted. Legacy QI-Core projection: runtime-mapper.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(4.0.1) 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
Constraints: ext-1
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who this profile is for
... authority 0..1 Reference(Atrius India Core Organization(0.1.0)) Who is responsible for protocol
... recommendation SΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastStatus ?!SΣ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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.).
...... coding SΣ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
..... value 1..1 dateTime Recommended date
.... doseNumber[x] SΣ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... supportingImmunization 0..* Reference(Atrius India Core Immunization(0.1.0) | Atrius India Core ImmunizationEvaluation(0.1.0)) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Atrius India Core AllergyIntolerance(0.1.0) | Atrius India Core Observation(0.1.0) | Atrius India Core Observation Body Measurement(0.1.0) | Atrius India Core Observation General Assessment(0.1.0) | Atrius India Core Observation Lifestyle(0.1.0) | Atrius India Core Observation Physical Activity(0.1.0) | Atrius India Core Observation Vital Signs(0.1.0) | Atrius India Core Observation Women Health(0.1.0)) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.text, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.targetDisease.coding, ImmunizationRecommendation.recommendation.targetDisease.text, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.coding, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.text, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastStatus.coding, ImmunizationRecommendation.recommendation.forecastStatus.text, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.forecastReason.coding, ImmunizationRecommendation.recommendation.forecastReason.text, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.code.coding, ImmunizationRecommendation.recommendation.dateCriterion.code.text, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.doseNumber[x], ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension 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()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(4.0.1) Guidance or advice relating to an immunization
... patient S 1..1 Reference(Atrius India Core Patient(0.1.0)) Who this profile is for
... date S 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Atrius India Core Organization(0.1.0)) Who is responsible for protocol
.... vaccineCode S 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... targetDisease
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... contraindicatedVaccineCode
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... forecastStatus S 1..1 CodeableConcept Vaccine recommendation status
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... forecastReason
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... dateCriterion
..... code
...... coding S 0..* Coding Code defined by a terminology system
...... text S 0..1 string Plain text representation of the concept
.... doseNumber[x] S 0..1 positiveInt, string Recommended dose number within series
.... supportingImmunization 0..* Reference(Atrius India Core Immunization(0.1.0) | Atrius India Core ImmunizationEvaluation(0.1.0)) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Atrius India Core AllergyIntolerance(0.1.0) | Atrius India Core Observation(0.1.0) | Atrius India Core Observation Body Measurement(0.1.0) | Atrius India Core Observation General Assessment(0.1.0) | Atrius India Core Observation Lifestyle(0.1.0) | Atrius India Core Observation Physical Activity(0.1.0) | Atrius India Core Observation Vital Signs(0.1.0) | Atrius India Core Observation Women Health(0.1.0)) Patient observations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(4.0.1) 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
... 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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who this profile is for
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Atrius India Core Organization(0.1.0)) Who is responsible for protocol
... recommendation SΣ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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastStatus ?!SΣ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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.).
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding SΣ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
..... value 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] SΣ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(Atrius India Core Immunization(0.1.0) | Atrius India Core ImmunizationEvaluation(0.1.0)) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Atrius India Core AllergyIntolerance(0.1.0) | Atrius India Core Observation(0.1.0) | Atrius India Core Observation Body Measurement(0.1.0) | Atrius India Core Observation General Assessment(0.1.0) | Atrius India Core Observation Lifestyle(0.1.0) | Atrius India Core Observation Physical Activity(0.1.0) | Atrius India Core Observation Vital Signs(0.1.0) | Atrius India Core Observation Women Health(0.1.0)) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 ImmunizationRecommendation.meta, ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.language, ImmunizationRecommendation.text, ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.text, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.targetDisease.extension, ImmunizationRecommendation.recommendation.targetDisease.coding, ImmunizationRecommendation.recommendation.targetDisease.text, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.extension, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.coding, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.text, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastStatus.extension, ImmunizationRecommendation.recommendation.forecastStatus.coding, ImmunizationRecommendation.recommendation.forecastStatus.text, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.forecastReason.extension, ImmunizationRecommendation.recommendation.forecastReason.coding, ImmunizationRecommendation.recommendation.forecastReason.text, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.code.extension, ImmunizationRecommendation.recommendation.dateCriterion.code.coding, ImmunizationRecommendation.recommendation.dateCriterion.code.text, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber[x], ImmunizationRecommendation.recommendation.seriesDoses[x], ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.targetDisease.extension, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.extension, ImmunizationRecommendation.recommendation.forecastStatus.extension, ImmunizationRecommendation.recommendation.forecastReason.extension, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code.extension 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()

Summary

Must-Support: 18 elements

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(4.0.1) 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
Constraints: ext-1
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who this profile is for
... authority 0..1 Reference(Atrius India Core Organization(0.1.0)) Who is responsible for protocol
... recommendation SΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastStatus ?!SΣ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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.).
...... coding SΣ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
..... value 1..1 dateTime Recommended date
.... doseNumber[x] SΣ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... supportingImmunization 0..* Reference(Atrius India Core Immunization(0.1.0) | Atrius India Core ImmunizationEvaluation(0.1.0)) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Atrius India Core AllergyIntolerance(0.1.0) | Atrius India Core Observation(0.1.0) | Atrius India Core Observation Body Measurement(0.1.0) | Atrius India Core Observation General Assessment(0.1.0) | Atrius India Core Observation Lifestyle(0.1.0) | Atrius India Core Observation Physical Activity(0.1.0) | Atrius India Core Observation Vital Signs(0.1.0) | Atrius India Core Observation Women Health(0.1.0)) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.text, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.targetDisease.coding, ImmunizationRecommendation.recommendation.targetDisease.text, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.coding, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.text, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastStatus.coding, ImmunizationRecommendation.recommendation.forecastStatus.text, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.forecastReason.coding, ImmunizationRecommendation.recommendation.forecastReason.text, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.code.coding, ImmunizationRecommendation.recommendation.dateCriterion.code.text, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.doseNumber[x], ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension 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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(4.0.1) Guidance or advice relating to an immunization
... patient S 1..1 Reference(Atrius India Core Patient(0.1.0)) Who this profile is for
... date S 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Atrius India Core Organization(0.1.0)) Who is responsible for protocol
.... vaccineCode S 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... targetDisease
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... contraindicatedVaccineCode
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... forecastStatus S 1..1 CodeableConcept Vaccine recommendation status
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... forecastReason
..... coding S 0..* Coding Code defined by a terminology system
..... text S 0..1 string Plain text representation of the concept
.... dateCriterion
..... code
...... coding S 0..* Coding Code defined by a terminology system
...... text S 0..1 string Plain text representation of the concept
.... doseNumber[x] S 0..1 positiveInt, string Recommended dose number within series
.... supportingImmunization 0..* Reference(Atrius India Core Immunization(0.1.0) | Atrius India Core ImmunizationEvaluation(0.1.0)) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Atrius India Core AllergyIntolerance(0.1.0) | Atrius India Core Observation(0.1.0) | Atrius India Core Observation Body Measurement(0.1.0) | Atrius India Core Observation General Assessment(0.1.0) | Atrius India Core Observation Lifestyle(0.1.0) | Atrius India Core Observation Physical Activity(0.1.0) | Atrius India Core Observation Vital Signs(0.1.0) | Atrius India Core Observation Women Health(0.1.0)) Patient observations supporting recommendation

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation(4.0.1) 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
... 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
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(Atrius India Core Patient(0.1.0)) Who this profile is for
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Atrius India Core Organization(0.1.0)) Who is responsible for protocol
... recommendation SΣ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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... vaccineCode SΣ 0..* CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: ImmunizationRecommendationTargetDiseaseCodes (example): The disease that the recommended vaccination targets.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastStatus ?!SΣ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... coding SΣ 0..* Coding Code defined by a terminology system
..... text SΣ 0..1 string Plain text representation of the concept
.... dateCriterion 0..* BackboneElement Dates governing proposed immunization
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... 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.).
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
...... coding SΣ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
..... value 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] SΣ 0..1 Recommended dose number within series
..... doseNumberPositiveInt positiveInt
..... doseNumberString string
.... seriesDoses[x] 0..1 Recommended number of doses for immunity
..... seriesDosesPositiveInt positiveInt
..... seriesDosesString string
.... supportingImmunization 0..* Reference(Atrius India Core Immunization(0.1.0) | Atrius India Core ImmunizationEvaluation(0.1.0)) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Atrius India Core AllergyIntolerance(0.1.0) | Atrius India Core Observation(0.1.0) | Atrius India Core Observation Body Measurement(0.1.0) | Atrius India Core Observation General Assessment(0.1.0) | Atrius India Core Observation Lifestyle(0.1.0) | Atrius India Core Observation Physical Activity(0.1.0) | Atrius India Core Observation Vital Signs(0.1.0) | Atrius India Core Observation Women Health(0.1.0)) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.targetDisease Base example Immunization Recommendation Target Disease Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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 ImmunizationRecommendation.meta, ImmunizationRecommendation.implicitRules, ImmunizationRecommendation.language, ImmunizationRecommendation.text, ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.identifier, ImmunizationRecommendation.patient, ImmunizationRecommendation.date, ImmunizationRecommendation.authority, ImmunizationRecommendation.recommendation, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.vaccineCode.coding, ImmunizationRecommendation.recommendation.vaccineCode.text, ImmunizationRecommendation.recommendation.targetDisease, ImmunizationRecommendation.recommendation.targetDisease.extension, ImmunizationRecommendation.recommendation.targetDisease.coding, ImmunizationRecommendation.recommendation.targetDisease.text, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.extension, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.coding, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.text, ImmunizationRecommendation.recommendation.forecastStatus, ImmunizationRecommendation.recommendation.forecastStatus.extension, ImmunizationRecommendation.recommendation.forecastStatus.coding, ImmunizationRecommendation.recommendation.forecastStatus.text, ImmunizationRecommendation.recommendation.forecastReason, ImmunizationRecommendation.recommendation.forecastReason.extension, ImmunizationRecommendation.recommendation.forecastReason.coding, ImmunizationRecommendation.recommendation.forecastReason.text, ImmunizationRecommendation.recommendation.dateCriterion, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code, ImmunizationRecommendation.recommendation.dateCriterion.code.extension, ImmunizationRecommendation.recommendation.dateCriterion.code.coding, ImmunizationRecommendation.recommendation.dateCriterion.code.text, ImmunizationRecommendation.recommendation.dateCriterion.value, ImmunizationRecommendation.recommendation.description, ImmunizationRecommendation.recommendation.series, ImmunizationRecommendation.recommendation.doseNumber[x], ImmunizationRecommendation.recommendation.seriesDoses[x], ImmunizationRecommendation.recommendation.supportingImmunization, ImmunizationRecommendation.recommendation.supportingPatientInformation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationRecommendation.extension, ImmunizationRecommendation.modifierExtension, ImmunizationRecommendation.recommendation.extension, ImmunizationRecommendation.recommendation.modifierExtension, ImmunizationRecommendation.recommendation.vaccineCode.extension, ImmunizationRecommendation.recommendation.targetDisease.extension, ImmunizationRecommendation.recommendation.contraindicatedVaccineCode.extension, ImmunizationRecommendation.recommendation.forecastStatus.extension, ImmunizationRecommendation.recommendation.forecastReason.extension, ImmunizationRecommendation.recommendation.dateCriterion.extension, ImmunizationRecommendation.recommendation.dateCriterion.modifierExtension, ImmunizationRecommendation.recommendation.dateCriterion.code.extension 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()

Summary

Must-Support: 18 elements

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel, Schematron