Radiotherapy Energy or Isotope - Definitions - PanCareSurPass Project HL7 FHIR Implementation Guide v0.2.0

PanCareSurPass Project HL7 FHIR Implementation Guide
0.2.0 - CI Build 150

PanCareSurPass Project HL7 FHIR Implementation Guide, published by PanCareSurPass Project. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/pcsp/ and changes regularly. See the Directory of published versions

Extension: RadiotherapyEnergyOrIsotope - Detailed Descriptions

Draft as of 2024-12-11

Definitions for the 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.eu/fhir/ig/pcsp/StructureDefinition/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	SeeChoice of Data Typesfor further information about how to use [x]
Slicing	This element introduces a set of slices on `Extension.value[x]`. The slices areUnordered 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 dose units (required to `http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseUnit-eu-pcsp`)
Type	Quantity(SimpleQuantity)
[x] Note	SeeChoice of Data Typesfor further information about how to use [x]
10. 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 Isotopes (extensible to `http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-isotopes-eu-pcsp`)
Type	CodeableConcept
[x] Note	SeeChoice of Data Typesfor 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 areUnordered 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.eu/fhir/ig/pcsp/StructureDefinition/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	SeeChoice of Data Typesfor 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 areUnordered 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 dose units (required to `http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseUnit-eu-pcsp`)
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	SeeChoice of Data Typesfor 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]: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 Isotopes (extensible to `http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-isotopes-eu-pcsp`)
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	SeeChoice of Data Typesfor 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 areUnordered 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.eu/fhir/ig/pcsp/StructureDefinition/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	SeeChoice of Data Typesfor 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 areUnordered 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 dose units (required to `http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-radiotherapyDoseUnit-eu-pcsp`)
Type	Quantity(SimpleQuantity)
[x] Note	SeeChoice of Data Typesfor 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]: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 Isotopes (extensible to `http://hl7.eu/fhir/ig/pcsp/ValueSet/vs-isotopes-eu-pcsp`)
Type	CodeableConcept
[x] Note	SeeChoice of Data Typesfor 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())`)

Links: Table of Contents | QA Report

The PanCareSurPass Research and Innovation Action has received funding from the European Union's Horizon 2020
research and innovation programme under grant agreement No. 899999.