HL7 Europe Imaging Report R4
0.1.1-build - 150

HL7 Europe Imaging Report R4, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.1-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/imaging-r4/ 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 PatternFHIR CompositionRIM MappingCDA (R2)FiveWs Pattern MappingHL7 v2 MappingXDS metadata equivalentdoco
.. DocumentReference
Event
when describing a Composition
Document[classCode="DOC" and moodCode="EVN"]
when describing a CDA
... id
... meta
... implicitRules
... text
Act.text?
... contained
N/A
... Slices for extension
.... extension:basedOn
.... extension:basedOn/ServiceRequestOrderEuImagingaccession
..... id
n/a
..... extension
..... url
N/A
..... value[x]
N/A
...... id
n/a
...... extension
n/a
...... reference
N/A
...... type
N/A
...... identifier
.identifier
...... display
N/A
.... extension:modality
... modifierExtension
N/A
... masterIdentifier
Event.identifier
Composition.identifier
.id
ClinicalDocument/id
FiveWs.identifier
TXA-12
DocumentEntry.uniqueId
... Slices for identifier
Event.identifier
.id / .setId
FiveWs.identifier
TXA-16?
DocumentEntry.entryUUID
.... identifier:seriesInstanceUid
Event.identifier
.id / .setId
FiveWs.identifier
TXA-16?
DocumentEntry.entryUUID
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... 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)
.... identifier:sopClassInstanceUid
Event.identifier
.id / .setId
FiveWs.identifier
TXA-16?
DocumentEntry.entryUUID
..... id
n/a
..... extension
n/a
..... use
Role.code or implied by context
N/A
..... type
Role.code or implied by context
CX.5
..... system
II.root or Role.id.root
CX.4 / EI-2-4
..... value
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
CX.1 / EI.1
..... period
Role.effectiveTime or implied by context
CX.7 + CX.8
..... 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)
... status
Event.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"
FiveWs.status
TXA-19
DocumentEntry.availabilityStatus
... docStatus
Composition.status
.statusCode
FiveWs.status
TXA-17
... type
Event.code
Composition.type
./code
  • 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.
FiveWs.class
TXA-2
DocumentEntry.type
... Slices for category
Composition.class
  • .outboundRelationship[typeCode="COMP].target[classCode="LIST"
  • moodCode="EVN"].code
  • 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
FiveWs.class
DocumentEntry.class
.... category:imkeyimages
Composition.class
  • .outboundRelationship[typeCode="COMP].target[classCode="LIST"
  • moodCode="EVN"].code
  • 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
FiveWs.class
DocumentEntry.class
..... id
n/a
..... extension
n/a
..... Slices for coding
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
...... coding:keyimagecode
  • union(.
  • ./translation)
  • C*E.1-8
  • C*E.10-22
..... text
./originalText[mediaType/code="text/plain"]/data
C*E.9. But note many systems use C*E.2 for this
... subject
Event.subject
Composition.subject
.participation[typeCode="SBJ"].role[typeCode="PAT"]
ClinicalDocument/recordTarget/
FiveWs.subject
PID-3 (No standard way to define a Practitioner or Group subject in HL7 v2 MDM message)
DocumentEntry.patientId
... date
Event.occurrence[x]
Composition.date
.availabilityTime[type="TS"]
FiveWs.recorded
... Slices for author
Event.performer.actor
Composition.author
.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
ClinicalDocument/author
TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
DocumentEntry.author
.... author:performer
Event.performer.actor
Composition.author
.participation[typeCode="AUT"].role[classCode="ASSIGNED"]
ClinicalDocument/author
TXA-9 (No standard way to indicate a Device in HL7 v2 MDM message)
DocumentEntry.author
... authenticator
Event.performer.actor
Composition.attester
.participation[typeCode="AUTHEN"].role[classCode="ASSIGNED"]
ClinicalDocument/legalAuthenticator
FiveWs.witness
TXA-10
DocumentEntry.legalAuthenticator
... custodian
Event.performer.actor
Composition.custodian
.participation[typeCode="RCV"].role[classCode="CUST"].scoper[classCode="ORG" and determinerCode="INST"]
... relatesTo
Composition.relatesTo
.outboundRelationship
DocumentEntry Associations
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... code
Composition.relatesTo.code
.outboundRelationship.typeCode
DocumentEntry Associations type
.... target
Composition.relatesTo.target
  • .target[classCode="DOC"
  • moodCode="EVN"].id
DocumentEntry Associations reference
... description
.outboundRelationship[typeCode="SUBJ"].target.text
TXA-25
DocumentEntry.comments
... securityLabel
  • Composition.confidentiality
  • Composition.meta.security
.confidentialityCode
ClinicalDocument/confidentialityCode/@code
TXA-18
DocumentEntry.confidentialityCode
... Slices for content
Bundle(Composition+*)
document.text
.... content:All Slices
..... id
n/a
..... extension
n/a
..... modifierExtension
N/A
..... attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
..... format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
.... content:thumbnail
Bundle(Composition+*)
document.text
..... id
n/a
..... Slices for extension
...... extension:thumbnail
....... id
n/a
....... extension
....... url
N/A
....... value[x]
N/A
..... modifierExtension
N/A
..... attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
..... format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
.... content:content
Bundle(Composition+*)
document.text
..... id
n/a
..... Slices for extension
...... extension:thumbnail
....... id
n/a
....... extension
....... url
N/A
....... value[x]
N/A
..... modifierExtension
N/A
..... attachment
  • Composition.language
  • Composition.title
  • Composition.date
document.text
  • ClinicalDocument/languageCode
  • ClinicalDocument/title
  • ClinicalDocument/date
TXA-3 for mime type
  • DocumentEntry.mimeType
  • DocumentEntry.languageCode
  • DocumentEntry.URI
  • DocumentEntry.size
  • DocumentEntry.hash
  • DocumentEntry.title
  • DocumentEntry.creationTime
...... id
n/a
...... extension
n/a
...... contentType
  • ./mediaType
  • ./charset
ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used
...... language
./language
...... data
./data
ED.5
...... url
./reference/literal
RP.1+RP.2 - if they refer to a URL (see v2.6)
...... size
N/A (needs data type R3 proposal)
...... hash
:ED/integrityCheckAlgorithm="SHA-1"]
...... title
./title/data
...... creation
N/A (needs data type R3 proposal)
..... format
Composition.meta.profile
document.text
derived from the IHE Profile or Implementation Guide templateID
DocumentEntry.formatCode
... context
outboundRelationship[typeCode="SUBJ"].target[classCode<'ACT']
.... id
n/a
.... extension
n/a
.... modifierExtension
N/A
.... encounter
Event.context
Composition.encounter
  • unique(highest(./outboundRelationship[typeCode="SUBJ" and isNormalActRelationship()]
  • priorityNumber)/target[moodCode="EVN" and classCode=("ENC"
  • "PCPR") and isNormalAct])
FiveWs.context
.... event
Composition.event.code
.code
DocumentEntry.eventCodeList
.... period
Composition.event.period
.effectiveTime
ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/low/ @value --> ClinicalDocument/documentationOf/ serviceEvent/effectiveTime/high/ @value
  • DocumentEntry.serviceStartTime
  • DocumentEntry.serviceStopTime
.... facilityType
usually from a mapping to a local ValueSet
.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
usually a mapping to a local ValueSet. Must be consistent with /clinicalDocument/code
DocumentEntry.healthcareFacilityTypeCode
.... practiceSetting
usually from a mapping to a local ValueSet
.participation[typeCode="LOC"].role[classCode="DSDLOC"].code
usually from a mapping to a local ValueSet
DocumentEntry.practiceSettingCode
.... sourcePatientInfo
Composition.subject
.participation[typeCode="SBJ"].role[typeCode="PAT"]
ClinicalDocument/recordTarget/
  • DocumentEntry.sourcePatientInfo
  • DocumentEntry.sourcePatientId
.... related
Composition.event.detail
./outboundRelationship[typeCode="PERT" and isNormalActRelationship()] / target[isNormalAct]
ClinicalDocument/relatedDocument
DocumentEntry.referenceIdList

doco Documentation for this format