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/tree/main and changes regularly. See the Directory of published versions

Resource Profile: DDCC DocumentReference return for QR

Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCDocumentReferenceQR Version: 1.0.0
Draft as of 2025-03-10 Computable Name: DDCCDocumentReferenceQR

DDCC DocumentReference for QR codes including the QR image and the serialized content.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* DocumentReference A reference to a document
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... status ?!Σ 1..1 code current | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.


ele-1: All FHIR elements must have a @value or children
... subject Σ 0..1 Reference(DDCC Patient) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
... authenticator S 1..1 Reference(DDCC Organization) Who/what authenticated the document
ele-1: All FHIR elements must have a @value or children
... Slices for content SΣ 2..* BackboneElement Document referenced
Slice: Unordered, Closed by value:format
ele-1: All FHIR elements must have a @value or children
.... content:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
..... format Σ 0..1 Coding Format/content rules for the document
Binding: DDCC QR Format Codes (extensible)
ele-1: All FHIR elements must have a @value or children
.... content:qrImage SΣ 1..* BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
...... data S 1..1 base64Binary Data inline, base64ed
ele-1: All FHIR elements must have a @value or children
..... format Σ 1..1 Coding Format/content rules for the document
Binding: DDCC QR Format Codes (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: image
.... content:qrContent SΣ 1..1 BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
...... data S 1..1 base64Binary Data inline, base64ed
ele-1: All FHIR elements must have a @value or children
..... format Σ 1..1 Coding Format/content rules for the document
Binding: DDCC QR Format Codes (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: serialized
.... content:qrPDF SΣ 0..1 BackboneElement Document referenced
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... attachment Σ 1..1 Attachment Where to access the document
ele-1: All FHIR elements must have a @value or children
...... contentType SΣ 1..1 code Mime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


ele-1: All FHIR elements must have a @value or children
Example General: text/plain; charset=UTF-8, image/png
...... data S 1..1 base64Binary Data inline, base64ed
ele-1: All FHIR elements must have a @value or children
..... format Σ 1..1 Coding Format/content rules for the document
Binding: DDCC QR Format Codes (extensible)
ele-1: All FHIR elements must have a @value or children
Required Pattern: At least the following
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: pdf

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
DocumentReference.statusrequiredDocumentReferenceStatus
http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1
from the FHIR Standard
DocumentReference.typeextensibleDDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)
http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet
from this IG
DocumentReference.content.formatextensibleDDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)
http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet
from this IG
DocumentReference.content:qrImage.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content:qrImage.formatextensiblePattern: image
http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet
from this IG
DocumentReference.content:qrContent.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content:qrContent.formatextensiblePattern: serialized
http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet
from this IG
DocumentReference.content:qrPDF.attachment.contentTyperequiredMime Types (a valid code from urn:ietf:bcp:13)
http://hl7.org/fhir/ValueSet/mimetypes|4.0.1
from the FHIR Standard
DocumentReference.content:qrPDF.formatextensiblePattern: pdf
http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorDocumentReferenceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorDocumentReferenceIf 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-4errorDocumentReferenceIf 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-5errorDocumentReferenceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceDocumentReferenceA 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()

 

Other representations of profile: CSV, Excel, Schematron