Search FHIR

FHIR Osiris Implementation Guide
1.1.0 - trial-implementation

This page is part of the OSIRIS FHIR Implementation Guide (v1.1.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: RadiotherapyPlan - Mappings

Draft as of 2025-04-03

Mappings for the radiotherapy-plan resource profile.

Mappings for OSIRIS pivot files (RadiotherapyPlan)

RadiotherapyPlan
Procedure
   extension
   extension (basedOn)
      extension (seriesUID)OSIRIS_pivot_PlanRT.Series_Ref
      extension (rtStructUID)OSIRIS_pivot_PlanRT.ROISegmentation_Ref
   extension (doseToVolume)
      extension (fractionDose)OSIRIS_pivot_DoseToVolumeRT.DoseToVolume_FractionDose
      extension (numberOfFractions)OSIRIS_pivot_DoseToVolumeRT.DoseToVolume_NumberOfFractions
      extension (totalDose)OSIRIS_pivot_DoseToVolumeRT.DoseToVolume_TotalDose
      extension (rtDoseUID)OSIRIS_pivot_PlanRT.Plan_RtDoseUID
   extension (modalityAndTechnique)
      extension (radiotherapyModality)OSIRIS_pivot_ModalityAndTechniqueRT.ModalityAndTechnique_Modality
      extension (radiotherapyTechnique)OSIRIS_pivot_ModalityAndTechniqueRT.ModalityAndTechnique_Technique
      extension (radiotherapyTreatmentMachinePlanned)OSIRIS_pivot_ModalityAndTechniqueRT.ModalityAndTechnique_TreatmentMachinePlanned
   extension (energyOrIsotope)
      extension (quantityEnergyOrIsotope)OSIRIS_pivot_EnergyOrIsotopeRT.EnergyOrIsotope_Quantity
      extension (nameEnergyOrIsotope)OSIRIS_pivot_EnergyOrIsotopeRT.EnergyOrIsotope_IsotopeName
   extension (numberOfFractions)OSIRIS_pivot_PlanRT.Plan_NumberOfFractions
   extension (reasonReplanification)OSIRIS_pivot_PlanRT.Plan_ReasonReplanification
   extension (algorithmName)OSIRIS_pivot_PlanRT.Plan_AlgorithmName
   identifier (rtPlanUID)OSIRIS_pivot_PlanRT.Plan_RtPlanUID
   partOfOSIRIS_pivot_PlanRT.PhaseRT_Ref
   categoryOSIRIS_pivot_PlanRT.Plan_Type
   subjectOSIRIS_pivot_PlanRT.Patient_Id
   performed[x]
      startOSIRIS_pivot_PlanRT.Plan_StartDate
      endOSIRIS_pivot_PlanRT.Plan_EndDate

Mappings for DICOM Tag Mapping (version OSIRIS) (RadiotherapyPlan)

RadiotherapyPlan
Procedure
   extension
   extension (basedOn)
      extension (seriesUID)RT Image/RT Series/Series Instance UID (0020,000E) or RT Structure Set/Structure Set/Refrenced Frame of Reference Sequence (3006,0010)/RT Referenced Study Sequence (3006,0012)/RT Referenced Series Sequence (3006,0014)/Series Instance UID (0020,000E)
      extension (rtStructUID)RT Plan/RT General Plan/Referenced Structure Set Sequence (300C,0060)/Referenced SOP Instance UID (0008,1155)
   extension (doseToVolume)
      extension (numberOfFractions)RT Plan/RT Fraction Scheme/Fraction Group Sequence/Number of Fractions Planned (300A,0078)
      extension (totalDose)RT Plan/RT Prescription/Dose Reference Sequence/Target Prescription Dose (300A,0026)
      extension (rtDoseUID)RT Dose/SOP Common/SOP Instance UID (0008,0018)
   extension (modalityAndTechnique)
      extension (radiotherapyModality)RT Plan/RT Beams/Beam Sequence/Radiation Type (300A,00C6)
      extension (radiotherapyTechnique)RT Plan/RT Beams/Beam Type (300A,00c4) WHERE Treatment Delivery Type='TREATMENT' (300A,00CE) OR Treatment Protocols (300A,0009)
      extension (radiotherapyTreatmentMachinePlanned)RT Plan/RT Beams/ Beam Sequence/Treatment Machine Name (300A, 00B2)
   extension (energyOrIsotope)
      extension (quantityEnergyOrIsotope)RT Plan/RT Beams/Beam Sequence/Control Point Sequence/Nominal Beam Energy (300A,0114)
   extension (numberOfFractions)RT Plan/RT Fraction Scheme/Fraction Group Sequence/Number Of Fractions Planned (300A,0078)
   extension (algorithmName)RT Dose/Structure Set/Structure Set ROI Sequence/ROI Derivation Algorithm Identification Sequence/Algorithm Name (0066,0036)
   identifier (rtPlanUID)RT Dose/RT Dose/Referenced RT Plan Sequence (300C,0002)/Referenced SOP Instance UID (0008,1155)

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

RadiotherapyPlan
ProcedureEvent
   identifierEvent.identifier
   identifier (rtPlanUID)Event.identifier
   instantiatesCanonicalEvent.instantiatesCanonical
   instantiatesUriEvent.instantiatesUri
   basedOnEvent.basedOn
   partOfEvent.partOf
   statusEvent.status
   statusReasonEvent.statusReason
   codeEvent.code
   subjectEvent.subject
   encounterEvent.context
   performed[x]Event.occurrence[x]
   performerEvent.performer
      functionEvent.performer.function
      actorEvent.performer.actor
   reasonCodeEvent.reasonCode
   reasonReferenceEvent.reasonReference
   noteEvent.note

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

RadiotherapyPlan
ProcedureEntity. Role, or Act, Procedure[moodCode=EVN]
   textAct.text?
   containedN/A
   extension
   extension (basedOn)
      idn/a
      extensionn/a
      extension (imagingStudyRef)
         idn/a
         urlN/A
         value[x]N/A
      extension (seriesUID)
         idn/a
         urlN/A
         value[x]N/A
      extension (rtStructUID)
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (doseToVolume)
      idn/a
      extension
      extension (volume)
         idn/a
         urlN/A
         value[x]N/A
      extension (fractionDose)
         idn/a
         urlN/A
         value[x]N/A
      extension (numberOfFractions)
         idn/a
         urlN/A
         value[x]N/A
      extension (totalDose)
         idn/a
         urlN/A
         value[x]N/A
      extension (rtDoseUID)
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (modalityAndTechnique)
      idn/a
      extension
      extension (radiotherapyModality)
         idn/a
         urlN/A
         value[x]N/A
      extension (radiotherapyTechnique)
         idn/a
         urlN/A
         value[x]N/A
      extension (radiotherapyTreatmentMachinePlanned)
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   extension (energyOrIsotope)
      idn/a
      extension
      extension (quantityEnergyOrIsotope)
         idn/a
         urlN/A
         value[x]N/A
      extension (nameEnergyOrIsotope)
         idn/a
         urlN/A
         value[x]N/A
      urlN/A
   modifierExtensionN/A
   identifier.id
   identifier (rtPlanUID).id
      idn/a
      extensionn/a
      useRole.code or implied by context
      typeRole.code or implied by context
      systemII.root or Role.id.root
      valueII.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
      periodRole.effectiveTime or implied by context
      assignerII.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
   instantiatesCanonical.outboundRelationship[typeCode=DEFN].target
   instantiatesUri.outboundRelationship[typeCode=DEFN].target
   basedOn.outboundRelationship[typeCode=FLFS].target[classCode=(various e.g. PROC, OBS, PCPR, ACT, moodCode=RQO].code
   partOf.inboundRelationship[typeCode=COMP].source[classCode=SBADM or PROC or OBS, moodCode=EVN]
   statusstatusCode
   statusReason.reason.Observation.value
   category.outboundRelationship[typeCode="COMP].target[classCode="LIST", moodCode="EVN"].code
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   code.code
      idn/a
      extensionn/a
      codingunion(., ./translation)
         idn/a
         extensionn/a
         system./codeSystem
         version./codeSystemVersion
         code./code
         displayCV.displayName
         userSelectedCD.codingRationale
      text./originalText[mediaType/code="text/plain"]/data
   subject.participation[typeCode=SBJ].role
   encounter.inboundRelationship[typeCode=COMP].source[classCode=ENC, moodCode=EVN]
   performed[x].effectiveTime
      idn/a
      extensionn/a
      start./low
      end./high
   recorder.participation[typeCode=AUT].role
   asserter.participation[typeCode=INF].role
   performer.participation[typeCode=PRF]
      idn/a
      extensionn/a
      modifierExtensionN/A
      function.functionCode
      actor.role
      onBehalfOf.scoper
   location.participation[typeCode=LOC].role[classCode=SDLOC]
   reasonCode.reasonCode
   reasonReference.reasonCode
   bodySite.targetSiteCode
   outcome.outboundRelationship[typeCode=OUT].target.text
   report.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN]
   complication.outboundRelationship[typeCode=OUTC].target[classCode=OBS, code="complication", moodCode=EVN].value
   complicationDetail.outboundRelationship[typeCode=OUTC].target[classCode=OBS, code="complication", moodCode=EVN].value
   followUp.outboundRelationship[typeCode=COMP].target[classCode=ACT, moodCode=INT].code
   note.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value
   focalDevice.participation[typeCode=DEV].role[classCode=MANU]
      idn/a
      extensionn/a
      modifierExtensionN/A
      action.inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="procedure device action"].value=:procedure device action codes
      manipulated.participation[typeCode=DEV].role[classCode=SDLOC]
   usedReference.participation[typeCode=DEV].role[classCode=MANU] or .participation[typeCode=CSM].role[classCode=ADMM] (for Medication or Substance)
   usedCodeparticipation[typeCode=Dev].role[classCode=MANU]

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

RadiotherapyPlan
Procedure
   identifierFiveWs.identifier
   identifier (rtPlanUID)FiveWs.identifier
   statusFiveWs.status
   categoryFiveWs.class
   codeFiveWs.what[x]
   subjectFiveWs.subject[x], FiveWs.subject
   encounterFiveWs.context
   performed[x]FiveWs.done[x]
   recorderFiveWs.author
   asserterFiveWs.source
   performer
      actorFiveWs.actor
   locationFiveWs.where[x]
   reasonCodeFiveWs.why[x]
   reasonReferenceFiveWs.why[x]

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

RadiotherapyPlan
Procedure
   identifierSome combination of ORC-2 / ORC-3 / OBR-2 / OBR-3 / IPC-1 / IPC-2 / IPC-3 / IPC-4
   identifier (rtPlanUID)Some combination of ORC-2 / ORC-3 / OBR-2 / OBR-3 / IPC-1 / IPC-2 / IPC-3 / IPC-4
      useN/A
      typeCX.5
      systemCX.4 / EI-2-4
      valueCX.1 / EI.1
      periodCX.7 + CX.8
      assignerCX.4 / (CX.4,CX.9,CX.10)
   category
      codingC*E.1-8, C*E.10-22
         systemC*E.3
         versionC*E.7
         codeC*E.1
         displayC*E.2 - but note this is not well followed
         userSelectedSometimes implied by being first
      textC*E.9. But note many systems use C*E.2 for this
   codeOBR-44/OBR-45
      codingC*E.1-8, C*E.10-22
         systemC*E.3
         versionC*E.7
         codeC*E.1
         displayC*E.2 - but note this is not well followed
         userSelectedSometimes implied by being first
      textC*E.9. But note many systems use C*E.2 for this
   subjectPID-3
   encounterPV1-19
   performed[x]OBR-7
      startDR.1
      endDR.2
   performer
      functionSome combination of STF-18 / PRA-3 / PRT-4 / ROL-3 / ORC-12 / OBR-16 / PV1-7 / PV1-8 / PV1-9 / PV1-17 / OBX-25
      actorORC-19/PRT-5
   bodySiteOBX-20
   noteNTE