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.

Resource Profile: DDCC DocumentReference return for QR

Official URL: http://worldhealthorganization.github.io/ddcc/StructureDefinition/DDCCDocumentReferenceQR Version: 1.0.0
Active as of 2022-06-01 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.

This structure is derived from DocumentReference

Summary

Mandatory: 10 elements (3 nested mandatory elements)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element DocumentReference.content is sliced based on the value of value:format (Closed)

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... type S1..1CodeableConceptKind of document (LOINC if possible)
Binding: DDCC QR Type Codes (extensible)
... subject 0..1Reference(DDCC Patient)Who/what is the subject of the document
... authenticator S1..1Reference(DDCC Organization)Who/what authenticated the document
.... content:All Slices Content/Rules for all slices
..... format 0..1CodingFormat/content rules for the document
Binding: DDCC QR Format Codes (extensible)
.... content:qrImage S1..*BackboneElementDocument referenced
..... attachment
...... contentType S1..1codeMime type of the content, with charset etc.
...... data S1..1base64BinaryData inline, base64ed
..... format 1..1CodingFormat/content rules for the document
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: image
.... content:qrContent S1..1BackboneElementDocument referenced
..... attachment
...... contentType S1..1codeMime type of the content, with charset etc.
...... data S1..1base64BinaryData inline, base64ed
..... format 1..1CodingFormat/content rules for the document
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: serialized
.... content:qrPDF S0..1BackboneElementDocument referenced
..... attachment
...... contentType S1..1codeMime type of the content, with charset etc.
...... data S1..1base64BinaryData inline, base64ed
..... format 1..1CodingFormat/content rules for the document
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: pdf

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... id Σ0..1stringLogical 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
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier Σ0..*IdentifierOther identifiers for the document
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus Σ0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DDCC QR Type Codes (extensible)
... category Σ0..*CodeableConceptCategorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ0..1Reference(DDCC Patient)Who/what is the subject of the document
... date Σ0..1instantWhen this document reference was created
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator S1..1Reference(DDCC Organization)Who/what authenticated the document
... custodian 0..1Reference(Organization)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents
.... 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..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description Σ0..1stringHuman-readable description
... securityLabel Σ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... Slices for content SΣ2..*BackboneElementDocument referenced
Slice: Unordered, Closed by value:format
.... content: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
..... attachment Σ1..1AttachmentWhere to access the document
..... format Σ0..1CodingFormat/content rules for the document
Binding: DDCC QR Format Codes (extensible)
.... content:qrImage SΣ1..*BackboneElementDocument referenced
..... 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
..... attachment Σ1..1AttachmentWhere to access the document
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data S1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
..... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: image
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
.... content:qrContent SΣ1..1BackboneElementDocument referenced
..... 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
..... attachment Σ1..1AttachmentWhere to access the document
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data S1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
..... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: serialized
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
.... content:qrPDF SΣ0..1BackboneElementDocument referenced
..... 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
..... attachment Σ1..1AttachmentWhere to access the document
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data S1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
..... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: pdf
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
... context Σ0..1BackboneElementClinical context of document
.... 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
.... encounter 0..*Reference(Encounter | EpisodeOfCare)Context of the document content
.... event 0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodTime of service that is being documented
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting 0..1CodeableConceptAdditional 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).

.... sourcePatientInfo 0..1Reference(Patient)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... type Σ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DDCC QR Type Codes (extensible)
... authenticator 1..1Reference(DDCC Organization)Who/what authenticated the document
... Slices for content Σ2..*BackboneElementDocument referenced
Slice: Unordered, Closed by value:format
.... content:qrImage Σ1..*BackboneElementDocument referenced
..... attachment Σ1..1AttachmentWhere to access the document
...... contentType Σ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

...... data 1..1base64BinaryData inline, base64ed
.... content:qrContent Σ1..1BackboneElementDocument referenced
..... attachment Σ1..1AttachmentWhere to access the document
...... contentType Σ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

...... data 1..1base64BinaryData inline, base64ed
.... content:qrPDF Σ0..1BackboneElementDocument referenced
..... attachment Σ1..1AttachmentWhere to access the document
...... contentType Σ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.

