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

Extension: Dose Planned to Volume

Dose parameters planned for one radiotherapy volume.

The official URL for this extension is: 

http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume

Status: active
Extension maintained by: HL7 Cross Group Projects Work Group

Context of Use

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

  • Element

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

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 4 elements
Fixed Value: 5 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

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
Slice: Unordered, Open by type:$this
.... valueQuantity 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
Slice: Unordered, Open by type:$this
.... valueQuantity 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"
.... Slices for value[x] 0..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 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"
.... Slices for value[x] 1..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 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

Mandatory: 3 elements (2 nested mandatory elements)
Must-Support: 4 elements
Fixed Value: 5 elements
Prohibited: 5 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Extension.extension.value[x] is sliced based on the value of type:$this

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
Slice: Unordered, Open by type:$this
.... valueQuantity 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
Slice: Unordered, Open by type:$this
.... valueQuantity 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"
.... Slices for value[x] 0..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 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"
.... Slices for value[x] 1..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
..... value[x]:valueQuantity 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