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

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

A DDCC Immunization contains the content corresponding to a row in the Vaccination Events section of a Paper DDCC. While this is not a further profile of the International Patient Summary (IPS) Immunization resouce, this is intended to map into an IPS Immunization resource.

Publisher:WHO
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

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

Formal Views of Profile Content

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

This structure is derived from ImmunizationUvIps

This structure is derived from ImmunizationUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationUvIpsImmunization event information
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineBrand S1..1CodingDDCC Event Brand for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCEventBrand
... vaccineMarketAuthorization S0..1CodingDDCC Vaccine Market Authorization for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization
... validFrom S0..1dateDDCC Vaccine Valid From
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineValidFrom
... vaccineCode 1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
.... Slices for coding 1..*CodingIPSA reference to a code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
..... coding:ddccVaccine S1..1CodingIPSA reference to a code 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
... patient 1..1Reference(DDCC Patient)Who was immunized
... occurrence[x] 1..1dateTimeVaccine administration date
... location S1..1Reference(Location)Where immunization occurred
.... display S1..1stringText alternative for the resource
... manufacturer S0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringVaccine lot number
... performer
.... actor 1..1Reference(DDCC Practitioner | DDCC Organization)Individual or organization who was performing
... Slices for protocolApplied S1..*BackboneElementProtocol followed by the provider
Slice: Unordered, Open by type:authority
.... protocolApplied:protocolAppliedAuthority S1..*BackboneElementProtocol followed by the provider
..... authority 0..1Reference(DDCC Organization)Who is responsible for publishing the recommendations
..... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
..... doseNumber[x] S1..1positiveIntDose number within series
..... seriesDoses[x] 0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S0..*ImmunizationUvIpsImmunization event information
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineBrand S1..1CodingDDCC Event Brand for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCEventBrand
... vaccineMarketAuthorization S0..1CodingDDCC Vaccine Market Authorization for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization
... country S1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... validFrom S0..1dateDDCC Vaccine Valid From
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineValidFrom
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... Slices for vaccineCode SΣ1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding S1..*CodingIPSA reference to a code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine S1..1CodingIPSA reference to a code 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 SΣ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
........ id 0..1stringxml:id (or equivalent in JSON)
........ Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ translation S0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
........ value 0..1stringPrimitive value for string
Max Length: 1048576
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ0..1stringPlain text representation of the concept
.... vaccineCode:vaccineGPSCode SΣ0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass SΣ0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization SΣ0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... patient SΣ1..1Reference(DDCC Patient)Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1dateTimeVaccine administration date
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location S1..1Reference(Location)Where immunization occurred
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display SΣ1..1stringText alternative for the resource
... manufacturer S0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Target Site - IPS (preferred)
... route S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... 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
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor SΣ1..1Reference(DDCC Practitioner | DDCC Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... 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
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows 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
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... Slices for protocolApplied S1..*BackboneElementProtocol followed by the provider
Slice: Unordered, Open by type:authority
.... protocolApplied:All Slices Content/Rules for all slices
..... 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
..... series 0..1stringName of vaccine series
..... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
..... Slices for targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
...... targetDisease:targetDiseaseGPSCode S0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
..... doseNumber[x] 1..1Dose number within series
...... doseNumberPositiveIntpositiveInt
...... doseNumberStringstring
..... seriesDoses[x] 0..1Recommended number of doses for immunity
...... seriesDosesPositiveIntpositiveInt
...... seriesDosesStringstring
.... protocolApplied:protocolAppliedAuthority S1..*BackboneElementProtocol followed by the provider
..... 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
..... series 0..1stringName of vaccine series
..... authority 0..1Reference(DDCC Organization)Who is responsible for publishing the recommendations
..... Slices for targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
...... targetDisease:targetDiseaseGPSCode S0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
..... doseNumber[x] S1..1positiveIntDose number within series
..... seriesDoses[x] 0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationUvIpsImmunization event information
... vaccineBrand 1..1CodingDDCC Event Brand for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCEventBrand
... vaccineMarketAuthorization 0..1CodingDDCC Vaccine Market Authorization for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization
... country 1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... status ?!Σ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... Slices for vaccineCode Σ1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:All Slices Content/Rules for all slices
..... Slices for coding 1..*CodingIPSA reference to a code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine 1..1CodingIPSA reference to a code defined by a terminology system
Binding: WHO Vaccine List (COVID-19) (example)
....... system Σ1..1uriIdentity of the terminology system
....... version Σ0..1stringVersion of the system - if relevant
....... code Σ1..1codeSymbol in syntax defined by the system
....... display Σ0..1stringRepresentation defined by the system
........ Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ translation 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
..... text Σ0..1stringPlain text representation of the concept
.... vaccineCode:vaccineGPSCode Σ0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass Σ0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization Σ0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... patient Σ1..1Reference(DDCC Patient)Who was immunized
.... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
... occurrence[x] Σ1..1dateTimeVaccine administration date
.... data-absent-reason 0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... location 1..1Reference(Location)Where immunization occurred
.... display Σ1..1stringText alternative for the resource
... manufacturer 0..1Reference(Organization)Vaccine manufacturer
... lotNumber 0..1stringVaccine lot number
... site 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Target Site - IPS (preferred)
... route 0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... performer Σ0..*BackboneElementWho performed event
.... actor Σ1..1Reference(DDCC Practitioner | DDCC Organization)Individual or organization who was performing
... Slices for protocolApplied 1..*BackboneElementProtocol followed by the provider
Slice: Unordered, Open by type:authority
.... protocolApplied:All Slices Content/Rules for all slices
..... targetDisease:targetDiseaseGPSCode 0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
.... protocolApplied:protocolAppliedAuthority 1..*BackboneElementProtocol followed by the provider
..... targetDisease:targetDiseaseGPSCode 0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
..... doseNumber[x] 1..1positiveIntDose number within series

doco Documentation for this format

This structure is derived from ImmunizationUvIps

Differential View

This structure is derived from ImmunizationUvIps

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization 0..*ImmunizationUvIpsImmunization event information
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineBrand S1..1CodingDDCC Event Brand for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCEventBrand
... vaccineMarketAuthorization S0..1CodingDDCC Vaccine Market Authorization for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization
... validFrom S0..1dateDDCC Vaccine Valid From
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineValidFrom
... vaccineCode 1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
.... Slices for coding 1..*CodingIPSA reference to a code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
..... coding:ddccVaccine S1..1CodingIPSA reference to a code 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
... patient 1..1Reference(DDCC Patient)Who was immunized
... occurrence[x] 1..1dateTimeVaccine administration date
... location S1..1Reference(Location)Where immunization occurred
.... display S1..1stringText alternative for the resource
... manufacturer S0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringVaccine lot number
... performer
.... actor 1..1Reference(DDCC Practitioner | DDCC Organization)Individual or organization who was performing
... Slices for protocolApplied S1..*BackboneElementProtocol followed by the provider
Slice: Unordered, Open by type:authority
.... protocolApplied:protocolAppliedAuthority S1..*BackboneElementProtocol followed by the provider
..... authority 0..1Reference(DDCC Organization)Who is responsible for publishing the recommendations
..... targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
..... doseNumber[x] S1..1positiveIntDose number within series
..... seriesDoses[x] 0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization S0..*ImmunizationUvIpsImmunization event information
... 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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension 2..*ExtensionExtension
Slice: Unordered, Open by value:url
... vaccineBrand S1..1CodingDDCC Event Brand for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCEventBrand
... vaccineMarketAuthorization S0..1CodingDDCC Vaccine Market Authorization for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineMarketAuthorization
... country S1..1codeDDCC Country Of Event for Immunization
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCCountryOfEvent
Binding: Iso3166-1-3 (preferred)
... validFrom S0..1dateDDCC Vaccine Valid From
URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCVaccineValidFrom
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierBusiness identifier
... status ?!SΣ1..1codecompleted | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.

... statusReason 0..1CodeableConceptReason not done
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.

... Slices for vaccineCode SΣ1..1CodeableConceptIPSVaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Slice: Unordered, Open by pattern:$this
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised.

.... vaccineCode:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding S1..*CodingIPSA reference to a code defined by a terminology system
Slice: Unordered, Open by exists:system, exists:code
...... coding:ddccVaccine S1..1CodingIPSA reference to a code 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 SΣ0..1stringVersion of the system - if relevant
....... code SΣ1..1codeSymbol in syntax defined by the system
....... display SΣ0..1stringRepresentation defined by the system
........ id 0..1stringxml:id (or equivalent in JSON)
........ Slices for extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
........ translation S0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
........ value 0..1stringPrimitive value for string
Max Length: 1048576
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text SΣ0..1stringPlain text representation of the concept
.... vaccineCode:vaccineGPSCode SΣ0..1CodeableConceptCode for vaccine from the SNOMED CT GPS code set
Binding: Vaccines (GPS) - IPS (required)
.... vaccineCode:atcClass SΣ0..1CodeableConceptWHO ATC classification
Binding: WHO ATC - IPS (required)
.... vaccineCode:absentOrUnknownImmunization SΣ0..1CodeableConceptAbsent Unknown Immunization
Binding: Absent or Unknown Immunization - IPS (required)
... patient SΣ1..1Reference(DDCC Patient)Who was immunized
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ0..1stringText alternative for the resource
... encounter 0..1Reference(Encounter)Encounter immunization was part of
... occurrence[x] SΣ1..1dateTimeVaccine administration date
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... data-absent-reason S0..1codeoccurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required): Used to specify why the normally expected content of the data element is missing.


