EU Imaging Report R5
1.0.0-ballot - ci-build 150

EU Imaging Report R5, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r5/ and changes regularly. See the Directory of published versions

Resource Profile: DocumentReference: Key Image - Mappings

Page standards status: Draft Maturity Level: 1

Mappings for the DocumentReferenceKeyImageEuImaging resource profile.

Mappings to Structures in this Implementation Guide

No Mappings Found

Mappings to other Structures

No Mappings Found

Other Mappings

NameWorkflow PatternFiveWs Pattern MappingFHIR CompositionRIM MappingXDS metadata equivalentCDA (R2)HL7 V2 Mappingdoco
DocumentReference
Event
infrastructure.documents
when describing a Composition
  • Entity
  • Role
  • or Act
  • Document[classCode="DOC" and moodCode="EVN"]
DocumentEntry
when describing a CDA
DocumentReference / id
DocumentReference / meta
DocumentReference / implicitRules
DocumentReference / language
DocumentReference / text
Act.text?
DocumentReference / contained
N/A
DocumentReference / extension
N/A
DocumentReference / modifierExtension
N/A
DocumentReference / Slices for identifier
Event.identifier
FiveWs.identifier
Composition.identifier
.id / .setId
  • DocumentEntry.entryUUID
  • DocumentEntry.uniqueId
ClinicalDocument/id
TXA-12
DocumentReference / Slices for identifier / identifier:seriesInstanceUid
Event.identifier
FiveWs.identifier
Composition.identifier
.id / .setId
  • DocumentEntry.entryUUID
  • DocumentEntry.uniqueId
ClinicalDocument/id
TXA-12
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / id
n/a
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / extension
n/a
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / use
Role.code or implied by context
N/A
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / type
Role.code or implied by context
CX.5
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / system
II.root or Role.id.root
CX.4 / EI-2-4
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / period
Role.effectiveTime or implied by context
CX.7 + CX.8
DocumentReference / Slices for identifier / identifier:seriesInstanceUid / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid
Event.identifier
FiveWs.identifier
Composition.identifier
.id / .setId
  • DocumentEntry.entryUUID
  • DocumentEntry.uniqueId
ClinicalDocument/id
TXA-12
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / id
n/a
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / extension
n/a
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / use
Role.code or implied by context
N/A
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / type
Role.code or implied by context
CX.5
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / system
II.root or Role.id.root
CX.4 / EI-2-4
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / period
Role.effectiveTime or implied by context
CX.7 + CX.8
DocumentReference / Slices for identifier / identifier:sopClassInstanceUid / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
DocumentReference / Slices for identifier / identifier:studyInstanceUid
Event.identifier
FiveWs.identifier
Composition.identifier
.id / .setId
  • DocumentEntry.entryUUID
  • DocumentEntry.uniqueId
ClinicalDocument/id
TXA-12
DocumentReference / Slices for identifier / identifier:studyInstanceUid / id
n/a
DocumentReference / Slices for identifier / identifier:studyInstanceUid / extension
n/a
DocumentReference / Slices for identifier / identifier:studyInstanceUid / use
Role.code or implied by context
N/A
DocumentReference / Slices for identifier / identifier:studyInstanceUid / type
Role.code or implied by context
CX.5
DocumentReference / Slices for identifier / identifier:studyInstanceUid / system
II.root or Role.id.root
CX.4 / EI-2-4
DocumentReference / Slices for identifier / identifier:studyInstanceUid / value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
DocumentReference / Slices for identifier / identifier:studyInstanceUid / period
Role.effectiveTime or implied by context
CX.7 + CX.8
DocumentReference / Slices for identifier / identifier:studyInstanceUid / assigner
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • CX.4 / (CX.4
  • CX.9
  • CX.10)
DocumentReference / version
FiveWs.version
Composition.version
DocumentReference / Slices for basedOn
.outboundRelationship[typeCode=FLFS].target
DocumentEntry.referenceIdList
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession
.outboundRelationship[typeCode=FLFS].target
DocumentEntry.referenceIdList
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession / id
n/a
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession / extension
n/a
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession / reference
N/A
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession / type
N/A
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession / identifier
.identifier
DocumentReference / Slices for basedOn / basedOn:ServiceRequestOrderEuImagingaccession / display
N/A
DocumentReference / status
Event.status
FiveWs.status
  • .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"
  • .completionCode="AU" && ./statusCode[isNormalDatatype()]="complete" and ./inboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]/source[subsumesCode("ActClass#CACT") and moodCode="EVN" and domainMember("ReviseDocument"
  • .completionCode=NI && ./statusCode[isNormalDatatype()]="obsolete"
DocumentEntry.availabilityStatus
TXA-19
DocumentReference / docStatus
FiveWs.status
Composition.status
.statusCode
TXA-17
DocumentReference / modality
FiveWs.class
DocumentReference / type
Event.code
FiveWs.what[x]
Composition.type
./code
DocumentEntry.typeCode
  • 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.
TXA-2
DocumentReference / Slices for category
FiveWs.what[x]
Composition.category
  • .outboundRelationship[typeCode="COMP].target[classCode="LIST"
  • moodCode="EVN"].code
DocumentEntry.classCode
  • 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
DocumentReference / Slices for category / category:imkeyimages
FiveWs.what[x]
Composition.category
  • .outboundRelationship[typeCode="COMP].target[classCode="LIST"
  • moodCode="EVN"].code
DocumentEntry.classCode
  • 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
DocumentReference / Slices for category / category:imkeyimages / id
n/a
DocumentReference / Slices for category / category:imkeyimages / extension
n/a
DocumentReference / Slices for category / category:imkeyimages / Slices for coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
DocumentReference / Slices for category / category:imkeyimages / Slices for coding
DocumentReference / Slices for category / category:imkeyimages / Slices for coding / coding:keyimagecode
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
DocumentReference / Slices for category / category:imkeyimages / text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
DocumentReference / subject
Event.subject
FiveWs.subject[x]
Composition.subject
.participation[typeCode="SBJ"].role[typeCode="PAT"]
DocumentEntry.patientId
ClinicalDocument/recordTarget/
PID-3 (No standard way to define a Practitioner or Group subject in HL7 V2 MDM message)
DocumentReference / context
Event.encounter
FiveWs.context
Composition.encounter
  • unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]
  • priorityNumber)/target[moodCode="EVN" and classCode=("ENC"
  • "PCPR") and isNormalAct])
DocumentReference / event
Composition.event.detail
.code
DocumentEntry.referenceIdList
DocumentReference / bodySite
.targetSiteCode
DocumentReference / facilityType
usually from a mapping to a local ValueSet
.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
DocumentEntry.healthcareFacilityTypeCode
usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
DocumentReference / practiceSetting
usually from a mapping to a local ValueSet
.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
DocumentEntry.practiceSettingCode
usually from a mapping to a local ValueSet
DocumentReference / period
Composition.event.period
.effectiveTime
  • DocumentEntry.serviceStartTime
  • DocumentEntry.serviceStopTime
ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
DocumentReference / date
Event.occurrence[x]
FiveWs.recorded
Composition.date
.availabilityTime[type="TS"]
DocumentReference / Slices for author
Event.performer.actor
Composition.author
.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
DocumentEntry.author
ClinicalDocument/author
TXA-9 (No standard way to indicate a Device in HL7 V2 MDM message)
DocumentReference / Slices for author / author:performer
Event.performer.actor
Composition.author
.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
DocumentEntry.author
ClinicalDocument/author
TXA-9 (No standard way to indicate a Device in HL7 V2 MDM message)
DocumentReference / attester
Event.performer.actor
Composition.attester
.participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
DocumentEntry.legalAuthenticator
.authenticator/.legalAuthenticator
DocumentReference / attester / id
n/a
DocumentReference / attester / extension
n/a
DocumentReference / attester / modifierExtension
N/A
DocumentReference / attester / mode
Composition.attester.mode
unique(./modeCode)
implied by .authenticator/.legalAuthenticator
DocumentReference / attester / time
Composition.attester.time
./time[type="TS" and isNormalDatatype()]
.authenticator.time
DocumentReference / attester / party
FiveWs.witness
Composition.attester.party
  • ./role[classCode="ASSIGNED" and isNormalRole]/player[determinerCode="INST" and classCode=("DEV"
  • "PSN") and isNormalEntity()] or ./role[classCode="ASSIGNED" and isNormalRole and not(player)]/scoper[determinerCode="INST" and classCode="ORG" and isNormalEntity()]
.authenticator.assignedEnttty
TXA-10
DocumentReference / custodian
Event.performer.actor
Composition.custodian
.participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
DocumentReference / relatesTo
Composition.relatesTo
.outboundRelationship
DocumentEntry Associations
DocumentReference / relatesTo / id
n/a
DocumentReference / relatesTo / extension
n/a
DocumentReference / relatesTo / modifierExtension
N/A
DocumentReference / relatesTo / code
Composition.relatesTo.type
.outboundRelationship.typeCode
DocumentEntry Associations type
ClinicalDocument/relatedDocument/typeCode
DocumentReference / relatesTo / target
Composition.relatesTo.resourceReference
  • .target[classCode="DOC"
  • moodCode="EVN"].id
