WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build International flag

WHO Digital Documentation of COVID-19 Certificates (DDCC), published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc/ and changes regularly. See the Directory of published versions

Resource Profile: DDCC Immunization Recommendation

Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCImmunizationRecommendation Version: 1.0.0
Draft as of 2024-10-17 Computable Name: DDCCImmunizationRecommendation

A DDCC Immunization Recommendation contains the content corresponding to when a patient should return for a booster shot.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... patient S 1..1 Reference(DDCC Patient) Who this profile is for
... recommendation S 1..1 BackboneElement Vaccine administration recommendations
.... vaccineCode S 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine S 1..1 Coding Code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system S 1..1 uri Identity of the terminology system
....... code S 1..1 code Symbol in syntax defined by the system
.... targetDisease 0..1 CodeableConcept Disease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... forecastStatus 1..1 CodeableConcept Vaccine recommendation status
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: due
.... dateCriterion S 1..1 BackboneElement Dates governing proposed immunization
..... code 1..1 CodeableConcept Type of date
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
..... value S 1..1 dateTime Recommended date
.... supportingImmunization S 1..1 Reference(DDCC Immunization) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHODDCCDiseaseTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... patient SΣ 1..1 Reference(DDCC Patient) Who this profile is for
... recommendation SΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode SΣ 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system SΣ 1..1 uri Identity of the terminology system
....... code SΣ 1..1 code Symbol in syntax defined by the system
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.


Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: due
.... dateCriterion S 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.).


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
..... value S 1..1 dateTime Recommended date
.... supportingImmunization S 1..1 Reference(DDCC Immunization) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHODDCCDiseaseTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19
from this IG
ImmunizationRecommendation.recommendation.forecastStatusexamplePattern: due
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexamplePattern: LOINC Code 30980-7
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(DDCC Patient) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Organization) Who is responsible for protocol
... recommendation SΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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 SΣ 1..1 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
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... contraindicatedVaccineCode Σ 0..* 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.


Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: due
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 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.


.... dateCriterion S 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.).


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value S 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 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 S 1..1 Reference(DDCC Immunization) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHODDCCDiseaseTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19
from this IG
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatusexamplePattern: due
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexamplePattern: LOINC Code 30980-7
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 7 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of ImmunizationRecommendation.recommendation.vaccineCode.coding

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... patient S 1..1 Reference(DDCC Patient) Who this profile is for
... recommendation S 1..1 BackboneElement Vaccine administration recommendations
.... vaccineCode S 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
..... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine S 1..1 Coding Code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system S 1..1 uri Identity of the terminology system
....... code S 1..1 code Symbol in syntax defined by the system
.... targetDisease 0..1 CodeableConcept Disease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... forecastStatus 1..1 CodeableConcept Vaccine recommendation status
Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: due
.... dateCriterion S 1..1 BackboneElement Dates governing proposed immunization
..... code 1..1 CodeableConcept Type of date
Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
..... value S 1..1 dateTime Recommended date
.... supportingImmunization S 1..1 Reference(DDCC Immunization) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHODDCCDiseaseTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... patient SΣ 1..1 Reference(DDCC Patient) Who this profile is for
... recommendation SΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode SΣ 1..1 CodeableConcept Vaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system SΣ 1..1 uri Identity of the terminology system
....... code SΣ 1..1 code Symbol in syntax defined by the system
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... forecastStatus ?!Σ 1..1 CodeableConcept Vaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.


Required Pattern: At least the following
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: due
.... dateCriterion S 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.).


Required Pattern: At least the following
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
..... value S 1..1 dateTime Recommended date
.... supportingImmunization S 1..1 Reference(DDCC Immunization) Past immunizations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHODDCCDiseaseTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19
from this IG
ImmunizationRecommendation.recommendation.forecastStatusexamplePattern: due
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexamplePattern: LOINC Code 30980-7
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(DDCC Patient) Who this profile is for
... date Σ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Organization) Who is responsible for protocol
... recommendation SΣC 1..1 BackboneElement Vaccine administration recommendations
imr-1: One of vaccineCode or targetDisease SHALL be present
.... 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 SΣ 1..1 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
..... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine SΣ 1..1 Coding Code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ 1..1 uri Identity of the terminology system
....... version Σ 0..1 string Version of the system - if relevant
....... code SΣ 1..1 code Symbol in syntax defined by the system
....... display Σ 0..1 string Representation defined by the system
....... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
.... targetDisease Σ 0..1 CodeableConcept Disease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... contraindicatedVaccineCode Σ 0..* 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.


Required Pattern: At least the following
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... version 0..1 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: due
...... display 0..1 string Representation defined by the system
...... userSelected 0..1 boolean If this coding was chosen directly by the user
..... text 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.


.... dateCriterion S 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.).


Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... coding 1..* Coding Code defined by a terminology system
Fixed Value: (complex)
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... system 1..1 uri Identity of the terminology system
Fixed Value: http://loinc.org
....... version 0..1 string Version of the system - if relevant
....... code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
....... display 0..1 string Representation defined by the system
....... userSelected 0..1 boolean If this coding was chosen directly by the user
...... text 0..1 string Plain text representation of the concept
..... value S 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... doseNumber[x] Σ 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 S 1..1 Reference(DDCC Immunization) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHODDCCVaccinesCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCVaccinesCOVID19
from this IG
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHODDCCDiseaseTargetedCOVID19
http://smart.who.int/ddcc/ValueSet/WHODDCCDiseaseTargetedCOVID19
from this IG
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
http://hl7.org/fhir/ValueSet/vaccine-code
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastStatusexamplePattern: due
http://hl7.org/fhir/ValueSet/immunization-recommendation-status
from the FHIR Standard
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
http://hl7.org/fhir/ValueSet/immunization-recommendation-reason
from the FHIR Standard
ImmunizationRecommendation.recommendation.dateCriterion.codeexamplePattern: LOINC Code 30980-7
http://hl7.org/fhir/ValueSet/immunization-recommendation-date-criterion
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationRecommendationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationRecommendationIf 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-4errorImmunizationRecommendationIf 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-5errorImmunizationRecommendationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationRecommendationA 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()
imr-1errorImmunizationRecommendation.recommendationOne of vaccineCode or targetDisease SHALL be present
: vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Mandatory: 7 elements
Must-Support: 9 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of ImmunizationRecommendation.recommendation.vaccineCode.coding

 

Other representations of profile: CSV, Excel, Schematron