CodeX™ Radiation Therapy
1.0.0-ballot - ci-build
CodeX™ Radiation Therapy
1.0.0-ballot - ci-build
This page is part of the CodeX™ Radiation Therapy (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
Course Level Profiles
| Radiotherapy Course Cumulative Prescription |
A Radiotherapy Course Prescription is a high-level request for a complete Course of Radiotherapy, which may be fulfilled by one or more Phases. |
| Radiotherapy Course Summary |
A Summary of the Treatment Progress in a Radiotherapy Course. Whenever new contributions in the scope of the same Course are delivered, this resource is updated (no new resource created). |
| Radiotherapy Planned Course |
A Radiotherapy Planned Course covers all Radiotherapy Plans to deliver a complete Course. |
Phase Level Profiles
| Radiotherapy Phase Cumulative Prescription |
A Radioherapy Phase Prescription is a request for one series of fractionated treatments using Radiotherapy. It can define treatment parameters such as modality or technique, and prescribe dose to multiple targets. |
| Radiotherapy Planned Phase |
A Radiotherapy Planned Phase is the summary over all Radiotherapy Plans to deliver a single Phase of Radiotherapy treatment. |
| Radiotherapy Treated Phase |
A summary of a phase of radiotherapy treatment that has been delivered. The scope is a treatment consisting of one or multiple identical fractions. A phase consists of a set of identical fractions. In this context, identical means that each fraction uses the same modality, technique, dose per fraction, and is applied to the same treatment volume or volumes. Because of their spatial relationship or the technique used, all treatment volumes do not necessarily receive the same total dose during a phase. |
Plan Level Profiles
| Radiotherapy Plan Prescription |
A Radioherapy Plan Prescription is a request for Radiotherapy treatment with a single Radiotherapy Treamtent Plan. |
| Radiotherapy Treated Plan |
A summary of Radiotherapy treatment delivered with a single Radiotherapy Treatment Plan. |
| Radiotherapy Treatment Plan |
A Radiotherapy Treatment Plan resource describes the treatment that is planned to be delivered with a single Radiotherapy Treatment Plan. |
Profiles referenced from all levels and throughout the Radiotherapy workflow.
| Radiotherapy Volume |
A volume of the body used in Radiotherapy planning or treatment delivery. This corresponds to the Conceptual Volume in DICOM. |
These define constraints on FHIR data types for systems conforming to this implementation guide
| Reference to DICOM SOP Instance |
A Reference to a DICOM SOP Instance. |
| Dose Planned to Volume |
Dose parameters planned for one radiotherapy volume. |
| Dose Prescribed to Volume |
Dose parameters prescribed for one radiotherapy volume. |
| Radiotherapy Energy or Isotope |
The radiation energy used for radiotherapy. The energy spectrum is characterized by the maximum energy, the maximum accelaration voltage, or the used isotope. |
| Radiotherapy Fractions Delivered |
The total number of fractions (treatment divisions) actually delivered for this volume. |
| Number of Planned Fractions |
The number of planned Fractions in this scope. This extension SHALL only be present if the treatment is structured as countable Fractions, for example in a Planned Phase or in a Treatment Plan. |
| Number of Prescribed Fractions |
The number of prescribed Fractions in this scope. This extension SHALL only be present if the treatment is structured as countable Fractions, for example in a Phase Prescription. |
| Reason for Revision |
The reason a planned or prescribed radiotherapy treatment was revised, superceded, or adapted. |
| Radiotherapy Treatment Applicator Type |
Radiotherapy Treatment Applicator Type. |
| Treatment Device |
The device used for delivering the Radiotherapy. This can be a treatment machine or auxiliary device, for example a positioning device. Could be used for a LINAC (external beam) or an Afterloader (brachytherapy). The device is specified by its manufacturer and model number. |
| Treatment Device Manufacturer |
The manufacturer of a device used for delivering radiotherapy. |
| Treatment Device Model |
The model number of a device used for delivering radiotherapy.. |
These define sets of codes used by systems conforming to this implementation guide
| Brachytherapy Applicator Types |
Applicator Types Used in Brachytherapy |
| Unit to characterize Energy in Radiotherapy |
Unit to characterize the Energy spectrum used in Radiotherapy. For electrons, the maximum energy is given in MeV. For photons, the maximum acceleration voltage is given in MV or kV, although those are not units of energy. |
| Radiotherapy Isotopes |
Isotopes Used in Radiotherapy |
| Reason for Revision Value Set |
The reason a planned or prescribed radiotherapy treatment was revised, superceded, or adapted. |
These define new code systems used by systems conforming to this implementation guide
| Brachytherapy Applicator Types Code System |
Brachytherapy Applicator Types – need to request codes |
| Reason for Revision Code System |
The reason a planned or prescribed radiotherapy treatment was revised, superceded, or adapted. |
| Requested SNOMED Codes Code System |
Codes requested from SNOMED by mCODE, to be issued at a later date. Where numeric codes are given, these correspond to the expected SNOMED-CT codes. Terms beginning with ‘USCRS-‘ (for United States Content Request Service) represent request identifiers with no SNOMED code yet approved or assigned. |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like
| Example Diagnosis 1 |
An example diagnosis for a breast case. |
| Example Diagnosis 101 Breast |
An example diagnosis for a breast case for Patient-101. |
| Example Diagnosis 2 |
An example diagnosis for a prostate case. |
| Example Female Patient 101 |
An example female patient to relate Radiotherapy resources to. |
| Example Female Patient 5 |
An example female patient to relate Radiotherapy resources to. |
| Example Male Patient 6 |
An example male patient to relate Radiotherapy resources to. |
| Example XRTS Patient 1 |
An example patient, test case XRTS-01. |
| Example XRTS Patient 2 |
An example patient, test case XRTS-02. |
| Example XRTS Patient 3 |
An example patient, test case XRTS-03. |
| Example XRTS Patient 4 |
An example patient, test case XRTS-04. |
| Example XRTS Patient 5 |
An example patient, test case XRTS-05. |
| Example XRTS Patient 6 |
An example patient, test case XRTS-06. |
| Example Practitioner |
An example practitioner to relate Radiotherapy resources to. |
| RadiotherapyCoursePrescription-04-Prostate |
Radiotherapy CoursePrescription with elements of IHE-RO XRTS profile for a prostate example. |
| RadiotherapyCoursePrescription-101-RTTD-BilateralBreast |
Radiotherapy Course Prescription example from Codex RTTD collection. |
| RadiotherapyCourseSummary-04-Prostate |
Treatment Summary over Radiotherapy Course with all elements expected in XRTS. |
| RadiotherapyCourseSummary-101-RTTD-BilateralBreast |
Radiotherapy Course Summary example from Codex RTTD collection, ‘Bilateral Breast’. |
| RadiotherapyCourseSummary-XRTS-01-22A-01-Prostate-1P-1V |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-01 completely treated. |
| RadiotherapyCourseSummary-XRTS-01-22A-01-Prostate-1P-1V-1Fx |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-01 after 1 Fraction. |
| RadiotherapyCourseSummary-XRTS-02-22A-01-Prostate-2P-1V |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-02 completely treated. |
| RadiotherapyCourseSummary-XRTS-02-22A-01-Prostate-2P-1V-1Fx |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-02 after 1 Fraction. |
| RadiotherapyCourseSummary-XRTS-03-22A-01-Prostate-1P-3V |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-03 completely treated. |
| RadiotherapyCourseSummary-XRTS-03-22A-01-Prostate-1P-3V-1Fx |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-03 after 1 Fraction. |
| RadiotherapyCourseSummary-XRTS-04-22A-01-Breast-2P-3V |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-04 completely treated. |
| RadiotherapyCourseSummary-XRTS-04-22A-01-Breast-2P-3V-1Fx |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-04 after 1 Fraction. |
| RadiotherapyCourseSummary-XRTS-05-22A-01-BrainMets-1P-1V |
Radiotherapy Course Summary example, test case XRTS-05, Course 1 completely treated. |
| RadiotherapyCourseSummary-XRTS-05-22A-01-BrainMets-1P-1V-1Fx |
Radiotherapy Course Summary example, test case XRTS-05, Course 1 after 1 Fraction. |
| RadiotherapyCourseSummary-XRTS-05-22A-02-BrainMets-1P-1V |
Radiotherapy Course Summary example, test case XRTS-05, Course 2 completely treated. |
| RadiotherapyCourseSummary-XRTS-06-22B-01-Uterus-1P-1V |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-06 completely treated. |
| RadiotherapyCourseSummary-XRTS-06-22B-01-Uterus-1P-1V-1Fx |
Radiotherapy Course Summary example from Codex XRTS collection, test case XRTS-06 after 1 Fraction. |
| RadiotherapyPhasePrescription-04-Prostate-Phase1 |
Radiotherapy Phase Prescription to cover IHE-RO XRTS profile for a Prostate example, phase 1. |
| RadiotherapyPhasePrescription-05-Prostate-Phase2 |
Radiotherapy PhasePrescription to cover IHE-RO XRTS profile for a Prostate example, phase 2. |
| RadiotherapyPhasePrescription-101-RTTD-LeftBreastTang |
Radiotherapy Phase Prescription example from Codex RTTD collection. |
| RadiotherapyPhasePrescription-102-RTTD-LeftBreastBoost |
Radiotherapy Phase Prescription example from Codex RTTD collection. |
| RadiotherapyPhasePrescription-103-RTTD-RightBreastTang |
Radiotherapy Phase Prescription example from Codex RTTD collection. |
| RadiotherapyPlanPrescription-04-Prostate-Phase1-Plan1 |
Radiotherapy Plan Prescription to cover IHE-RO XRTS profile for a Prostate example, phase 1, plan 1. |
| RadiotherapyPlanPrescription-05-Prostate-Phase2-Plan1 |
Radiotherapy Plan Prescription to cover IHE-RO XRTS profile for a Prostate example, phase 2, plan 1. |
| RadiotherapyPlannedCourse-04-Prostate |
Radiotherapy Planned Course example. |
| RadiotherapyPlannedCourse-XRTS-01-22A-01-Prostate-1P-1V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-01. |
| RadiotherapyPlannedCourse-XRTS-02-22A-01-Prostate-2P-1V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-02. |
| RadiotherapyPlannedCourse-XRTS-03-22A-01-Prostate-1P-3V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-03. |
| RadiotherapyPlannedCourse-XRTS-04-22A-01-Breast-2P-3V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-04. |
| RadiotherapyPlannedCourse-XRTS-05-22A-01-BrainMets-1P-1V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-05, Course 1. |
| RadiotherapyPlannedCourse-XRTS-05-22A-02-BrainMets-1P-1V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-05, Course 2. |
| RadiotherapyPlannedCourse-XRTS-06-22B-01-Uterus-1P-1V |
Radiotherapy Planned Course example from Codex XRTS collection, test case XRTS-06. |
| RadiotherapyPlannedPhase-04-Prostate-Phase1 |
Radiotherapy Planned Phase, Prostate example, phase 1. |
| RadiotherapyPlannedPhase-05-Prostate-Phase2 |
Radiotherapy Planned Phase, Prostate example, phase 2. |
| RadiotherapyPlannedPhase-XRTS-01-22A-01-01-Primary |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-01, Phase 1. |
| RadiotherapyPlannedPhase-XRTS-02-22A-01-01-Primary |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-02, Phase 1. |
| RadiotherapyPlannedPhase-XRTS-02-22A-01-02-PlanChange |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-02, Phase 2. |
| RadiotherapyPlannedPhase-XRTS-03-22A-01-01-Primary |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-03, Phase 1. |
| RadiotherapyPlannedPhase-XRTS-04-22A-01-01-LeftBreastTang |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-04, Phase 1. |
| RadiotherapyPlannedPhase-XRTS-04-22A-01-02-RightBreastTang |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-04, Phase 2. |
| RadiotherapyPlannedPhase-XRTS-04-22A-01-03-LeftBreastBoost |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-04, Phase 3. |
| RadiotherapyPlannedPhase-XRTS-05-22A-01-01-Primary |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-05, Course 1, Phase 1. |
| RadiotherapyPlannedPhase-XRTS-05-22A-02-01-Primary |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-05, Course 2, Phase 1. |
| RadiotherapyPlannedPhase-XRTS-06-22B-01-01-Primary |
Radiotherapy Planned Phase example from Codex XRTS collection, test case XRTS-06, Phase 1. |
| RadiotherapyTreatedPhase-05-Prostate-Phase1 |
Treatment Summary for first phase |
| RadiotherapyTreatedPhase-101-LeftBreastTang |
Radiotherapy Treated Phase example from Codex RTTD collection. |
| RadiotherapyTreatedPhase-102-LeftBreastBoost |
Radiotherapy Treated Phase example from Codex RTTD collection. |
| RadiotherapyTreatedPhase-103-RightBreastTang |
Radiotherapy Treated Phase example from Codex RTTDcollection. |
| RadiotherapyTreatedPhase-XRTS-01-22A-01-01-Primary |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-01, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-01-22A-01-01-Primary-1Fx |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-01, Phase 1 after 1 Fraction. |
| RadiotherapyTreatedPhase-XRTS-02-22A-01-01-Primary |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-02, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-02-22A-01-01-Primary-1Fx |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-02, Phase 1 after 1 Fraction. |
| RadiotherapyTreatedPhase-XRTS-02-22A-01-02-PlanChange |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-02, Phase 2 completely treated. |
| RadiotherapyTreatedPhase-XRTS-03-22A-01-01-Primary |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-03, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-03-22A-01-01-Primary-1Fx |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-03, Phase 1 after 1 Fraction. |
| RadiotherapyTreatedPhase-XRTS-04-22A-01-01-LeftBreastTang |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-04, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-04-22A-01-01-LeftBreastTang-1Fx |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-04, Phase 1 after 1 Fraction. |
| RadiotherapyTreatedPhase-XRTS-04-22A-01-02-RightBreastTang |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-04, Phase 2 completely treated. |
| RadiotherapyTreatedPhase-XRTS-04-22A-01-03-LeftBreastBoost |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-04, Phase 3 completely treated. |
| RadiotherapyTreatedPhase-XRTS-05-22A-01-01-Primary |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-05, Course 1, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-05-22A-01-01-Primary-1Fx |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-05, Course 1, Phase 1 after 1 Fraction. |
| RadiotherapyTreatedPhase-XRTS-05-22A-02-01-Primary |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-05, Course 2, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-06-22B-01-01-Primary |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-06, Phase 1 completely treated. |
| RadiotherapyTreatedPhase-XRTS-06-22B-01-01-Primary-1Fx |
Radiotherapy Treated Phase example from Codex XRTS collection, test case XRTS-06, Phase 1 after 1 Fraction. |
| RadiotherapyTreatedPlan-05-Prostate-Phase1-Plan1 |
Treatment Summary for treamtment plan in the first phase |
| RadiotherapyTreatmentPlan-04-Prostate-Phase1-Plan1 |
Radiotherapy Treatment Plan to cover IHE-RO XRTS profile for a Prostate example, phase 1, plan 1. |
| RadiotherapyTreatmentPlan-05-Prostate-Phase2-Plan1 |
Radiotherapy Treatment Plan, Prostate example, phase 2, plan 1. |
| RadiotherapyVolume-02-PTV64 |
Example Target Volume ‘PTV64’. |
| RadiotherapyVolume-03-Prostate |
Example Target Volume ‘Prostate’. |
| RadiotherapyVolume-04-PelvNs |
Example Target Volume ‘Pelvic Nodes’. |
| RadiotherapyVolume-05-SemVs |
Example Target Volume ‘Seminal Vesicles’. |
| RadiotherapyVolume-101-LeftBreast |
Example Target Volume ‘Left Breast’. |
| RadiotherapyVolume-102-LeftBreastBoost |
Example Target Volume ‘Left Breast Boost’. |
| RadiotherapyVolume-103-RightBreast |
Example Target Volume ‘Right Breast’. |
| RadiotherapyVolume-XRTS-01-22A-01-Prostate |
Example Target Volume XRTS-01 ‘Prostate’. |
| RadiotherapyVolume-XRTS-02-22A-01-Prostate |
Example Target Volume XRTS-02 ‘Prostate’. |
| RadiotherapyVolume-XRTS-03-22A-01-Prostate |
Example Target Volume XRTS-03 ‘Prostate’. |
| RadiotherapyVolume-XRTS-03-22A-02-PelvNs |
Example Target Volume XRTS-03 ‘Pelvic Lymph Nodes’. |
| RadiotherapyVolume-XRTS-03-22A-03-SemVs |
Example Target Volume XRTS-03 ‘Seminal Vesicles’. |
| RadiotherapyVolume-XRTS-04-22A-01-LeftBreast |
Example Target Volume XRTS-04 ‘Left Breast’. |
| RadiotherapyVolume-XRTS-04-22A-02-LeftBreastBoost |
Example Target Volume XRTS-04 ‘Left Breast Boost’. |
| RadiotherapyVolume-XRTS-04-22A-03-RightBreast |
Example Target Volume XRTS-04 ‘Right Breast’. |
| RadiotherapyVolume-XRTS-05-22A-01-BrainMets |
Example Target Volume XRTS-05 ‘Brain Mets’ Course 1. |
| RadiotherapyVolume-XRTS-05-22A-02-BrainMets |
Example Target Volume XRTS-05 ‘Brain Mets’ Course 2. Same label as Brain Mets in first Course, but conceptually a different Volume. Dose is not added up. |
| RadiotherapyVolume-XRTS-06-22B-01-Uterus |
Example Target Volume XRTS-06 ‘Cervix Uteri’. |
| RadiotherapyVolume-01-PTV50 |
Example Target Volume ‘PTV50’. |
IG © 2021+ HL7 Cross Group Projects Work Group. Package hl7.fhir.us.codex-radiation-therapy#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-08-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change