... recorded 0..1dateTimeWhen the immunization was first captured in the subject's record
... primarySource Σ0..1booleanIndicates context the data was recorded in
... reportOrigin 0..1CodeableConceptIndicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.

... location S1..1Reference(Location)Where immunization occurred
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display SΣ1..1stringText alternative for the resource
... manufacturer S0..1Reference(Organization)Vaccine manufacturer
... lotNumber S0..1stringVaccine lot number
... expirationDate 0..1dateVaccine expiration date
... site S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Target Site - IPS (preferred)
... route S0..1CodeableConceptIPSConcept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1SimpleQuantityAmount of vaccine administered
... performer SΣ0..*BackboneElementWho performed event
.... 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
.... function Σ0..1CodeableConceptWhat type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.

.... actor SΣ1..1Reference(DDCC Practitioner | DDCC Organization)Individual or organization who was performing
... note Σ0..*AnnotationAdditional immunization notes
... reasonCode 0..*CodeableConceptWhy immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.


... reasonReference 0..*Reference(Condition | Observation | DiagnosticReport)Why immunization occurred
... isSubpotent ?!Σ0..1booleanDose potency
... subpotentReason 0..*CodeableConceptReason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.


... education C0..*BackboneElementEducational material presented to patient
.... 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
.... documentType 0..1stringEducational material document identifier
.... reference 0..1uriEducational material reference pointer
.... publicationDate 0..1dateTimeEducational material publication date
.... presentationDate 0..1dateTimeEducational material presentation date
... programEligibility 0..*CodeableConceptPatient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.


