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: Radiobiologic Metric

Official URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiobiologic-metric Version: 2.0.0
Standards status: Trial-use Active as of 2026-01-27 Computable Name: RadiobiologicMetric
Other Identifiers: OID:2.16.840.1.113883.4.642.40.14.42.4

Extension providing radiobiologic dose metric using a regular expression: BED, CGE, RBE, RBE(factor = <decimal>), EQD2Gy, EQD2Gy(a/b = <decimal>).

Context of Use

Usage

This extension is used to capture the radiobiologic metric of effective dose, as defined by the TG-263 in section 9.2 of AAPM Task Group 263 Report on Standardizing Nomenclatures in Radiation Oncology. The following metrics are supported:

  • CGE - Cobalt Gray Equivalent
  • BED - Biological Effective Dose
  • BED(a/b=<decimal>) - BED with alpha/beta
  • RBE - Relative Biological Effectiveness corrected dose
  • RBE(factor=<decimal>) - RBE with factor
  • EQD2Gy - Equivalent Dose in 2 Gy per Fraction
  • EQD2Gy(a/b=<decimal>) - EQD2Gy with alpha/beta

The units are assumed to be Gy.

Conformance

One of the above metrics SHOULD be used. Use of other metrics will generate a warning.

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 Radiotherapy Biologically Effective Dose
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiobiologic-metric"
... value[x] 1..1 Quantity Value of extension
.... value 1..1 decimal Numerical value (with implicit precision)
.... unit C 1..1 string Unit representation
Constraints: TG263RadiobiologicMetric

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
TG263RadiobiologicMetric warning Extension.value[x].unit Unit SHOULD match TG-263 Radiobiologic Metric Regexp $this.toString().matches('^(BED|CGE|RBE|RBE\\(factor\\s*=\\s*(\\d?(\\.\\d+)?)\\)|EQD2Gy|EQD2Gy\\(a\\/b\\s*=\\s*(\\d?(\\.\\d+)?)\\))$')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Radiotherapy Biologically Effective 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 "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiobiologic-metric"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit ΣC 1..1 string Unit representation
Constraints: TG263RadiobiologicMetric
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
TG263RadiobiologicMetric warning Extension.value[x].unit Unit SHOULD match TG-263 Radiobiologic Metric Regexp $this.toString().matches('^(BED|CGE|RBE|RBE\\(factor\\s*=\\s*(\\d?(\\.\\d+)?)\\)|EQD2Gy|EQD2Gy\\(a\\/b\\s*=\\s*(\\d?(\\.\\d+)?)\\))$')
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

Simple Extension with the type Quantity: Extension providing radiobiologic dose metric using a regular expression: BED, CGE, RBE, RBE(factor = <decimal>), EQD2Gy, EQD2Gy(a/b = <decimal>).

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Radiotherapy Biologically Effective Dose
... extension 0..0 Extension
... url 1..1 uri "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiobiologic-metric"
... value[x] 1..1 Quantity Value of extension
.... value 1..1 decimal Numerical value (with implicit precision)
.... unit C 1..1 string Unit representation
Constraints: TG263RadiobiologicMetric

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
TG263RadiobiologicMetric warning Extension.value[x].unit Unit SHOULD match TG-263 Radiobiologic Metric Regexp $this.toString().matches('^(BED|CGE|RBE|RBE\\(factor\\s*=\\s*(\\d?(\\.\\d+)?)\\)|EQD2Gy|EQD2Gy\\(a\\/b\\s*=\\s*(\\d?(\\.\\d+)?)\\))$')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Radiotherapy Biologically Effective 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 "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiobiologic-metric"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value Σ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit ΣC 1..1 string Unit representation
Constraints: TG263RadiobiologicMetric
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.value[x].comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
TG263RadiobiologicMetric warning Extension.value[x].unit Unit SHOULD match TG-263 Radiobiologic Metric Regexp $this.toString().matches('^(BED|CGE|RBE|RBE\\(factor\\s*=\\s*(\\d?(\\.\\d+)?)\\)|EQD2Gy|EQD2Gy\\(a\\/b\\s*=\\s*(\\d?(\\.\\d+)?)\\))$')
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

Simple Extension with the type Quantity: Extension providing radiobiologic dose metric using a regular expression: BED, CGE, RBE, RBE(factor = <decimal>), EQD2Gy, EQD2Gy(a/b = <decimal>).

 

Other representations of profile: CSV, Excel, Schematron