This page is part of the WHO Digital Documentation of COVID-19 Certificates (DDCC) (v1.0.0: releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Mappings for the DDCCDocumentReference resource profile.
| DDCCDocumentReference |
| DocumentReference | XDS DocumentEntry: Used in the context of the IHE MHD ImplementationGuide |
| meta | |
| profile | DocumentEntry.limitedMetadata |
| masterIdentifier | DocumentEntry.uniqueId |
| identifier | DocumentEntry.entryUUID |
| status | DocumentEntry.availabilityStatus |
| type | DocumentEntry.typeCode |
| category | DocumentEntry.classCode |
| subject | DocumentEntry.patientId |
| author | DocumentEntry.author |
| authenticator | DocumentEntry.legalAuthenticator |
| custodian | not mapped |
| relatesTo | DocumentEntry Associations |
| code | DocumentEntry Associations.type |
| target | DocumentEntry Associations.reference |
| description | DocumentEntry.comments |
| securityLabel | DocumentEntry.confidentialityCode |
| content | |
| attachment | |
| contentType | DocumentEntry.mimeType |
| language | DocumentEntry.languageCode |
| url | DocumentEntry.repositoryUniqueId or DocuemntEntry.URI |
| size | DocumentEntry.size |
| hash | DocumentEntry.hash |
| title | DocumentEntry.title |
| creation | DocumentEntry.creationTime |
| format | DocumentEntry.formatCode |
| context | |
| encounter | DocumentEntry.referenceIdList with CXi encoding for urn:ihe:iti:xds:2015:encounterId |
| event | DocumentEntry.eventCodeList |
| period | |
| start | DocumetEntry.serviceStartTime |
| end | DocumentEntry.serviceStopTime |
| facilityType | DocumentEntry.healthcareFacilityTypeCode |
| practiceSetting | DocumentEntry.practiceSettingCode |
| sourcePatientInfo | |
| reference | DocumentEntry.sourcePatientInfo |
| identifier | DocumentEntry.sourcePatientId |
| related | DocumentEntry.referenceIdList using CXi encoding for type when possible |
| DDCCDocumentReference |
| DocumentReference | Entity. Role, or Act, Document[classCode="DOC" and moodCode="EVN"] |
| meta | |
| id | n/a |
| extension | n/a |
| text | Act.text? |
| contained | N/A |
| extension | N/A |
| masterIdentifier | n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] |
| identifier | .id / .setId |
| identifier (entryUUID) | n/a, II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT] |
| status | interim: .completionCode="IN" & ./statusCode[isNormalDatatype()]="active"; final: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and not(./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct()]); amended: .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument", code) and isNormalAct() and statusCode="completed"]; withdrawn : .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete" |
| type | ./code |
| category | .outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code |
| subject | .participation[typeCode="SBJ"].role[typeCode="PAT"] |
| id | n/a |
| extension | n/a |
| reference | N/A |
| type | N/A |
| identifier | .identifier |
| display | N/A |
| date | .availabilityTime[type="TS"] |
| author | .participation[typeCode="AUT"].role[classCode="ASSIGNED"] |
| authenticator | .participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"] |
| custodian | .participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"] |
| relatesTo | .outboundRelationship |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| code | .outboundRelationship.typeCode |
| target | .target[classCode="DOC", moodCode="EVN"].id |
| description | .outboundRelationship[typeCode="SUBJ"].target.text |
| securityLabel | .confidentialityCode |
| content | document.text |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| attachment | document.text |
| id | n/a |
| extension | n/a |
| contentType | ./mediaType, ./charset |
| language | ./language |
| url | ./reference/literal |
| size | N/A (needs data type R3 proposal) |
| hash | .integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"] |
| title | ./title/data |
| creation | N/A (needs data type R3 proposal) |
| format | document.text |
| context | outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT'] |
| id | n/a |
| extension | n/a |
| modifierExtension | N/A |
| encounter | unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct]) |
| event | .code |
| period | .effectiveTime |
| id | n/a |
| extension | n/a |
| start | ./low |
| end | ./high |
| facilityType | .participation[typeCode="LOC"].role[classCode="DSDLOC"].code |
| practiceSetting | .participation[typeCode="LOC"].role[classCode="DSDLOC"].code |
| sourcePatientInfo | .participation[typeCode="SBJ"].role[typeCode="PAT"] |
| id | n/a |
| extension | n/a |
| reference | N/A |
| type | N/A |
| identifier | .identifier |
| display | N/A |
| related | ./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] |
| DDCCDocumentReference |
| DocumentReference | when describing a CDA |
| type | ClinicalDocument/code/@code
The typeCode should be mapped from the ClinicalDocument/code element to a set of document type codes configured in the affinity domain. One suggested coding system to use for typeCode is LOINC, in which case the mapping step can be omitted. |
| category | Derived from a mapping of /ClinicalDocument/code/@code to an Affinity Domain specified coded value to use and coding system. Affinity Domains are encouraged to use the appropriate value for Type of Service, based on the LOINC Type of Service (see Page 53 of the LOINC User's Manual). Must be consistent with /ClinicalDocument/code/@code |
| subject | ClinicalDocument/recordTarget/ |
| author | ClinicalDocument/author |
| authenticator | ClinicalDocument/legalAuthenticator |
| securityLabel | ClinicalDocument/confidentialityCode/@code |
| content | |
| attachment | ClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date |
| format | derived from the IHE Profile or Implementation Guide templateID |
| context | |
| period | ClinicalDocument/documentationOf/
serviceEvent/effectiveTime/low/
@value --> ClinicalDocument/documentationOf/
serviceEvent/effectiveTime/high/
@value |
| facilityType | usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code |
| practiceSetting | usually from a mapping to a local ValueSet |
| sourcePatientInfo | ClinicalDocument/recordTarget/ |
| related | ClinicalDocument/relatedDocument |
| DDCCDocumentReference |
| DocumentReference | |
| identifier | DocumentEntry.entryUUID |
| status | DocumentEntry.availabilityStatus |
| type | DocumentEntry.type |
| category | DocumentEntry.class |
| subject | DocumentEntry.patientId |
| author | DocumentEntry.author |
| authenticator | DocumentEntry.legalAuthenticator |
| relatesTo | DocumentEntry Associations |
| code | DocumentEntry Associations type |
| target | DocumentEntry Associations reference |
| description | DocumentEntry.comments |
| securityLabel | DocumentEntry.confidentialityCode |
| content | |
| attachment | DocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime |
| format | DocumentEntry.formatCode |
| context | |
| event | DocumentEntry.eventCodeList |
| period | DocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime |
| facilityType | DocumentEntry.healthcareFacilityTypeCode |
| practiceSetting | DocumentEntry.practiceSettingCode |
| sourcePatientInfo | DocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId |
| related | DocumentEntry.referenceIdList |