... fundingSource 0..1CodeableConceptFunding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.

... reaction 0..*BackboneElementDetails of a reaction that follows 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
.... date 0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported 0..1booleanIndicates self-reported reaction
... Slices for protocolApplied S1..*BackboneElementProtocol followed by the provider
Slice: Unordered, Open by type:authority
.... protocolApplied:All Slices Content/Rules for all slices
..... 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
..... series 0..1stringName of vaccine series
..... authority 0..1Reference(Organization)Who is responsible for publishing the recommendations
..... Slices for targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: Vaccine Target Diseases - IPS (preferred)
...... targetDisease:targetDiseaseGPSCode S0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
..... doseNumber[x] 1..1Dose number within series
...... doseNumberPositiveIntpositiveInt
...... doseNumberStringstring
..... seriesDoses[x] 0..1Recommended number of doses for immunity
...... seriesDosesPositiveIntpositiveInt
...... seriesDosesStringstring
.... protocolApplied:protocolAppliedAuthority S1..*BackboneElementProtocol followed by the provider
..... 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
..... series 0..1stringName of vaccine series
..... authority 0..1Reference(DDCC Organization)Who is responsible for publishing the recommendations
..... Slices for targetDisease 0..*CodeableConceptVaccine preventatable disease being targetted
Slice: Unordered, Open by pattern:$this
Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
...... targetDisease:targetDiseaseGPSCode S0..1CodeableConceptCode for a disease the vaccination is against from the SNOMED CT GPS code set.
Binding: Vaccine Target Diseases (GPS) - IPS (required)
..... doseNumber[x] S1..1positiveIntDose number within series
..... seriesDoses[x] 0..1positiveIntRecommended number of doses for immunity

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Immunization.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Immunization.statusrequiredImmunizationStatusCodes
Immunization.statusReasonexampleImmunizationStatusReasonCodes
Immunization.vaccineCodepreferredVaccinesUvIps
Immunization.vaccineCode.coding:ddccVaccineexampleWHO_DDCC_Vaccines_COVID_19
Immunization.vaccineCode:vaccineGPSCoderequiredVaccinesGpsUvIps
Immunization.vaccineCode:atcClassrequiredWhoAtcUvIps
Immunization.vaccineCode:absentOrUnknownImmunizationrequiredNoImmunizationInfoUvIps
Immunization.patient.typeextensibleResourceType
Immunization.reportOriginexampleImmunizationOriginCodes
Immunization.location.typeextensibleResourceType
Immunization.sitepreferredTargetSiteCodeUvIps
Immunization.routepreferredRouteOfAdminUvIps
Immunization.performer.functionextensibleImmunizationFunctionCodes
Immunization.reasonCodeexampleImmunizationReasonCodes
Immunization.subpotentReasonexampleImmunizationSubpotentReason
Immunization.programEligibilityexampleImmunizationProgramEligibility
Immunization.fundingSourceexampleImmunizationFundingSource
Immunization.protocolApplied.targetDiseasepreferredTargetDiseasesUvIps
Immunization.protocolApplied.targetDisease:targetDiseaseGPSCoderequiredTargetDiseasesGpsUvIps
Immunization.protocolApplied:protocolAppliedAuthority.targetDiseasepreferredWHO_DDCC_Disease_Targeted_COVID_19
Immunization.protocolApplied:protocolAppliedAuthority.targetDisease:targetDiseaseGPSCoderequiredTargetDiseasesGpsUvIps

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorImmunizationIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorImmunizationIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorImmunizationIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceImmunizationA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
imm-1errorImmunization.educationOne of documentType or reference SHALL be present
: documentType.exists() or reference.exists()