Energy or Isotope - Definitions - CodeX Radiation Therapy v2.0.0-ballot

CodeX Radiation Therapy
2.0.0-ballot - Ballot United States of America flag

This page is part of the CodeX™ Radiation Therapy (v2.0.0-ballot: STU 2 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

Extension: RadiotherapyEnergyOrIsotope - Detailed Descriptions

Active as of 2024-04-09

Definitions for the codexrt-radiotherapy-energy-or-isotope extension.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	The radiation energy used for radiotherapy. The energy spectrum is characterized by the maximum energy, the maximum accelaration voltage, or the used isotope.
Short	Radiotherapy Energy or Isotope
2. Extension.extension
Control	0..0
4. Extension.url
Fixed Value	`http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope`
6. Extension.value[x]
Control	1..?
Type	Choice of: CodeableConcept, Quantity(SimpleQuantity), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices are unordered and Open, and can be differentiated using the following discriminators: type @ $this
8. Extension.value[x]:valueQuantity
Slice Name	valueQuantity
Short	The spectrum of radiation energy characterized by a maximum value. 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.
Control	0..1
Binding	The codes SHALL be taken from Radiotherapy Energy Unit Value Set (required to `http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-radiotherapy-energy-unit-vs`)
Type	Quantity(SimpleQuantity)
[x] Note	See Choice of Data Types for further information about how to use [x]
10. Extension.value[x]:valueQuantity.value
Control	1..?
12. Extension.value[x]:valueQuantity.system
Control	1..?
14. Extension.value[x]:valueQuantity.code
Control	1..?
16. Extension.value[x]:valueCodeableConcept
Slice Name	valueCodeableConcept
Short	The isotope used for radiotherapy.
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Radiotherapy Isotope Value Set (extensible to `http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-radiotherapy-isotope-vs`)
Type	CodeableConcept
[x] Note	See Choice of Data Types for further information about how to use [x]

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	The radiation energy used for radiotherapy. The energy spectrum is characterized by the maximum energy, the maximum accelaration voltage, or the used isotope. Optional Extension Element - found in all resources.
Short	Radiotherapy Energy or IsotopeOptional Extensions Element
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition	An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	ExtensionAdditional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..0*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
Slicing	This element introduces a set of slices on `Extension.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
4. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope`
6. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	10..1
Type	Choice of: CodeableConcept, Quantity(SimpleQuantity), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
8. Extension.value[x]:valueQuantity
Slice Name	valueQuantity
Definition	The comparator is not used on a SimpleQuantity Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	The spectrum of radiation energy characterized by a maximum value. 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.Value of extension
Comments	The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control	0..1 This element is affected by the following invariants: ele-1
Binding	The codes SHALL be taken from For codes, see Radiotherapy Energy Unit Value Set (required to `http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-radiotherapy-energy-unit-vs`)
Type	Quantity(SimpleQuantity), date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) qty-3: If a code for the unit is present, the system SHALL also be present (`code.empty() or system.exists()`) sqty-1: The comparator is not used on a SimpleQuantity (`comparator.empty()`)
10. Extension.value[x]:valueQuantity.value
Definition	The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short	Numerical value (with implicit precision)
Comments	The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control	10..1
Type	decimal
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Precision is handled implicitly in almost all cases of measurement.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. Extension.value[x]:valueQuantity.comparator
Definition	Not allowed to be used in this context How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.
Short	< \| <= \| >= \| > - how to understand the value
Control	0..01
Binding	The codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1 (required to `http://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1`) How the Quantity should be understood and represented.
Type	code
Is Modifier	true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing	If there is no comparator, then there is no modification of the value
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. Extension.value[x]:valueQuantity.system
Definition	The identification of the system that provides the coded form of the unit.
Short	System that defines coded unit form
Control	10..1 This element is affected by the following invariants: qty-3
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to know the system that defines the coded form of the unit.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. Extension.value[x]:valueQuantity.code
Definition	A computer processable form of the unit in some unit representation system.
Short	Coded form of the unit
Comments	The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control	10..1
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
18. Extension.value[x]:valueCodeableConcept
Slice Name	valueCodeableConcept
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	The isotope used for radiotherapy.Value of extension
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from For codes, see Radiotherapy Isotope Value Set (extensible to `http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-radiotherapy-isotope-vs`)
Type	CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. Extension
Definition	The radiation energy used for radiotherapy. The energy spectrum is characterized by the maximum energy, the maximum accelaration voltage, or the used isotope.
Short	Radiotherapy Energy or Isotope
Control	0..* This element is affected by the following invariants: ele-1
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
2. Extension.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
4. Extension.extension
Definition	An Extension
Short	Extension
Control	0..0
Type	Extension
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
6. Extension.url
Definition	Source of the definition for the extension code - a logical name or a URL.
Short	identifies the meaning of the extension
Comments	The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Control	1..1
Type	uri
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
Fixed Value	`http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope`
8. Extension.value[x]
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	Value of extension
Control	1..1
Type	Choice of: CodeableConcept, Quantity(SimpleQuantity)
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices are unordered and Closed, and can be differentiated using the following discriminators: type @ $this
10. Extension.value[x]:valueQuantity
Slice Name	valueQuantity
Definition	The comparator is not used on a SimpleQuantity
Short	The spectrum of radiation energy characterized by a maximum value. 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.
Comments	The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.
Control	0..1 This element is affected by the following invariants: ele-1
Binding	The codes SHALL be taken from Radiotherapy Energy Unit Value Set (required to `http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-radiotherapy-energy-unit-vs`)
Type	Quantity(SimpleQuantity)
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) qty-3: If a code for the unit is present, the system SHALL also be present (`code.empty() or system.exists()`) sqty-1: The comparator is not used on a SimpleQuantity (`comparator.empty()`)
12. Extension.value[x]:valueQuantity.id
Definition	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Short	Unique id for inter-element referencing
Control	0..1
Type	string
Is Modifier	false
XML Format	In the XML format, this property is represented as an attribute.
Summary	false
14. Extension.value[x]:valueQuantity.extension
Definition	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short	Additional content defined by implementations
Comments	There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Control	0..*
Type	Extension
Is Modifier	false
Summary	false
Alternate Names	extensions, user content
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`) ext-1: Must have either extensions or value[x], not both (`extension.exists() != value.exists()`)
Slicing	This element introduces a set of slices on `Extension.value[x].extension`. The slices are unordered and Open, and can be differentiated using the following discriminators: value @ url
16. Extension.value[x]:valueQuantity.value
Definition	The value of the measured amount. The value includes an implicit precision in the presentation of the value.
Short	Numerical value (with implicit precision)
Comments	The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).
Control	1..1
Type	decimal
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Precision is handled implicitly in almost all cases of measurement.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
18. Extension.value[x]:valueQuantity.comparator
Definition	Not allowed to be used in this context
Short	< \| <= \| >= \| > - how to understand the value
Control	0..0
Binding	The codes SHALL be taken from QuantityComparator (required to `http://hl7.org/fhir/ValueSet/quantity-comparator\|4.0.1`) How the Quantity should be understood and represented.
Type	code
Is Modifier	true because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.
Meaning if Missing	If there is no comparator, then there is no modification of the value
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
20. Extension.value[x]:valueQuantity.unit
Definition	A human-readable form of the unit.
Short	Unit representation
Control	0..1
Type	string
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
22. Extension.value[x]:valueQuantity.system
Definition	The identification of the system that provides the coded form of the unit.
Short	System that defines coded unit form
Control	1..1 This element is affected by the following invariants: qty-3
Type	uri
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need to know the system that defines the coded form of the unit.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
24. Extension.value[x]:valueQuantity.code
Definition	A computer processable form of the unit in some unit representation system.
Short	Coded form of the unit
Comments	The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.
Control	1..1
Type	code
Is Modifier	false
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
Summary	true
Requirements	Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
26. Extension.value[x]:valueCodeableConcept
Slice Name	valueCodeableConcept
Definition	Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).
Short	The isotope used for radiotherapy.
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from Radiotherapy Isotope Value Set (extensible to `http://hl7.org/fhir/us/codex-radiation-therapy/ValueSet/codexrt-radiotherapy-isotope-vs`)
Type	CodeableConcept
[x] Note	See Choice of Data Types for further information about how to use [x]
Is Modifier	false
Summary	false
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)

IG © 2021+ HL7 International / Cross-Group Projects. Package hl7.fhir.us.codex-radiation-therapy#2.0.0-ballot based on FHIR 4.0.1. Generated 2024-04-09
Links: Table of Contents | QA Report | Version History | | Propose a change