WHO Digital Documentation of COVID-19 Certificates (DDCC)
1.0.0 - CI Build
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/ and changes regularly. See the Directory of published versions
Official URL: http://smart.who.int/ddcc/StructureDefinition/DDCCDocumentReferenceQR | Version: 1.0.0 | |||
Draft as of 2024-10-17 | Computable Name: DDCCDocumentReferenceQR |
DDCC DocumentReference for QR codes including the QR image and the serialized content.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | DocumentReference | |||
type | S | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DDCC QR Type Codes (extensible) |
subject | 0..1 | Reference(DDCC Patient) | Who/what is the subject of the document | |
authenticator | S | 1..1 | Reference(DDCC Organization) | Who/what authenticated the document |
Slices for content | S | 2..* | BackboneElement | Document referenced Slice: Unordered, Closed by value:format |
content:All Slices | Content/Rules for all slices | |||
format | 0..1 | Coding | Format/content rules for the document Binding: DDCC QR Format Codes (extensible) | |
content:qrImage | S | 1..* | BackboneElement | Document referenced |
attachment | ||||
contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | 1..1 | Coding | Format/content rules for the document 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 |
attachment | ||||
contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | 1..1 | Coding | Format/content rules for the document 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 |
attachment | ||||
contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | 1..1 | Coding | Format/content rules for the document 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 | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.type | extensible | DDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet from this IG | |
DocumentReference.content.format | extensible | DDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DDCC QR Type Codes (extensible) |
subject | Σ | 0..1 | Reference(DDCC Patient) | Who/what is the subject of the document |
authenticator | S | 1..1 | Reference(DDCC Organization) | Who/what authenticated the document |
Slices for content | SΣ | 2..* | BackboneElement | Document referenced Slice: Unordered, Closed by value:format |
content:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DDCC QR Format Codes (extensible) |
content:qrImage | SΣ | 1..* | BackboneElement | Document referenced |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
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. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. 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 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
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. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. 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 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
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. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. 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 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | |
DocumentReference.type | extensible | DDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet from this IG | |
DocumentReference.content.format | extensible | DDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet from this IG | |
DocumentReference.content:qrImage.attachment.contentType | required | Mime 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.format | preferred | Pattern: imagehttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | |
DocumentReference.content:qrContent.attachment.contentType | required | Mime 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.format | preferred | Pattern: serializedhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | |
DocumentReference.content:qrPDF.attachment.contentType | required | Mime 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.format | preferred | Pattern: pdfhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 : 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-4 | error | DocumentReference | If 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
identifier | Σ | 0..* | Identifier | Other identifiers for the document | ||||
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DDCC QR Type Codes (extensible) | ||||
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
subject | Σ | 0..1 | Reference(DDCC Patient) | Who/what is the subject of the document | ||||
date | Σ | 0..1 | instant | When this document reference was created | ||||
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
authenticator | S | 1..1 | Reference(DDCC Organization) | Who/what authenticated the document | ||||
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | |||||
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
description | Σ | 0..1 | string | Human-readable description | ||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for content | SΣ | 2..* | BackboneElement | Document referenced Slice: Unordered, Closed by value:format | ||||
content:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DDCC QR Format Codes (extensible) | ||||
content:qrImage | SΣ | 1..* | BackboneElement | Document referenced | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
content:qrContent | SΣ | 1..1 | BackboneElement | Document referenced | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: serialized | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
content:qrPDF | SΣ | 0..1 | BackboneElement | Document referenced | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: pdf | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
context | Σ | 0..1 | BackboneElement | Clinical context of document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
encounter | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
period | Σ | 0..1 | Period | Time of service that is being documented | ||||
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
practiceSetting | 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). | |||||
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |||||
related | 0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.type | extensible | DDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet from this IG | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.format | extensible | DDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet from this IG | ||||
DocumentReference.content:qrImage.attachment.contentType | required | Mime 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.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.content:qrImage.format | preferred | Pattern: imagehttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.content:qrContent.attachment.contentType | required | Mime 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.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.content:qrContent.format | preferred | Pattern: serializedhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.content:qrPDF.attachment.contentType | required | Mime 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.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.content:qrPDF.format | preferred | Pattern: pdfhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 : 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-4 | error | DocumentReference | If 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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:
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | DocumentReference | |||
type | S | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DDCC QR Type Codes (extensible) |
subject | 0..1 | Reference(DDCC Patient) | Who/what is the subject of the document | |
authenticator | S | 1..1 | Reference(DDCC Organization) | Who/what authenticated the document |
Slices for content | S | 2..* | BackboneElement | Document referenced Slice: Unordered, Closed by value:format |
content:All Slices | Content/Rules for all slices | |||
format | 0..1 | Coding | Format/content rules for the document Binding: DDCC QR Format Codes (extensible) | |
content:qrImage | S | 1..* | BackboneElement | Document referenced |
attachment | ||||
contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | 1..1 | Coding | Format/content rules for the document 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 |
attachment | ||||
contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | 1..1 | Coding | Format/content rules for the document 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 |
attachment | ||||
contentType | S | 1..1 | code | Mime type of the content, with charset etc. |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | 1..1 | Coding | Format/content rules for the document 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 | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
DocumentReference.type | extensible | DDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet from this IG | |
DocumentReference.content.format | extensible | DDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. |
type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DDCC QR Type Codes (extensible) |
subject | Σ | 0..1 | Reference(DDCC Patient) | Who/what is the subject of the document |
authenticator | S | 1..1 | Reference(DDCC Organization) | Who/what authenticated the document |
Slices for content | SΣ | 2..* | BackboneElement | Document referenced Slice: Unordered, Closed by value:format |
content:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DDCC QR Format Codes (extensible) |
content:qrImage | SΣ | 1..* | BackboneElement | Document referenced |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
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. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. 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 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
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. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. 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 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | Σ | 1..1 | Attachment | Where to access the document |
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. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | Data inline, base64ed |
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. 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 | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | |
DocumentReference.type | extensible | DDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet from this IG | |
DocumentReference.content.format | extensible | DDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet from this IG | |
DocumentReference.content:qrImage.attachment.contentType | required | Mime 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.format | preferred | Pattern: imagehttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | |
DocumentReference.content:qrContent.attachment.contentType | required | Mime 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.format | preferred | Pattern: serializedhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | |
DocumentReference.content:qrPDF.attachment.contentType | required | Mime 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.format | preferred | Pattern: pdfhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 : 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-4 | error | DocumentReference | If 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
identifier | Σ | 0..* | Identifier | Other identifiers for the document | ||||
status | ?!Σ | 1..1 | code | current | superseded | entered-in-error Binding: DocumentReferenceStatus (required): The status of the document reference. | ||||
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
type | SΣ | 1..1 | CodeableConcept | Kind of document (LOINC if possible) Binding: DDCC QR Type Codes (extensible) | ||||
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
subject | Σ | 0..1 | Reference(DDCC Patient) | Who/what is the subject of the document | ||||
date | Σ | 0..1 | instant | When this document reference was created | ||||
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
authenticator | S | 1..1 | Reference(DDCC Organization) | Who/what authenticated the document | ||||
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | |||||
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
description | Σ | 0..1 | string | Human-readable description | ||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
Slices for content | SΣ | 2..* | BackboneElement | Document referenced Slice: Unordered, Closed by value:format | ||||
content:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DDCC QR Format Codes (extensible) | ||||
content:qrImage | SΣ | 1..* | BackboneElement | Document referenced | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: image | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
content:qrContent | SΣ | 1..1 | BackboneElement | Document referenced | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: serialized | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
content:qrPDF | SΣ | 0..1 | BackboneElement | Document referenced | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
attachment | Σ | 1..1 | Attachment | Where to access the document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
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. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | Data inline, base64ed | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 1..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://smart.who.int/ddcc/CodeSystem/DDCCQRFormatCodeSystem | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: pdf | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
context | Σ | 0..1 | BackboneElement | Clinical context of document | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
encounter | 0..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
period | Σ | 0..1 | Period | Time of service that is being documented | ||||
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
practiceSetting | 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). | |||||
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |||||
related | 0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
DocumentReference.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.status | required | DocumentReferenceStatushttp://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.docStatus | required | CompositionStatushttp://hl7.org/fhir/ValueSet/composition-status|4.0.1 from the FHIR Standard | ||||
DocumentReference.type | extensible | DDCCQRTypeValueSet (a valid code from DDCC QR Category Usage Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRTypeValueSet from this IG | ||||
DocumentReference.category | example | DocumentClassValueSethttp://hl7.org/fhir/ValueSet/document-classcodes from the FHIR Standard | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipTypehttp://hl7.org/fhir/ValueSet/document-relationship-type|4.0.1 from the FHIR Standard | ||||
DocumentReference.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
DocumentReference.content.format | extensible | DDCCQRFormatValueSet (a valid code from DDCC QR Format Codes)http://smart.who.int/ddcc/ValueSet/DDCCQRFormatValueSet from this IG | ||||
DocumentReference.content:qrImage.attachment.contentType | required | Mime 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.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.content:qrImage.format | preferred | Pattern: imagehttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.content:qrContent.attachment.contentType | required | Mime 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.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.content:qrContent.format | preferred | Pattern: serializedhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.content:qrPDF.attachment.contentType | required | Mime 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.attachment.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
DocumentReference.content:qrPDF.format | preferred | Pattern: pdfhttp://hl7.org/fhir/ValueSet/formatcodes from the FHIR Standard | ||||
DocumentReference.context.event | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSethttp://hl7.org/fhir/ValueSet/c80-facilitycodes from the FHIR Standard | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codes from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 : 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-4 | error | DocumentReference | If 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-5 | error | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
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:
Other representations of profile: CSV, Excel, Schematron