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

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.

Logical Model: DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care

Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCCoreDataSet.VS.CoC Version: 1.0.0
Draft as of 2024-01-19 Computable Name: DDCCCoreDataSet_VS_CoC

Data elements for the DDCC Core Data Set - Vaccination Status - Continuity of Care.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from DDCCCoreDataSet_VS

NameFlagsCard.TypeDescription & Constraintsdoco
.. DDCCCoreDataSet 0..*DDCCCoreDataSet_VS
Elements defined in Ancestors: name, birthDate, identifier, certificate, vaccination
DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care
Instances of this logical model are not marked to be the target of a Reference
... vaccination
.... centre 1..1stringAdministering centre
... sex Σ0..1codeSex
Binding: AdministrativeGender (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DDCCCoreDataSet.sexrequiredAdministrativeGender
NameFlagsCard.TypeDescription & Constraintsdoco
.. DDCCCoreDataSet 0..*DDCCCoreDataSet_VS
Elements defined in Ancestors: name, birthDate, identifier, certificate, vaccination
DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care
Instances of this logical model are not marked to be the target of a Reference
... name Σ1..1stringName
... vaccination ΣC1..1BackboneElementVaccination Event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccine Σ1..1CodingVaccine or prophylaxis
Binding: WHO Vaccine List (COVID-19) (preferred)
.... brand Σ1..1CodingVaccine brand
.... lot Σ1..1stringVaccine lot number
.... date Σ1..1dateTimeDate of vaccination
.... dose Σ1..1positiveIntDose number
.... country Σ1..1CodingCountry of vaccination
Binding: Iso3166-1-3 (preferred)
.... centre 1..1stringAdministering centre
... sex Σ0..1codeSex
Binding: AdministrativeGender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DDCCCoreDataSet.vaccination.vaccinepreferredWHO_DDCC_Vaccines_COVID_19
DDCCCoreDataSet.vaccination.countrypreferredIso3166-1-3
DDCCCoreDataSet.sexrequiredAdministrativeGender

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()
who-ddcc-data-1errorDDCCCoreDataSet.vaccinationManufacturer or Market Authorization Holder SHALL be present
: manufacturer.exists() or maholder.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. DDCCCoreDataSet 0..*DDCCCoreDataSet_VS
Elements defined in Ancestors: name, birthDate, identifier, certificate, vaccination
DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care
Instances of this logical model are not marked to be the target of a Reference
... name Σ1..1stringName
... birthDate Σ0..1dateDate of birth
... identifier Σ0..1IdentifierUnique identifier
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... issuer Σ1..1Reference(DDCC Organization)Certificate issuer
.... kid 0..1stringKey ID used to verify the signature of the certificate
.... hcid Σ1..1IdentifierHealth certificate identifier (HCID)
.... ddccid Σ0..1IdentifierDDCC Identifier
.... version Σ1..1stringCertificate schema version
.... period C0..1PeriodCertificate Validity Period
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC0..1dateTimeCertificate valid from
..... end ΣC0..1dateTimeCertificate valid until
... vaccination ΣC1..1BackboneElementVaccination Event
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccine Σ1..1CodingVaccine or prophylaxis
Binding: WHO Vaccine List (COVID-19) (preferred)
.... brand Σ1..1CodingVaccine brand
.... manufacturer Σ0..1CodingVaccine manufacturer
.... maholder Σ0..1CodingVaccine market authorization holder
.... lot Σ1..1stringVaccine lot number
.... date Σ1..1dateTimeDate of vaccination
.... validFrom 0..1dateVaccination valid from
.... dose Σ1..1positiveIntDose number
.... totalDoses 0..1positiveIntTotal doses
.... country Σ1..1CodingCountry of vaccination
Binding: Iso3166-1-3 (preferred)
.... centre 1..1stringAdministering centre
.... signature 0..1SignatureSignature of health worker
.... practitioner 0..1IdentifierHealth worker identifier
.... disease 0..1CodingDisease or agent targeted
Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
.... nextDose 0..1dateDue date of next dose
... sex Σ0..1codeSex
Binding: AdministrativeGender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DDCCCoreDataSet.vaccination.vaccinepreferredWHO_DDCC_Vaccines_COVID_19
DDCCCoreDataSet.vaccination.countrypreferredIso3166-1-3
DDCCCoreDataSet.vaccination.diseasepreferredWHO_DDCC_Disease_Targeted_COVID_19
DDCCCoreDataSet.sexrequiredAdministrativeGender

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()
per-1errorDDCCCoreDataSet.certificate.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
who-ddcc-data-1errorDDCCCoreDataSet.vaccinationManufacturer or Market Authorization Holder SHALL be present
: manufacturer.exists() or maholder.exists()

This structure is derived from DDCCCoreDataSet_VS

Summary

Mandatory: 1 element

Differential View

This structure is derived from DDCCCoreDataSet_VS

NameFlagsCard.TypeDescription & Constraintsdoco
.. DDCCCoreDataSet 0..*DDCCCoreDataSet_VS
Elements defined in Ancestors: name, birthDate, identifier, certificate, vaccination
DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care
Instances of this logical model are not marked to be the target of a Reference
... vaccination
.... centre 1..1stringAdministering centre
... sex Σ0..1codeSex
Binding: AdministrativeGender (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
DDCCCoreDataSet.sexrequiredAdministrativeGender

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DDCCCoreDataSet 0..*DDCCCoreDataSet_VS
Elements defined in Ancestors: name, birthDate, identifier, certificate, vaccination
DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care
Instances of this logical model are not marked to be the target of a Reference
... name Σ1..1stringName
... vaccination ΣC1..1BackboneElementVaccination Event
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccine Σ1..1CodingVaccine or prophylaxis
Binding: WHO Vaccine List (COVID-19) (preferred)
.... brand Σ1..1CodingVaccine brand
.... lot Σ1..1stringVaccine lot number
.... date Σ1..1dateTimeDate of vaccination
.... dose Σ1..1positiveIntDose number
.... country Σ1..1CodingCountry of vaccination
Binding: Iso3166-1-3 (preferred)
.... centre 1..1stringAdministering centre
... sex Σ0..1codeSex
Binding: AdministrativeGender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DDCCCoreDataSet.vaccination.vaccinepreferredWHO_DDCC_Vaccines_COVID_19
DDCCCoreDataSet.vaccination.countrypreferredIso3166-1-3
DDCCCoreDataSet.sexrequiredAdministrativeGender

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()
who-ddcc-data-1errorDDCCCoreDataSet.vaccinationManufacturer or Market Authorization Holder SHALL be present
: manufacturer.exists() or maholder.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DDCCCoreDataSet 0..*DDCCCoreDataSet_VS
Elements defined in Ancestors: name, birthDate, identifier, certificate, vaccination
DDCC Core Data Set Logical Model - Vaccination Status - Continuity of Care
Instances of this logical model are not marked to be the target of a Reference
... name Σ1..1stringName
... birthDate Σ0..1dateDate of birth
... identifier Σ0..1IdentifierUnique identifier
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... issuer Σ1..1Reference(DDCC Organization)Certificate issuer
.... kid 0..1stringKey ID used to verify the signature of the certificate
.... hcid Σ1..1IdentifierHealth certificate identifier (HCID)
.... ddccid Σ0..1IdentifierDDCC Identifier
.... version Σ1..1stringCertificate schema version
.... period C0..1PeriodCertificate Validity Period
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... start ΣC0..1dateTimeCertificate valid from
..... end ΣC0..1dateTimeCertificate valid until
... vaccination ΣC1..1BackboneElementVaccination Event
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccine Σ1..1CodingVaccine or prophylaxis
Binding: WHO Vaccine List (COVID-19) (preferred)
.... brand Σ1..1CodingVaccine brand
.... manufacturer Σ0..1CodingVaccine manufacturer
.... maholder Σ0..1CodingVaccine market authorization holder
.... lot Σ1..1stringVaccine lot number
.... date Σ1..1dateTimeDate of vaccination
.... validFrom 0..1dateVaccination valid from
.... dose Σ1..1positiveIntDose number
.... totalDoses 0..1positiveIntTotal doses
.... country Σ1..1CodingCountry of vaccination
Binding: Iso3166-1-3 (preferred)
.... centre 1..1stringAdministering centre
.... signature 0..1SignatureSignature of health worker
.... practitioner 0..1IdentifierHealth worker identifier
.... disease 0..1CodingDisease or agent targeted
Binding: WHO Disease or Agent Targeted (COVID-19) (preferred)
.... nextDose 0..1dateDue date of next dose
... sex Σ0..1codeSex
Binding: AdministrativeGender (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
DDCCCoreDataSet.vaccination.vaccinepreferredWHO_DDCC_Vaccines_COVID_19
DDCCCoreDataSet.vaccination.countrypreferredIso3166-1-3
DDCCCoreDataSet.vaccination.diseasepreferredWHO_DDCC_Disease_Targeted_COVID_19
DDCCCoreDataSet.sexrequiredAdministrativeGender

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()
per-1errorDDCCCoreDataSet.certificate.periodIf present, start SHALL have a lower value than end
: start.hasValue().not() or end.hasValue().not() or (start <= end)
who-ddcc-data-1errorDDCCCoreDataSet.vaccinationManufacturer or Market Authorization Holder SHALL be present
: manufacturer.exists() or maholder.exists()

This structure is derived from DDCCCoreDataSet_VS

Summary

Mandatory: 1 element

 

Other representations of profile: CSV, Excel