US Core Implementation Guide (Release 1.1.0 Ballot )

This page is part of the US Core (v1.1.0: STU2 Ballot) based on FHIR (HL7® FHIR® Standard) R3. The current version which supersedes this version is 8.0.0. For a full list of available versions, see the Directory of published versions. Page versions: R8 R7 R6 R5 R4 R3

D.4.1.4 StructureDefinition: US Core DocumentReference Profile - Mappings

Mappings for the StructureDefinition-us-core-documentreference Profile.

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

US Core DocumentReference Profile
DocumentReferenceEntity. Role, or Act
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   masterIdentifier.id
   identifier.id / .setId
   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"
   docStatus.statusCode
   type./code
   class.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
   subject.participation[typeCode="SBJ"].role[typeCode="PAT"]
   created.effectiveTime[type="TS"]
   indexed.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
         data./data
         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
      facilityType.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
      practiceSetting.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
      sourcePatientInfo.participation[typeCode="SBJ"].role[typeCode="PAT"]
      related./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]
         idn/a
         extensionn/a
         modifierExtensionN/A
         identifier./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct] .id
         ref./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct].text.reference

Mappings for W5 Mapping (http://hl7.org/fhir/w5)

US Core DocumentReference Profile
DocumentReferenceinfrastructure.documents
   masterIdentifierid
   identifierid
   statusstatus
   docStatusstatus
   typeclass
   classclass
   subjectwho.focus
   createdwhen.done
   indexedwhen.recorded
   authorwho.author
   authenticatorwho.witness
   context
      encountercontext

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

US Core DocumentReference Profile
DocumentReference
   masterIdentifierTXA-12
   identifierTXA-16?
   statusTXA-19
   docStatusTXA-17
   typeTXA-2
   subjectPID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
   createdTXA-6
   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
         dataED.5
         urlRP.1+RP.2 - if they refer to a URL (see v2.6)

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

US Core DocumentReference Profile
DocumentReference
   masterIdentifierDocumentEntry.uniqueId
   identifierDocumentEntry.entryUUID
   statusDocumentEntry status
   typeDocumentEntry.type
   classDocumentEntry.class
   subjectDocumentEntry.patientId
   createdDocumentEntry.submissionTime
   indexedDocumentEntry.submissionTime
   authorDocumentEntry.author
   authenticatorDocumentEntry.legalAuthenticator
   relatesTo
      codeDocumentEntry Associations type
      targetDocumentEntry Associations reference
   descriptionDocumentEntry.description
   securityLabelDocumentEntry.confidentialityCode
   content
      attachmentDocumentEntry.mimeType DocumentEntry.languageCode DocumentEntry.URI DocumentEntry.size DocumentEntry.hash DocumentEntry.title
      formatDocumentEntry.formatCode
   context
      eventDocumentEntry.eventCodeList
      periodDocumentEntry.serviceStartTime DocumentEntry.serviceStopTime
      facilityTypeDocumentEntry.healthcareFacilityTypeCode
      practiceSettingDocumentEntry.practiceSettingCode
      sourcePatientInfoDocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId
      relatedDocumentEntry.referenceIdList