CodeX Radiation Therapy
2.0.0 - STU2 United States of America flag

CodeX Radiation Therapy, published by HL7 International / Cross-Group Projects. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/codex-radiation-therapy/ and changes regularly. See the Directory of published versions

Extension: Dose Planned to Volume

Official URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume Version: 2.0.0
Standards status: Trial-use Active as of 2026-01-27 Computable Name: RadiotherapyDosePlannedToVolume
Other Identifiers: OID:2.16.840.1.113883.4.642.40.14.42.11

Dose parameters planned for one radiotherapy volume.

Context of Use

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Dose to a Dose Reference
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:volume S 1..1 Extension Volume targeted by the planned dose
..... extension 0..0 Extension
..... url 1..1 uri "volume"
..... value[x] 1..1 Reference(Radiotherapy Volume) Value of extension
.... extension:fractionDose S 0..1 Extension Radiation Dose Planned per Fraction
..... extension 0..0 Extension
..... url 1..1 uri "fractionDose"
..... value[x] 0..1 Quantity Value of extension
Required Pattern: At least the following
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:totalDose S 0..1 Extension Total Planned Radiation Dose
..... extension 0..0 Extension
..... url 1..1 uri "totalDose"
..... value[x] 1..1 Quantity Value of extension
Required Pattern: At least the following
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:fractions S 0..1 Extension Number of Planned Fractions
..... extension 0..0 Extension
..... url 1..1 uri "fractions"
..... value[x] 0..1 positiveInt Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Dose to a Dose Reference
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:volume S 1..1 Extension Volume targeted by the planned dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "volume"
..... value[x] 1..1 Reference(Radiotherapy Volume) Value of extension
.... extension:fractionDose S 0..1 Extension Radiation Dose Planned per Fraction
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "fractionDose"
..... value[x] 0..1 Quantity Value of extension
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 decimal Numerical value (with implicit precision)
...... comparator 0..1 code < | <= | >= | > - how to understand the value
...... unit 0..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:totalDose S 0..1 Extension Total Planned Radiation Dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "totalDose"
..... value[x] 1..1 Quantity Value of extension
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 decimal Numerical value (with implicit precision)
...... comparator 0..1 code < | <= | >= | > - how to understand the value
...... unit 0..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:fractions S 0..1 Extension Number of Planned Fractions
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "fractions"
..... value[x] 0..1 positiveInt Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Complex Extension: Dose parameters planned for one radiotherapy volume.

  • volume: Reference: A BodyStructure resource representing the body structure to be treated, for example, Chest Wall Lymph Nodes.
  • fractionDose: Quantity: The dose planned per fraction to this volume.
  • totalDose: Quantity: The total dose planned to this volume within the scope of this ServiceRequest.
  • fractions: positiveInt: The planned number of fractions to deliver the dose. See also extension RadiotherapyFractionsPlanned which is used instead if fractions are the same for all volumes, i.e. in phases or plans.

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Dose to a Dose Reference
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:volume S 1..1 Extension Volume targeted by the planned dose
..... extension 0..0 Extension
..... url 1..1 uri "volume"
..... value[x] 1..1 Reference(Radiotherapy Volume) Value of extension
.... extension:fractionDose S 0..1 Extension Radiation Dose Planned per Fraction
..... extension 0..0 Extension
..... url 1..1 uri "fractionDose"
..... value[x] 0..1 Quantity Value of extension
Required Pattern: At least the following
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:totalDose S 0..1 Extension Total Planned Radiation Dose
..... extension 0..0 Extension
..... url 1..1 uri "totalDose"
..... value[x] 1..1 Quantity Value of extension
Required Pattern: At least the following
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:fractions S 0..1 Extension Number of Planned Fractions
..... extension 0..0 Extension
..... url 1..1 uri "fractions"
..... value[x] 0..1 positiveInt Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Planned Dose to a Dose Reference
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:volume S 1..1 Extension Volume targeted by the planned dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "volume"
..... value[x] 1..1 Reference(Radiotherapy Volume) Value of extension
.... extension:fractionDose S 0..1 Extension Radiation Dose Planned per Fraction
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "fractionDose"
..... value[x] 0..1 Quantity Value of extension
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 decimal Numerical value (with implicit precision)
...... comparator 0..1 code < | <= | >= | > - how to understand the value
...... unit 0..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:totalDose S 0..1 Extension Total Planned Radiation Dose
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "totalDose"
..... value[x] 1..1 Quantity Value of extension
Required Pattern: At least the following
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... value 0..1 decimal Numerical value (with implicit precision)
...... comparator 0..1 code < | <= | >= | > - how to understand the value
...... unit 0..1 string Unit representation
...... system 1..1 uri System that defines coded unit form
Fixed Value: http://unitsofmeasure.org
...... code 1..1 code Coded form of the unit
Fixed Value: cGy
.... extension:fractions S 0..1 Extension Number of Planned Fractions
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "fractions"
..... value[x] 0..1 positiveInt Value of extension
... url 1..1 uri "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Complex Extension: Dose parameters planned for one radiotherapy volume.

  • volume: Reference: A BodyStructure resource representing the body structure to be treated, for example, Chest Wall Lymph Nodes.
  • fractionDose: Quantity: The dose planned per fraction to this volume.
  • totalDose: Quantity: The total dose planned to this volume within the scope of this ServiceRequest.
  • fractions: positiveInt: The planned number of fractions to deliver the dose. See also extension RadiotherapyFractionsPlanned which is used instead if fractions are the same for all volumes, i.e. in phases or plans.

 

Other representations of profile: CSV, Excel, Schematron