...... data 1..1base64BinaryData inline, base64ed

doco Documentation for this format

This structure is derived from DocumentReference

Summary

Mandatory: 10 elements (3 nested mandatory elements)
Must-Support: 12 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element DocumentReference.content is sliced based on the value of value:format (Closed)

Differential View

This structure is derived from DocumentReference

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... type S1..1CodeableConceptKind of document (LOINC if possible)
Binding: DDCC QR Type Codes (extensible)
... subject 0..1Reference(DDCC Patient)Who/what is the subject of the document
... authenticator S1..1Reference(DDCC Organization)Who/what authenticated the document
.... content:All Slices Content/Rules for all slices
..... format 0..1CodingFormat/content rules for the document
Binding: DDCC QR Format Codes (extensible)
.... content:qrImage S1..*BackboneElementDocument referenced
..... attachment
...... contentType S1..1codeMime type of the content, with charset etc.
...... data S1..1base64BinaryData inline, base64ed
..... format 1..1CodingFormat/content rules for the document
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: image
.... content:qrContent S1..1BackboneElementDocument referenced
..... attachment
...... contentType S1..1codeMime type of the content, with charset etc.
...... data S1..1base64BinaryData inline, base64ed
..... format 1..1CodingFormat/content rules for the document
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: serialized
.... content:qrPDF S0..1BackboneElementDocument referenced
..... attachment
...... contentType S1..1codeMime type of the content, with charset etc.
...... data S1..1base64BinaryData inline, base64ed
..... format 1..1CodingFormat/content rules for the document
Required Pattern: At least the following
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: pdf

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentReference 0..*DocumentReferenceA reference to a document
... id Σ0..1stringLogical 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
... masterIdentifier Σ0..1IdentifierMaster Version Specific Identifier
... identifier Σ0..*IdentifierOther identifiers for the document
... status ?!Σ1..1codecurrent | superseded | entered-in-error
Binding: DocumentReferenceStatus (required): The status of the document reference.

... docStatus Σ0..1codepreliminary | final | amended | entered-in-error
Binding: CompositionStatus (required): Status of the underlying document.

... type SΣ1..1CodeableConceptKind of document (LOINC if possible)
Binding: DDCC QR Type Codes (extensible)
... category Σ0..*CodeableConceptCategorization of document
Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level.


... subject Σ0..1Reference(DDCC Patient)Who/what is the subject of the document
... date Σ0..1instantWhen this document reference was created
... author Σ0..*Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the document
... authenticator S1..1Reference(DDCC Organization)Who/what authenticated the document
... custodian 0..1Reference(Organization)Organization which maintains the document
... relatesTo Σ0..*BackboneElementRelationships to other documents
.... 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..1codereplaces | transforms | signs | appends
Binding: DocumentRelationshipType (required): The type of relationship between documents.

.... target Σ1..1Reference(DocumentReference)Target of the relationship
... description Σ0..1stringHuman-readable description
... securityLabel Σ0..*CodeableConceptDocument security-tags
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


... Slices for content SΣ2..*BackboneElementDocument referenced
Slice: Unordered, Closed by value:format
.... content: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
..... attachment Σ1..1AttachmentWhere to access the document
..... format Σ0..1CodingFormat/content rules for the document
Binding: DDCC QR Format Codes (extensible)
.... content:qrImage SΣ1..*BackboneElementDocument referenced
..... 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
..... attachment Σ1..1AttachmentWhere to access the document
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data S1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
..... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: image
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
.... content:qrContent SΣ1..1BackboneElementDocument referenced
..... 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
..... attachment Σ1..1AttachmentWhere to access the document
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data S1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
..... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: serialized
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
.... content:qrPDF SΣ0..1BackboneElementDocument referenced
..... 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
..... attachment Σ1..1AttachmentWhere to access the document
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... contentType SΣ1..1codeMime type of the content, with charset etc.
Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed.


Example General: text/plain; charset=UTF-8, image/png
...... language Σ0..1codeHuman language of the content (BCP-47)
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding

Example General: en-AU
...... data S1..1base64BinaryData inline, base64ed
...... url Σ0..1urlUri where the data can be found
Example General: http://www.acme.com/logo-small.png
...... size Σ0..1unsignedIntNumber of bytes of content (if url provided)
...... hash Σ0..1base64BinaryHash of the data (sha-1, base64ed)
...... title Σ0..1stringLabel to display in place of the data
Example General: Official Corporate Logo
...... creation Σ0..1dateTimeDate attachment was first created
..... format Σ1..1CodingFormat/content rules for the document
Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes.


Required Pattern: At least the following
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://worldhealthorganization.github.io/ddcc/CodeSystem/DDCC-QR-Format-CodeSystem
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: pdf
...... display0..1stringRepresentation defined by the system
...... userSelected0..1booleanIf this coding was chosen directly by the user
... context Σ0..1BackboneElementClinical context of document
.... 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
.... encounter 0..*Reference(Encounter | EpisodeOfCare)Context of the document content
.... event 0..*CodeableConceptMain clinical acts documented
Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented.


.... period Σ0..1PeriodTime of service that is being documented
.... facilityType 0..1CodeableConceptKind of facility where patient was seen
Binding: FacilityTypeCodeValueSet (example): XDS Facility Type.

.... practiceSetting 0..1CodeableConceptAdditional 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).

.... sourcePatientInfo 0..1Reference(Patient)Patient demographics from source
.... related 0..*Reference(Resource)Related identifiers or resources

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
DocumentReference.languagepreferredCommonLanguages
Max Binding: AllLanguages
DocumentReference.statusrequiredDocumentReferenceStatus
DocumentReference.docStatusrequiredCompositionStatus
DocumentReference.typeextensibleDDCC_QR_Type_ValueSet
DocumentReference.categoryexampleDocumentClassValueSet
DocumentReference.relatesTo.coderequiredDocumentRelationshipType
DocumentReference.securityLabelextensibleAll Security Labels
DocumentReference.content.formatextensibleDDCC_QR_Format_ValueSet
DocumentReference.content:qrImage.attachment.contentTyperequiredMime Types
DocumentReference.content:qrImage.attachment.languagepreferredCommonLanguages
Max Binding: AllLanguages
DocumentReference.content:qrImage.formatpreferredPattern: image
DocumentReference.content:qrContent.attachment.contentTyperequiredMime Types
DocumentReference.content:qrContent.attachment.languagepreferredCommonLanguages
Max Binding: AllLanguages
DocumentReference.content:qrContent.formatpreferredPattern: serialized
DocumentReference.content:qrPDF.attachment.contentTyperequiredMime Types
DocumentReference.content:qrPDF.attachment.languagepreferredCommonLanguages
Max Binding: AllLanguages
DocumentReference.content:qrPDF.formatpreferredPattern: pdf
DocumentReference.context.eventexampleActCode
DocumentReference.context.facilityTypeexampleFacilityTypeCodeValueSet
DocumentReference.context.practiceSettingexamplePracticeSettingCodeValueSet

Constraints

IdGradePathDetailsRequirements
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-1errorDocumentReference.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.masterIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.docStatusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.subjectAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.dateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.authorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.authenticatorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.custodianAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.relatesToAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.relatesTo.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.relatesTo.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.relatesTo.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.relatesTo.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.relatesTo.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.relatesTo.targetAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.descriptionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.securityLabelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.contentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content.attachmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content.formatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrImage.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrImage.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrImage.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrImage.attachmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrImage.attachment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrImage.attachment.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.attachment.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrImage.formatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrContent.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrContent.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrContent.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrContent.attachmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrContent.attachment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrContent.attachment.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.attachment.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrContent.formatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDFAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrPDF.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrPDF.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrPDF.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrPDF.attachmentAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.content:qrPDF.attachment.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.content:qrPDF.attachment.contentTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.urlAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.sizeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.hashAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.titleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.attachment.creationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.content:qrPDF.formatAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.contextAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.context.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.context.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorDocumentReference.context.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorDocumentReference.context.encounterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.eventAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.facilityTypeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.practiceSettingAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.sourcePatientInfoAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorDocumentReference.context.relatedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())