Mobile access to Health Documents (MHD)
4.2.2 - Trial-Implementation International flag

This page is part of the IHE Mobile Access to Health Documents (v4.2.2: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: ComprehensiveDocumentReference - Mappings

Active as of 2024-05-18

Mappings for the IHE.MHD.Comprehensive.DocumentReference resource profile.

Mappings for XDS and MHD Mapping (XDS)

ComprehensiveDocumentReference
DocumentReferenceXDS DocumentEntry: Used in the context of the IHE MHD ImplementationGuide
   meta
      profileDocumentEntry.limitedMetadata
   masterIdentifierDocumentEntry.uniqueId
   identifierDocumentEntry.entryUUID
   statusDocumentEntry.availabilityStatus
   typeDocumentEntry.typeCode
   categoryDocumentEntry.classCode
   subjectDocumentEntry.patientId
   authorDocumentEntry.author
   authenticatorDocumentEntry.legalAuthenticator
   custodiannot mapped
   relatesToDocumentEntry Associations
      codeDocumentEntry Associations.type
      targetDocumentEntry Associations.reference
   descriptionDocumentEntry.comments
   securityLabelDocumentEntry.confidentialityCode
   content
      attachment
         contentTypeDocumentEntry.mimeType
         languageDocumentEntry.languageCode
         urlDocumentEntry.repositoryUniqueId or DocuemntEntry.URI
         sizeDocumentEntry.size
         hashDocumentEntry.hash
         titleDocumentEntry.title
         creationDocumentEntry.creationTime
      formatDocumentEntry.formatCode
   context
      encounterDocumentEntry.referenceIdList with CXi encoding for urn:ihe:iti:xds:2015:encounterId
      eventDocumentEntry.eventCodeList
      period
         startDocumetEntry.serviceStartTime
         endDocumentEntry.serviceStopTime
      facilityTypeDocumentEntry.healthcareFacilityTypeCode
      practiceSettingDocumentEntry.practiceSettingCode
      sourcePatientInfo
         referenceDocumentEntry.sourcePatientInfo
         identifierDocumentEntry.sourcePatientId
      relatedDocumentEntry.referenceIdList using CXi encoding for type when possible

Mappings for Workflow Pattern (http://hl7.org/fhir/workflow)

ComprehensiveDocumentReference
DocumentReferenceEvent
   identifierEvent.identifier
   statusEvent.status
   typeEvent.code
   subjectEvent.subject
   dateEvent.occurrence[x]
   authorEvent.performer.actor
   authenticatorEvent.performer.actor
   custodianEvent.performer.actor
   context
      encounterEvent.context

Mappings for FHIR Composition (http://hl7.org/fhir/composition)

ComprehensiveDocumentReference
DocumentReferencewhen describing a Composition
   typeComposition.type
   categoryComposition.class
   subjectComposition.subject
   dateComposition.date
   authorComposition.author
   authenticatorComposition.attester
   custodianComposition.custodian
   relatesToComposition.relatesTo
      codeComposition.relatesTo.code
      targetComposition.relatesTo.target
   securityLabelComposition.confidentiality, Composition.meta.security
   contentBundle(Composition+*)
      attachmentComposition.language, Composition.title, Composition.date
      formatComposition.meta.profile
   context
      encounterComposition.encounter
      eventComposition.event.code
      periodComposition.event.period
      facilityTypeusually from a mapping to a local ValueSet
      practiceSettingusually from a mapping to a local ValueSet
      sourcePatientInfoComposition.subject
      relatedComposition.event.detail

Mappings for RIM Mapping (http://hl7.org/v3)

ComprehensiveDocumentReference
DocumentReferenceEntity. Role, or Act, Document[classCode="DOC" and moodCode="EVN"]
   meta
      idn/a
      extensionn/a
   textAct.text?
   containedN/A
   extensionN/A
   masterIdentifiern/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]
   statusinterim: .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"]
   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
      idn/a
      extensionn/a
      modifierExtensionN/A
      code.outboundRelationship.typeCode
      target.target[classCode="DOC", moodCode="EVN"].id
   description.outboundRelationship[typeCode="SUBJ"].target.text
   securityLabel.confidentialityCode
   contentdocument.text
      idn/a
      extensionn/a
      modifierExtensionN/A
      attachmentdocument.text
         idn/a
         extensionn/a
         contentType./mediaType, ./charset
         language./language
         url./reference/literal
         sizeN/A (needs data type R3 proposal)
         hash.integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]
         title./title/data
         creationN/A (needs data type R3 proposal)
      formatdocument.text
   contextoutboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
      idn/a
      extensionn/a
      modifierExtensionN/A
      encounterunique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()], priorityNumber)/target[moodCode="EVN" and classCode=("ENC", "PCPR") and isNormalAct])
      event.code
      period.effectiveTime
         idn/a
         extensionn/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"]
         idn/a
         extensionn/a
         referenceN/A
         typeN/A
         identifier.identifier
         displayN/A
      related./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]

Mappings for CDA (R2) (http://hl7.org/v3/cda)

ComprehensiveDocumentReference
DocumentReferencewhen describing a CDA
   typeClinicalDocument/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.
   categoryDerived 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
   subjectClinicalDocument/recordTarget/
   authorClinicalDocument/author
   authenticatorClinicalDocument/legalAuthenticator
   securityLabelClinicalDocument/confidentialityCode/@code
   content
      attachmentClinicalDocument/languageCode, ClinicalDocument/title, ClinicalDocument/date
      formatderived from the IHE Profile or Implementation Guide templateID
   context
      periodClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
      facilityTypeusually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
      practiceSettingusually from a mapping to a local ValueSet
      sourcePatientInfoClinicalDocument/recordTarget/
      relatedClinicalDocument/relatedDocument

Mappings for FiveWs Pattern Mapping (http://hl7.org/fhir/fivews)

ComprehensiveDocumentReference
DocumentReference
   identifierFiveWs.identifier
   statusFiveWs.status
   typeFiveWs.class
   categoryFiveWs.class
   subjectFiveWs.subject[x], FiveWs.subject
   dateFiveWs.recorded
   authenticatorFiveWs.witness
   context
      encounterFiveWs.context

Mappings for HL7 v2 Mapping (http://hl7.org/v2)

ComprehensiveDocumentReference
DocumentReference
   masterIdentifierCX / EI (occasionally, more often EI maps to a resource id or a URL)
   identifierTXA-16?
   identifier (entryUUID)CX / EI (occasionally, more often EI maps to a resource id or a URL)
   statusTXA-19
   typeTXA-2
   subjectPID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
   authorTXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
   authenticatorTXA-10
   descriptionTXA-25
   securityLabelTXA-18
   content
      attachmentTXA-3 for mime type
         contentTypeED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
         urlRP.1+RP.2 - if they refer to a URL (see v2.6)
   context
      period
         startDR.1
         endDR.2

Mappings for XDS metadata equivalent (http://ihe.net/xds)

ComprehensiveDocumentReference
DocumentReference
   identifierDocumentEntry.entryUUID
   statusDocumentEntry.availabilityStatus
   typeDocumentEntry.type
   categoryDocumentEntry.class
   subjectDocumentEntry.patientId
   authorDocumentEntry.author
   authenticatorDocumentEntry.legalAuthenticator
   relatesToDocumentEntry Associations
      codeDocumentEntry Associations type
      targetDocumentEntry Associations reference
   descriptionDocumentEntry.comments
   securityLabelDocumentEntry.confidentialityCode
   content
      attachmentDocumentEntry.mimeType, DocumentEntry.languageCode, DocumentEntry.URI, DocumentEntry.size, DocumentEntry.hash, DocumentEntry.title, DocumentEntry.creationTime
      formatDocumentEntry.formatCode
   context
      eventDocumentEntry.eventCodeList
      periodDocumentEntry.serviceStartTime, DocumentEntry.serviceStopTime
      facilityTypeDocumentEntry.healthcareFacilityTypeCode
      practiceSettingDocumentEntry.practiceSettingCode
      sourcePatientInfoDocumentEntry.sourcePatientInfo, DocumentEntry.sourcePatientId
      relatedDocumentEntry.referenceIdList