FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Treatment - Mappings

Draft as of 2024-03-21

Mappings for the treatment resource profile.

Mappings for OSIRIS pivot files (Treatment)

Treatment
CarePlan	Treatment	Mapping from FHIR-osiris Treatment to osiris Treatment
extension
extension (treatment-line)
value[x] (valueInteger)	OSIRIS_pivot_Treatment.Treatment_LineNumber
category	OSIRIS_pivot_Treatment.Treatment_Type
subject	OSIRIS_pivot_Treatment.Patient_Id
period
start	OSIRIS_pivot_Treatment.Treatment_StartDate
end	OSIRIS_pivot_Treatment.Treatment_EndDate
supportingInfo	OSIRIS_pivot_Treatment.Treatment_ClinicalTrialContext (if Reference exists, Treatment_ClinicalTrialContext is yes
activity
detail
code	OSIRIS_pivot_Treatment.Treatment_ActivityCode
reasonReference	OSIRIS_pivot_Treatment.TumorPathologyEvent_Ref

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

Treatment
CarePlan	Request
identifier	Request.identifier
instantiatesCanonical	Request.instantiatesCanonical
instantiatesUri	Request.instantiatesUri
basedOn	Request.basedOn
replaces	Request.replaces
status	Request.status {uses different ValueSet}
intent	Request.intent
subject	Request.subject
encounter	Request.context
period	Request.occurrence[x]
created	Request.authoredOn
author	Request.requester
careTeam	Request.performer {similar but does not entail CareTeam}
addresses	Request.reasonReference
supportingInfo	Request.supportingInfo
activity	{no mapping NOTE: This is a list of contained Request-Event tuples!}
outcomeReference	{Event that is outcome of Request in activity.reference}
reference	{Request that resulted in Event in activity.actionResulting}
detail
instantiatesCanonical	Request.instantiatesCanonical
instantiatesUri	Request.instantiatesUri
code	Request.code
reasonCode	Request.reasonCode
reasonReference	Request.reasonReference
status	Request.status
statusReason	Request.statusReason
doNotPerform	Request.doNotPerform
scheduled[x]	Request.occurrence[x]
performer	Request.performer
activity (activity-code)	{no mapping NOTE: This is a list of contained Request-Event tuples!}
outcomeReference	{Event that is outcome of Request in activity.reference}
reference	{Request that resulted in Event in activity.actionResulting}
detail
instantiatesCanonical	Request.instantiatesCanonical
instantiatesUri	Request.instantiatesUri
code	Request.code
reasonCode	Request.reasonCode
reasonReference	Request.reasonReference
status	Request.status
statusReason	Request.statusReason
doNotPerform	Request.doNotPerform
scheduled[x]	Request.occurrence[x]
performer	Request.performer
note	Request.note

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

Treatment
CarePlan	Entity. Role, or Act, Act[classCode=PCPR, moodCode=INT]
meta	n/a, N/A
implicitRules	n/a
language	n/a
text	n/a, N/A, Act.text?
contained	Entity. Role, or Act, N/A
extension	n/a, N/A
extension (treatment-line)
id	n/a
url	N/A
value[x]	n/a, N/A
value[x] (valueInteger)	n/a, N/A
modifierExtension	n/a, N/A
identifier	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], .id
instantiatesCanonical	n/a, .outboundRelationship[typeCode=DEFN].target
instantiatesUri	n/a, .outboundRelationship[typeCode=DEFN].target
basedOn	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
replaces	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
partOf	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
status	n/a, .statusCode planned = new active = active completed = completed
intent	n/a
category	n/a, CD
title	n/a
description	n/a
subject	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=PAT].role[classCode=PAT]
encounter	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .
period	n/a, IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"], .effectiveTime
id	n/a
extension	n/a, N/A
start	n/a, ./low
end	n/a, ./high
created	n/a, .participation[typeCode=AUT].time
author	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
contributor	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
careTeam	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
addresses	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .actRelationship[typeCode=SUBJ].target[classCode=CONC, moodCode=EVN]
supportingInfo	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
goal	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .outboundRelationship[typeCode<=OBJ].
activity	n/a, .outboundRelationship[typeCode=COMP].target
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
outcomeCodeableConcept	n/a, CD
outcomeReference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .inboundRelationship[typeCode=FLFS].source
progress	n/a, Act, .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
reference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .outboundRelationship[typeCode=COMP].target
detail	n/a, .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
kind	n/a, .inboundRelationship[typeCode=COMP].source[classCode=LIST].code
instantiatesCanonical	n/a, .outboundRelationship[typeCode=DEFN].target
instantiatesUri	n/a, .outboundRelationship[typeCode=DEFN].target
code	n/a, CD, .code
reasonCode	n/a, CD
reasonReference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
goal	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .outboundRelationship[typeCode<=OBJ].
status	n/a, .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted
statusReason	n/a, CD
doNotPerform	n/a, actionNegationInd
scheduled[x]	n/a, .effectiveTime
location	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=LOC].role
performer	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=PFM]
product[x]	n/a, .participation[typeCode=PRD].role
dailyAmount	n/a, PQ, IVL<PQ>, MO, CO, depending on the values, .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity
quantity	n/a, PQ, IVL<PQ>, MO, CO, depending on the values, .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity
description	n/a, .text
activity (activity-code)	n/a, .outboundRelationship[typeCode=COMP].target
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
outcomeCodeableConcept	n/a, CD
outcomeReference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .inboundRelationship[typeCode=FLFS].source
progress	n/a, Act, .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
reference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .outboundRelationship[typeCode=COMP].target
detail	n/a, .outboundRelationship[typeCode=COMP, subsetCode=SUMM].target
id	n/a
extension	n/a, N/A
modifierExtension	n/a, N/A
kind	n/a, .inboundRelationship[typeCode=COMP].source[classCode=LIST].code
instantiatesCanonical	n/a, .outboundRelationship[typeCode=DEFN].target
instantiatesUri	n/a, .outboundRelationship[typeCode=DEFN].target
code	n/a, CD, .code
id	n/a
extension	n/a, N/A
coding	n/a, CV, union(., ./translation)
id	n/a
extension	n/a, N/A
system	n/a, ./codeSystem
version	n/a, ./codeSystemVersion
code	n/a, ./code
display	n/a, CV.displayName
userSelected	n/a, CD.codingRationale
text	n/a, ./originalText[mediaType/code="text/plain"]/data
reasonCode	n/a, CD
reasonReference	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity)
goal	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .outboundRelationship[typeCode<=OBJ].
status	n/a, .statusCode not-started = new scheduled = not-started (and fulfillment relationship to appointent) in-progress = active on-hold = suspended completed = completed cancelled = aborted
statusReason	n/a, CD
doNotPerform	n/a, actionNegationInd
scheduled[x]	n/a, .effectiveTime
location	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=LOC].role
performer	n/a, The target of a resource reference is a RIM entry point (Act, Role, or Entity), .participation[typeCode=PFM]
product[x]	n/a, .participation[typeCode=PRD].role
dailyAmount	n/a, PQ, IVL<PQ>, MO, CO, depending on the values, .outboundRelationship[typeCode=COMP][classCode=SBADM].doseQuantity
quantity	n/a, PQ, IVL<PQ>, MO, CO, depending on the values, .outboundRelationship[typeCode=COMP][classCode=SPLY].quantity
description	n/a, .text
note	n/a, Act, .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

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

