CodeX Radiation Therapy
1.0.0 - STU 1 United States of America flag

This page is part of the CodeX™ Radiation Therapy (v1.0.0: STU 1) based on FHIR 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

Extension: Dose Planned to Volume

Official URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume Version: 1.0.0
Draft as of 2023-07-28 Computable Name: RadiotherapyDosePlannedToVolume

Dose parameters planned for one radiotherapy volume.

Context of Use

This extension may be used on the following element(s):

  • Element ID ObservationDefinition
  • Element ID Procedure
  • Element ID ServiceRequest
  • Element ID Extension
  • Element ID Observation
  • Element ID ActivityDefinition
  • Element ID CarePlan
  • Element ID CareDefinition

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

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.

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlanned Dose to a Dose Reference
... extension 1..*ExtensionExtension
... extension:volume S1..1ExtensionVolume targeted by the planned dose
.... extension 0..0
.... url 1..1uri"volume"
.... value[x] 1..1Reference(Radiotherapy Volume)Value of extension
... extension:fractionDose S0..1ExtensionRadiation Dose Planned per Fraction
.... extension 0..0
.... url 1..1uri"fractionDose"
.... value[x] 0..1QuantityValue of extension
Required Pattern: At least the following
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
.... extension 0..0
.... url 1..1uri"totalDose"
.... value[x] 1..1QuantityValue of extension
Required Pattern: At least the following
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
... extension:fractions S0..1ExtensionNumber of Planned Fractions
.... extension 0..0
.... url 1..1uri"fractions"
.... value[x] 0..1positiveIntValue of extension
... url 1..1uri"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlanned Dose to a Dose Reference
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:volume S1..1ExtensionVolume targeted by the planned dose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"volume"
.... value[x] 1..1Reference(Radiotherapy Volume)Value of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"fractionDose"
.... value[x] 0..1QuantityValue of extension
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... value0..1decimalNumerical value (with implicit precision)
..... comparator0..1code< | <= | >= | > - how to understand the value
..... unit0..1stringUnit representation
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
... extension:totalDose S0..1ExtensionTotal Planned Radiation Dose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"totalDose"
.... value[x] 1..1QuantityValue of extension
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... value0..1decimalNumerical value (with implicit precision)
..... comparator0..1code< | <= | >= | > - how to understand the value
..... unit0..1stringUnit representation
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
... extension:fractions S0..1ExtensionNumber of Planned Fractions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"fractions"
.... value[x] 0..1positiveIntValue of extension
... url 1..1uri"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"

doco Documentation for this format

This structure is derived from Extension

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 View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlanned Dose to a Dose Reference
... extension 1..*ExtensionExtension
... extension:volume S1..1ExtensionVolume targeted by the planned dose
.... extension 0..0
.... url 1..1uri"volume"
.... value[x] 1..1Reference(Radiotherapy Volume)Value of extension
... extension:fractionDose S0..1ExtensionRadiation Dose Planned per Fraction
.... extension 0..0
.... url 1..1uri"fractionDose"
.... value[x] 0..1QuantityValue of extension
Required Pattern: At least the following
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
.... extension 0..0
.... url 1..1uri"totalDose"
.... value[x] 1..1QuantityValue of extension
Required Pattern: At least the following
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
... extension:fractions S0..1ExtensionNumber of Planned Fractions
.... extension 0..0
.... url 1..1uri"fractions"
.... value[x] 0..1positiveIntValue of extension
... url 1..1uri"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionPlanned Dose to a Dose Reference
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension:volume S1..1ExtensionVolume targeted by the planned dose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"volume"
.... value[x] 1..1Reference(Radiotherapy Volume)Value of extension
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"fractionDose"
.... value[x] 0..1QuantityValue of extension
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... value0..1decimalNumerical value (with implicit precision)
..... comparator0..1code< | <= | >= | > - how to understand the value
..... unit0..1stringUnit representation
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
... extension:totalDose S0..1ExtensionTotal Planned Radiation Dose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"totalDose"
.... value[x] 1..1QuantityValue of extension
Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... value0..1decimalNumerical value (with implicit precision)
..... comparator0..1code< | <= | >= | > - how to understand the value
..... unit0..1stringUnit representation
..... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
..... code1..1codeCoded form of the unit
Fixed Value: cGy
... extension:fractions S0..1ExtensionNumber of Planned Fractions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..0
.... url 1..1uri"fractions"
.... value[x] 0..1positiveIntValue of extension
... url 1..1uri"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume"

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron