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

This is the continuous build for version 1.0.0. This version is based on the current content of https://github.com/WorldHealthOrganization/ddcc and changes regularly.

Resource Profile: DDCC Immunization Recommendation

Defining URL:http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCImmunizationRecommendation
Version:1.0.0
Name:DDCCImmunizationRecommendation
Title:DDCC Immunization Recommendation
Status:Active as of 2022-11-23 03:17:18+0000
Definition:

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

Publisher:WHO
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCImmunizationRecommendation

Formal Views of Profile Content

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

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 ImmunizationRecommendation.recommendation.vaccineCode.coding is sliced based on the values of exists:system, exists:code

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient S1..1Reference(DDCC Patient)Who this profile is for
... recommendation S1..1BackboneElementVaccine administration recommendations
.... vaccineCode S1..1CodeableConceptVaccine or vaccine group recommendation applies to
..... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine S1..1CodingCode defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system S1..1uriIdentity of the terminology system
....... code S1..1codeSymbol in syntax defined by the system
.... targetDisease 0..1CodeableConceptDisease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... forecastStatus 1..1CodeableConceptVaccine recommendation status
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: due
.... dateCriterion S1..1BackboneElementDates governing proposed immunization
..... code 1..1CodeableConceptType of date
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
..... value S1..1dateTimeRecommended date
.... supportingImmunization S1..1Reference(DDCC Immunization)Past immunizations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(DDCC Patient)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization)Who is responsible for protocol
... recommendation SΣC1..1BackboneElementVaccine administration recommendations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode SΣ1..1CodeableConceptVaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine SΣ1..1CodingCode defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.


Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: due
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion S1..1BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType 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
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value S1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization S1..1Reference(DDCC Immunization)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient Σ1..1Reference(DDCC Patient)Who this profile is for
... recommendation ΣC1..1BackboneElementVaccine administration recommendations
.... vaccineCode Σ1..1CodeableConceptVaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


..... coding:ddccVaccine Σ1..1CodingCode defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
...... system Σ1..1uriIdentity of the terminology system
...... code Σ1..1codeSymbol in syntax defined by the system
.... dateCriterion 1..1BackboneElementDates governing proposed immunization
..... value 1..1dateTimeRecommended date
.... supportingImmunization 1..1Reference(DDCC Immunization)Past immunizations supporting recommendation

doco Documentation for this format

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 ImmunizationRecommendation.recommendation.vaccineCode.coding is sliced based on the values of exists:system, exists:code

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... patient S1..1Reference(DDCC Patient)Who this profile is for
... recommendation S1..1BackboneElementVaccine administration recommendations
.... vaccineCode S1..1CodeableConceptVaccine or vaccine group recommendation applies to
..... Slices for coding 1..*CodingCode defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine S1..1CodingCode defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system S1..1uriIdentity of the terminology system
....... code S1..1codeSymbol in syntax defined by the system
.... targetDisease 0..1CodeableConceptDisease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... forecastStatus 1..1CodeableConceptVaccine recommendation status
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: due
.... dateCriterion S1..1BackboneElementDates governing proposed immunization
..... code 1..1CodeableConceptType of date
Required Pattern: At least the following
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
..... value S1..1dateTimeRecommended date
.... supportingImmunization S1..1Reference(DDCC Immunization)Past immunizations supporting recommendation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ImmunizationRecommendation 0..*ImmunizationRecommendationGuidance or advice relating to an immunization
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... patient SΣ1..1Reference(DDCC Patient)Who this profile is for
... date Σ1..1dateTimeDate recommendation(s) created
... authority 0..1Reference(Organization)Who is responsible for protocol
... recommendation SΣC1..1BackboneElementVaccine administration recommendations
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineCode SΣ1..1CodeableConceptVaccine or vaccine group recommendation applies to
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ1..*CodingCode defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine SΣ1..1CodingCode defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system SΣ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... targetDisease Σ0..1CodeableConceptDisease to be immunized against
Binding: WHO Disease or Agent Targeted (COVID-19) (example)
.... contraindicatedVaccineCode Σ0..*CodeableConceptVaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.


.... forecastStatus ?!Σ1..1CodeableConceptVaccine recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.


Required Pattern: At least the following
..... id0..1idUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/immunization-recommendation-status
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: due
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
.... forecastReason Σ0..*CodeableConceptVaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.


.... dateCriterion S1..1BackboneElementDates governing proposed immunization
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... code 1..1CodeableConceptType 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
...... id0..1idUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
....... id0..1idUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: 30980-7
....... display0..1stringRepresentation defined by the system
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text0..1stringPlain text representation of the concept
..... value S1..1dateTimeRecommended date
.... description 0..1stringProtocol details
.... series 0..1stringName of vaccination series
.... doseNumber[x] Σ0..1Recommended dose number within series
..... doseNumberPositiveIntpositiveInt
..... doseNumberStringstring
.... seriesDoses[x] 0..1Recommended number of doses for immunity
..... seriesDosesPositiveIntpositiveInt
..... seriesDosesStringstring
.... supportingImmunization S1..1Reference(DDCC Immunization)Past immunizations supporting recommendation
.... supportingPatientInformation 0..*Reference(Resource)Patient observations supporting recommendation

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ImmunizationRecommendation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ImmunizationRecommendation.recommendation.vaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.vaccineCode.coding:ddccVaccineexampleWHO_DDCC_Vaccines_COVID_19
ImmunizationRecommendation.recommendation.targetDiseaseexampleWHO_DDCC_Disease_Targeted_COVID_19
ImmunizationRecommendation.recommendation.contraindicatedVaccineCodeexampleVaccineAdministeredValueSet
ImmunizationRecommendation.recommendation.forecastStatusexamplePattern: due
ImmunizationRecommendation.recommendation.forecastReasonexampleImmunizationRecommendationReasonCodes
ImmunizationRecommendation.recommendation.dateCriterion.codeexamplePattern: LOINC code 30980-7

Constraints

IdGradePath(s)DetailsRequirements
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()