Treatment
CarePlan
identifier	FiveWs.identifier
status	FiveWs.status
category	FiveWs.class
description	FiveWs.what[x]
subject	FiveWs.subject[x], FiveWs.subject
encounter	FiveWs.context
period	FiveWs.planned
created	FiveWs.recorded
author	FiveWs.author
careTeam	FiveWs.actor
addresses	FiveWs.why[x]

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

Treatment
CarePlan
identifier	CX / EI (occasionally, more often EI maps to a resource id or a URL), PTH-3
status	PTH-5
category	CE/CNE/CWE
subject	PID-3
encounter	Associated PV1
period	DR, GOL-7 / GOL-8
start	DR.1
end	DR.2
addresses	PRB-4
goal	GOL.1
activity
outcomeCodeableConcept	CE/CNE/CWE
progress	N/A, NTE?
detail
code	CE/CNE/CWE, OBR-4 / RXE-2 / RXO-1 / RXD-2
reasonCode	CE/CNE/CWE
status	ORC-5?
statusReason	CE/CNE/CWE
scheduled[x]	TQ1
location	OBR-24(???!!)
performer	PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
product[x]	RXE-2 / RXO-1 / RXD-2
dailyAmount	SN (see also Range) or CQ, RXO-23 / RXE-19 / RXD-12
quantity	SN (see also Range) or CQ, RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
description	NTE?
activity (activity-code)
outcomeCodeableConcept	CE/CNE/CWE
progress	N/A, NTE?
detail
code	CE/CNE/CWE, OBR-4 / RXE-2 / RXO-1 / RXD-2
coding	CE/CNE/CWE subset one of the sets of component 1-3 or 4-6, C*E.1-8, C*E.10-22
system	C*E.3
version	C*E.7
code	C*E.1
display	C*E.2 - but note this is not well followed
userSelected	Sometimes implied by being first
text	C*E.9. But note many systems use C*E.2 for this
reasonCode	CE/CNE/CWE
status	ORC-5?
statusReason	CE/CNE/CWE
scheduled[x]	TQ1
location	OBR-24(???!!)
performer	PRT-5 : ( PRV-4 = (provider participations)); PRT-5 : ( PRV-4 = (non-provider person participations )) ; PRT-5 : ( PRV-4 = (patient non-subject of care) ) ; PRT-8
product[x]	RXE-2 / RXO-1 / RXD-2
dailyAmount	SN (see also Range) or CQ, RXO-23 / RXE-19 / RXD-12
quantity	SN (see also Range) or CQ, RXO-11 / RXE-10 / RXD-4 / RXG-5 / RXA-6 / TQ1-2.1 *and* RXO-12 / RXE-11 / RXD-5 / RXG-7 / RXA-7 / TQ1-2.2
description	NTE?
note	N/A, NTE?