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 Document Reference

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

A DDCC Document Reference is a document reference to a DDCC Document containing the DDCC. The content attachment url will point to a DDCC Document.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..* MinimalDocumentReference 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
... masterIdentifier 1..1 UniqueIdIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
... Slices for identifier SΣ 0..* Identifier Other identifiers for the document
Slice: Unordered, Open by value:use
ele-1: All FHIR elements must have a @value or children
.... identifier:entryUUID 0..* EntryUUIDIdentifier An identifier intended for computation
ele-1: All FHIR elements must have a @value or children
... type SΣ 0..1 CodeableConcept Kind of document (LOINC if possible)
Binding: DocumentTypeValueSet (preferred): Precise type of clinical document.


ele-1: All FHIR elements must have a @value or children
... category SΣ 0..1 CodeableConcept Categorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


ele-1: All FHIR elements must have a @value or children
... subject SΣ 1..1 Reference(DDCC Patient) Who/what is the subject of the document
ele-1: All FHIR elements must have a @value or children
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
ele-1: All FHIR elements must have a @value or children
... date SΣ 1..1 instant When this document reference was created
ele-1: All FHIR elements must have a @value or children
... author SΣ 0..* Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) Who and/or what authored the document
ele-1: All FHIR elements must have a @value or children
... relatesTo SΣ 0..* BackboneElement Relationships to other documents
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
.... code Σ 1..1 code replaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.


ele-1: All FHIR elements must have a @value or children
.... target Σ 1..1 Reference(DocumentReference) Target of the relationship
ele-1: All FHIR elements must have a @value or children
... securityLabel SΣ 0..* CodeableConcept Document security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


ele-1: All FHIR elements must have a @value or children
... content 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 Σ 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
..... language SΣ 0..1 code Human language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding

ele-1: All FHIR elements must have a @value or children
Example General: en-AU
..... url SΣ 1..1 url Uri where the data can be found
ele-1: All FHIR elements must have a @value or children
Example General: http://www.acme.com/logo-small.png
..... hash SΣ 0..1 base64Binary Hash of the data (sha-1, base64ed)
ele-1: All FHIR elements must have a @value or children
..... creation SΣ 0..1 dateTime Date attachment was first created
ele-1: All FHIR elements must have a @value or children
.... format SΣ 0..1 Coding Format/content rules for the document
Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred)
ele-1: All FHIR elements must have a @value or children
... context Σ 0..1 BackboneElement Clinical context of document
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
.... period SΣ 0..1 Period Time of service that is being documented
ele-1: All FHIR elements must have a @value or children
.... facilityType S 0..1 CodeableConcept Kind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.


ele-1: All FHIR elements must have a @value or children
.... practiceSetting S 0..1 CodeableConcept Additional details about where the content was created (e.g. clinical specialty)
Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty).


ele-1: All FHIR elements must have a @value or children
.... sourcePatientInfo S 0..1 Reference(Patient) Patient demographics from source
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
DocumentReference.statusrequiredDocumentReferenceStats
https://profiles.ihe.net/ITI/MHD/ValueSet/DocumentReferenceStats
DocumentReference.typepreferredDocumentTypeValueSet
http://hl7.org/fhir/ValueSet/c80-doc-typecodes
from the FHIR Standard
DocumentReference.categoryexampleDocumentClassValueSet
http://hl7.org/fhir/ValueSet/document-classcodes
from the FHIR Standard
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
http://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1
from the FHIR Standard
DocumentReference.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard
DocumentReference.content.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.attachment.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
DocumentReference.content.formatpreferredIHE_FormatCode_vs
http://ihe.net/fhir/ihe.formatcode.fhir/ValueSet/formatcode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
http://hl7.org/fhir/ValueSet/c80-facilitycodes
from the FHIR Standard
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet
http://hl7.org/fhir/ValueSet/c80-practice-codes
from the FHIR Standard

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