DocumentEntry Associations reference
ClinicalDocument/relatedDocument/parentDocument
DocumentReference / description
.outboundRelationship[typeCode="SUBJ"].target.text
DocumentEntry.comments
TXA-25
DocumentReference / securityLabel
Bundle.meta.security
.confidentialityCode
DocumentEntry.confidentialityCode
ClinicalDocument/confidentialityCode/@code
TXA-18
DocumentReference / Slices for content
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:All Slices
DocumentReference / Slices for content / content:All Slices / id
n/a
DocumentReference / Slices for content / content:All Slices / extension
n/a
DocumentReference / Slices for content / content:All Slices / modifierExtension
N/A
DocumentReference / Slices for content / content:All Slices / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
DocumentReference / Slices for content / content:All Slices / profile
Composition.meta.profile
document.text
DocumentEntry.formatCode
derived from the IHE Profile or Implementation Guide templateID
DocumentReference / Slices for content / content:All Slices / profile / id
n/a
DocumentReference / Slices for content / content:All Slices / profile / extension
n/a
DocumentReference / Slices for content / content:All Slices / profile / modifierExtension
N/A
DocumentReference / Slices for content / content:All Slices / profile / value[x]
Composition.meta.profile
document.text
DocumentEntry.formatCode
derived from the IHE Profile or Implementation Guide templateID
DocumentReference / Slices for content / content:thumbnail
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:thumbnail / id
n/a
DocumentReference / Slices for content / content:thumbnail / Slices for extension
DocumentReference / Slices for content / content:thumbnail / Slices for extension
DocumentReference / Slices for content / content:thumbnail / Slices for extension / extension:thumbnail
DocumentReference / Slices for content / content:thumbnail / Slices for extension / extension:thumbnail / id
n/a
DocumentReference / Slices for content / content:thumbnail / Slices for extension / extension:thumbnail / extension
DocumentReference / Slices for content / content:thumbnail / Slices for extension / extension:thumbnail / url
N/A
DocumentReference / Slices for content / content:thumbnail / Slices for extension / extension:thumbnail / value[x]
N/A
DocumentReference / Slices for content / content:thumbnail / modifierExtension
N/A
DocumentReference / Slices for content / content:thumbnail / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
DocumentReference / Slices for content / content:thumbnail / profile
Composition.meta.profile
document.text
DocumentEntry.formatCode
derived from the IHE Profile or Implementation Guide templateID
DocumentReference / Slices for content / content:thumbnail / profile / id
n/a
DocumentReference / Slices for content / content:thumbnail / profile / extension
n/a
DocumentReference / Slices for content / content:thumbnail / profile / modifierExtension
N/A
DocumentReference / Slices for content / content:thumbnail / profile / value[x]
Composition.meta.profile
document.text
DocumentEntry.formatCode
derived from the IHE Profile or Implementation Guide templateID
DocumentReference / Slices for content / content:content
Bundle(Composition+*)
document.text
DocumentReference / Slices for content / content:content / id
n/a
DocumentReference / Slices for content / content:content / Slices for extension
DocumentReference / Slices for content / content:content / Slices for extension
DocumentReference / Slices for content / content:content / Slices for extension / extension:thumbnail
DocumentReference / Slices for content / content:content / Slices for extension / extension:thumbnail / id
n/a
DocumentReference / Slices for content / content:content / Slices for extension / extension:thumbnail / extension
DocumentReference / Slices for content / content:content / Slices for extension / extension:thumbnail / url
N/A
DocumentReference / Slices for content / content:content / Slices for extension / extension:thumbnail / value[x]
N/A
DocumentReference / Slices for content / content:content / modifierExtension
N/A
DocumentReference / Slices for content / content:content / attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
DocumentReference / Slices for content / content:content / attachment / id
n/a
DocumentReference / Slices for content / content:content / attachment / extension
n/a
DocumentReference / Slices for content / content:content / attachment / contentType
  • ./mediaType
  • ./charset
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
DocumentReference / Slices for content / content:content / attachment / language
./language
DocumentReference / Slices for content / content:content / attachment / data
./data
ED.5
DocumentReference / Slices for content / content:content / attachment / url
./reference/literal
RP.1+RP.2 - if they refer to a URL (see v2.6)
DocumentReference / Slices for content / content:content / attachment / size
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:content / attachment / hash
:ED/integrityCheckAlgorithm="SHA-1"]
DocumentReference / Slices for content / content:content / attachment / title
./title/data
DocumentReference / Slices for content / content:content / attachment / creation
N/A (needs data type R3 proposal)
DocumentReference / Slices for content / content:content / attachment / height
  • .outboundRelationship[typeCode="COMP].target[classCode="OBS"
  • moodCode="EVN"
  • code="<CODE>"].value
DocumentReference / Slices for content / content:content / attachment / width
  • .outboundRelationship[typeCode="COMP].target[classCode="OBS"
  • moodCode="EVN"
  • code="<CODE>"].value
DocumentReference / Slices for content / content:content / attachment / frames
  • .outboundRelationship[typeCode="COMP].target[classCode="OBS"
  • moodCode="EVN"
  • code="<CODE>"].value
DocumentReference / Slices for content / content:content / attachment / duration
  • .outboundRelationship[typeCode="COMP].target[classCode="OBS"
  • moodCode="EVN"
  • code="<CODE>"].value
DocumentReference / Slices for content / content:content / attachment / pages
DocumentReference / Slices for content / content:content / profile
Composition.meta.profile
document.text
DocumentEntry.formatCode
derived from the IHE Profile or Implementation Guide templateID
DocumentReference / Slices for content / content:content / profile / id
n/a
DocumentReference / Slices for content / content:content / profile / extension
n/a
DocumentReference / Slices for content / content:content / profile / modifierExtension
N/A
DocumentReference / Slices for content / content:content / profile / value[x]
Composition.meta.profile
document.text
DocumentEntry.formatCode
derived from the IHE Profile or Implementation Guide templateID

doco Documentation for this format