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
Official URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume | Version: 2.0.0 | |||
Draft as of 2024-12-18 | Computable Name: RadiotherapyVolume | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.14.42.39 |
A volume of the body used in radiotherapy planning or treatment delivery. This corresponds to the Conceptual Volume in DICOM.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RadiotherapyVolume
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | 0..* | RadiotherapyVolume | Specific and identified anatomical structure | |
Slices for identifier | 2..* | Identifier | Volume Identifier Slice: Unordered, Open by value:use | |
identifier:displayName | 1..1 | Identifier | Bodystructure identifier | |
identifier:dicomUid | S | 1..1 | Identifier | Volume Identifier |
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
value | S | 1..1 | string | The value that is unique |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | C | 0..* | RadiotherapyVolume | Specific and identified anatomical structure dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mcode-description-or-id-required: One of description or identifier MUST be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | SΣ | 2..* | Identifier | Volume Identifier Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
identifier:displayName | SΣ | 1..1 | Identifier | Bodystructure identifier ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: usual |
value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
identifier:dicomUid | SΣ | 1..1 | Identifier | Volume Identifier ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: official |
system | Σ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:dicom:uid |
value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this record is in active use ele-1: All FHIR elements must have a @value or children |
morphology | SΣ | 0..1 | CodeableConcept | Type of Radiotherapy Volume Binding: Radiotherapy Volume Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
location | SΣ | 0..1 | CodeableConcept | Body Location Code. Binding: Radiotherapy Treatment Location Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
locationQualifier | S | 0..* | CodeableConcept | Qualifiers on location used to specify a TG263 body structure comprising the irradiated volume. Binding: Radiotherapy Treatment Location Qualifier Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
description | SΣ | 0..1 | string | Volume Description ele-1: All FHIR elements must have a @value or children |
patient | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who this is about ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
BodyStructure.identifier:displayName.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
BodyStructure.identifier:dicomUid.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
BodyStructure.morphology | extensible | RadiotherapyVolumeTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-volume-type-vs | |
BodyStructure.location | extensible | RadiotherapyTreatmentLocationVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-vs | |
BodyStructure.locationQualifier | extensible | RadiotherapyTreatmentLocationQualifierVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-qualifier-vs |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
BodyStructure | C | 0..* | RadiotherapyVolume | Specific and identified anatomical structure mcode-description-or-id-required: One of description or identifier MUST be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 2..* | Identifier | Volume Identifier Slice: Unordered, Open by value:use | ||||
identifier:displayName | SΣ | 1..1 | Identifier | Bodystructure identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:dicomUid | SΣ | 1..1 | Identifier | Volume Identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this record is in active use | ||||
morphology | SΣ | 0..1 | CodeableConcept | Type of Radiotherapy Volume Binding: Radiotherapy Volume Type Value Set (extensible) | ||||
location | SΣ | 0..1 | CodeableConcept | Body Location Code. Binding: Radiotherapy Treatment Location Value Set (extensible) | ||||
locationQualifier | S | 0..* | CodeableConcept | Qualifiers on location used to specify a TG263 body structure comprising the irradiated volume. Binding: Radiotherapy Treatment Location Qualifier Value Set (extensible) | ||||
description | SΣ | 0..1 | string | Volume Description | ||||
image | 0..* | Attachment | Attached images | |||||
patient | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who this is about | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
BodyStructure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
BodyStructure.identifier:displayName.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
BodyStructure.identifier:displayName.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
BodyStructure.identifier:dicomUid.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
BodyStructure.identifier:dicomUid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
BodyStructure.morphology | extensible | RadiotherapyVolumeTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-volume-type-vs | ||||
BodyStructure.location | extensible | RadiotherapyTreatmentLocationVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-vs | ||||
BodyStructure.locationQualifier | extensible | RadiotherapyTreatmentLocationQualifierVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-qualifier-vs |
This structure is derived from RadiotherapyVolume
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from RadiotherapyVolume
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | 0..* | RadiotherapyVolume | Specific and identified anatomical structure | |
Slices for identifier | 2..* | Identifier | Volume Identifier Slice: Unordered, Open by value:use | |
identifier:displayName | 1..1 | Identifier | Bodystructure identifier | |
identifier:dicomUid | S | 1..1 | Identifier | Volume Identifier |
use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
system | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | |
value | S | 1..1 | string | The value that is unique |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
BodyStructure | C | 0..* | RadiotherapyVolume | Specific and identified anatomical structure dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management mcode-description-or-id-required: One of description or identifier MUST be present |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
Slices for identifier | SΣ | 2..* | Identifier | Volume Identifier Slice: Unordered, Open by value:use ele-1: All FHIR elements must have a @value or children |
identifier:displayName | SΣ | 1..1 | Identifier | Bodystructure identifier ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: usual |
value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
identifier:dicomUid | SΣ | 1..1 | Identifier | Volume Identifier ele-1: All FHIR elements must have a @value or children |
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children Required Pattern: official |
system | Σ | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: urn:dicom:uid |
value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 |
active | ?!Σ | 0..1 | boolean | Whether this record is in active use ele-1: All FHIR elements must have a @value or children |
morphology | SΣ | 0..1 | CodeableConcept | Type of Radiotherapy Volume Binding: Radiotherapy Volume Type Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
location | SΣ | 0..1 | CodeableConcept | Body Location Code. Binding: Radiotherapy Treatment Location Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
locationQualifier | S | 0..* | CodeableConcept | Qualifiers on location used to specify a TG263 body structure comprising the irradiated volume. Binding: Radiotherapy Treatment Location Qualifier Value Set (extensible) ele-1: All FHIR elements must have a @value or children |
description | SΣ | 0..1 | string | Volume Description ele-1: All FHIR elements must have a @value or children |
patient | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who this is about ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
BodyStructure.identifier:displayName.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
BodyStructure.identifier:dicomUid.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
BodyStructure.morphology | extensible | RadiotherapyVolumeTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-volume-type-vs | |
BodyStructure.location | extensible | RadiotherapyTreatmentLocationVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-vs | |
BodyStructure.locationQualifier | extensible | RadiotherapyTreatmentLocationQualifierVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-qualifier-vs |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
BodyStructure | C | 0..* | RadiotherapyVolume | Specific and identified anatomical structure mcode-description-or-id-required: One of description or identifier MUST be present | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
Slices for identifier | SΣ | 2..* | Identifier | Volume Identifier Slice: Unordered, Open by value:use | ||||
identifier:displayName | SΣ | 1..1 | Identifier | Bodystructure identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: usual | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
identifier:dicomUid | SΣ | 1..1 | Identifier | Volume Identifier | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: urn:dicom:uid | ||||
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
active | ?!Σ | 0..1 | boolean | Whether this record is in active use | ||||
morphology | SΣ | 0..1 | CodeableConcept | Type of Radiotherapy Volume Binding: Radiotherapy Volume Type Value Set (extensible) | ||||
location | SΣ | 0..1 | CodeableConcept | Body Location Code. Binding: Radiotherapy Treatment Location Value Set (extensible) | ||||
locationQualifier | S | 0..* | CodeableConcept | Qualifiers on location used to specify a TG263 body structure comprising the irradiated volume. Binding: Radiotherapy Treatment Location Qualifier Value Set (extensible) | ||||
description | SΣ | 0..1 | string | Volume Description | ||||
image | 0..* | Attachment | Attached images | |||||
patient | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who this is about | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
BodyStructure.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
BodyStructure.identifier:displayName.use | required | Pattern: usualhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
BodyStructure.identifier:displayName.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
BodyStructure.identifier:dicomUid.use | required | Pattern: officialhttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
BodyStructure.identifier:dicomUid.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
BodyStructure.morphology | extensible | RadiotherapyVolumeTypeVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-volume-type-vs | ||||
BodyStructure.location | extensible | RadiotherapyTreatmentLocationVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-vs | ||||
BodyStructure.locationQualifier | extensible | RadiotherapyTreatmentLocationQualifierVShttp://hl7.org/fhir/us/mcode/ValueSet/mcode-radiotherapy-treatment-location-qualifier-vs |
This structure is derived from RadiotherapyVolume
Summary
Mandatory: 4 elements
Must-Support: 2 elements
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron