STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

2.37.11.4.5 StructureDefinition: XDSDocumentReference - Mappings

Mappings:

RIM Mapping

W5 Mapping

HL7 v2 Mapping

XDS metadata equivalent

Mappings for the xdsdocumentreference Profile.

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

XDS profile for Document Reference
DocumentReferenceXDSDocumentReferenceEntity. Role, or Act
   id
   meta
   implicitRules
   language
   textAct.text?
   containedN/A
   extensionN/A
   modifierExtensionN/A
   masterIdentifier.id
   identifier.id / .setId
   subjectEntity. Role, or Act
   type./code
   class.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
   author.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
   authenticatorEntity. Role, or Act
   created.effectiveTime[type="TS"]
   indexed.availabilityTime[type="TS"]
   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"
   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
      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

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

XDS profile for Document Reference
DocumentReferenceXDSDocumentReferenceinfrastructure.documents
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   masterIdentifierid
   identifierid
   subjectadministrative.individual
   typeclass
   classclass
   authorwho.author
   authenticatoradministrative.individual
   createdwhen.done
   indexedwhen.recorded
   statusstatus
   relatesTo
      id
      extension
      modifierExtension
      code
      target
   description
   securityLabel
   content
      id
      extension
      modifierExtension
      attachment
         id
         extension
         contentType
         language
         data
         url
         size
         hash
         title
         creation
      format
   context
      id
      extension
      modifierExtension
      event
      period
      facilityType
      practiceSetting
      sourcePatientInfo
      related
         id
         extension
         modifierExtension
         identifier
         ref

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

XDS profile for Document Reference
DocumentReferenceXDSDocumentReference
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   masterIdentifierTXA-12
   identifierTXA-16?
   subject
   typeTXA-2
   class
   authorTXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
   authenticatorPRD (as one example)
   createdTXA-6
   indexed
   statusTXA-19
   relatesTo
      id
      extension
      modifierExtension
      code
      target
   descriptionTXA-25
   securityLabelTXA-18
   content
      id
      extension
      modifierExtension
      attachmentTXA-3 for mime type
         id
         extension
         contentTypeED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
         language
         dataED.5
         urlRP.1+RP.2 - if they refer to a URL (see v2.6)
         size
         hash
         title
         creation
      format
   context
      id
      extension
      modifierExtension
      event
      period
      facilityType
      practiceSetting
      sourcePatientInfo
      related
         id
         extension
         modifierExtension
         identifier
         ref

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

XDS profile for Document Reference
DocumentReferenceXDSDocumentReference
   id
   meta
   implicitRules
   language
   text
   contained
   extension
   modifierExtension
   masterIdentifierDocumentEntry.uniqueId
   identifierDocumentEntry.entryUUID
   subject
   typeDocumentEntry.type
   classDocumentEntry.class
   authorDocumentEntry.author
   authenticator
   createdDocumentEntry.submissionTime
   indexedDocumentEntry.submissionTime
   statusDocumentEntry status
   relatesTo
      id
      extension
      modifierExtension
      codeDocumentEntry Associations type
      targetDocumentEntry Associations reference
   descriptionDocumentEntry.description
   securityLabelDocumentEntry.confidentialityCode
   content
      id
      extension
      modifierExtension
      attachmentDocumentEntry.mimeType DocumentEntry.languageCode DocumentEntry.URI DocumentEntry.size DocumentEntry.hash DocumentEntry.title
         id
         extension
         contentType
         language
         data
         url
         size
         hash
         title
         creation
      formatDocumentEntry.formatCode
   context
      id
      extension
      modifierExtension
      eventDocumentEntry.eventCodeList
      periodDocumentEntry.serviceStartTime DocumentEntry.serviceStopTime
      facilityTypeDocumentEntry.healthcareFacilityTypeCode
      practiceSettingDocumentEntry.practiceSettingCode
      sourcePatientInfoDocumentEntry.sourcePatientInfo DocumentEntry.sourcePatientId
      relatedDocumentEntry.referenceIdList
         id
         extension
         modifierExtension
         identifier
         ref