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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: Radiotherapy Volume

A volume of the body used in radiotherapy planning or treatment delivery. This corresponds to the Conceptual Volume in DICOM.

Usages:

• Refer to this Profile: Dose Planned to Volume, Dose Prescribed to Volume and Radiotherapy Volume Extension
• Examples for this Profile: BodyStructure/RadiotherapyVolume-02-PTV64, BodyStructure/RadiotherapyVolume-03-Prostate, BodyStructure/RadiotherapyVolume-04-PelvNs, BodyStructure/RadiotherapyVolume-05-SemVs... Show 16 more, BodyStructure/RadiotherapyVolume-101-LeftBreast, BodyStructure/RadiotherapyVolume-102-LeftBreastBoost, BodyStructure/RadiotherapyVolume-103-RightBreast, BodyStructure/RadiotherapyVolume-XRTS-01-22B-01-Prostate, BodyStructure/RadiotherapyVolume-XRTS-02-22B-01-Prostate, BodyStructure/RadiotherapyVolume-XRTS-03-22B-01-Prostate, BodyStructure/RadiotherapyVolume-XRTS-03-22B-02-PelvNs, BodyStructure/RadiotherapyVolume-XRTS-03-22B-03-SemVs, BodyStructure/RadiotherapyVolume-XRTS-04-22B-01-LeftBreast, BodyStructure/RadiotherapyVolume-XRTS-04-22B-02-LeftBreastBoost, BodyStructure/RadiotherapyVolume-XRTS-04-22B-03-RightBreast, BodyStructure/RadiotherapyVolume-XRTS-05-22B-01-BrainMets, BodyStructure/RadiotherapyVolume-XRTS-05-22B-02-BrainMets, BodyStructure/RadiotherapyVolume-XRTS-06-22B-01-Uterus, BodyStructure/RadiotherapyVolume-XRTS-07-22B-01-Uterus and BodyStructure/radiotherapyVolume-01-PTV50
• CapabilityStatements using this Profile: CodeX RT Server CapabilityStatement

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
BodyStructure	C	0..*	RadiotherapyVolume	Specific and identified anatomical structure Constraints: mcode-description-or-id-required
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
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
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:dicomUid	SΣ	1..1	Identifier	Volume Identifier
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
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
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
patient	SΣ	1..1	Reference(Cancer Patient Profile)	Who this is about
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
BodyStructure.identifier:displayName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.identifier:dicomUid.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.morphology	Base	extensible	Radiotherapy Volume Type Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.location	Base	extensible	Radiotherapy Treatment Location Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.locationQualifier	Base	extensible	Radiotherapy Treatment Location Qualifier Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	BodyStructure	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	BodyStructure	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	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	BodyStructure	A resource should have narrative for robust management	text.`div`.exists()
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()
mcode-description-or-id-required	error	BodyStructure	One of description or identifier MUST be present	description.exists() or identifier.exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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    Filter: Bindings Constraints Obligations
BodyStructure	C	0..*	RadiotherapyVolume	Specific and identified anatomical structure Constraints: mcode-description-or-id-required
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
BodyStructure.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
BodyStructure.identifier:displayName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.identifier:displayName.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
BodyStructure.identifier:dicomUid.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.identifier:dicomUid.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
BodyStructure.morphology	Base	extensible	Radiotherapy Volume Type Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.location	Base	extensible	Radiotherapy Treatment Location Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.locationQualifier	Base	extensible	Radiotherapy Treatment Location Qualifier Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	BodyStructure	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	BodyStructure	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	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	BodyStructure	A resource should have narrative for robust management	text.`div`.exists()
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()
mcode-description-or-id-required	error	BodyStructure	One of description or identifier MUST be present	description.exists() or identifier.exists()

Summary

Mandatory: 4 elements
Must-Support: 2 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of BodyStructure.identifier

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
BodyStructure	C	0..*	RadiotherapyVolume	Specific and identified anatomical structure Constraints: mcode-description-or-id-required
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
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
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
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:dicomUid	SΣ	1..1	Identifier	Volume Identifier
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
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
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
patient	SΣ	1..1	Reference(Cancer Patient Profile)	Who this is about
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
BodyStructure.identifier:displayName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.identifier:dicomUid.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.morphology	Base	extensible	Radiotherapy Volume Type Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.location	Base	extensible	Radiotherapy Treatment Location Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.locationQualifier	Base	extensible	Radiotherapy Treatment Location Qualifier Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	BodyStructure	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	BodyStructure	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	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	BodyStructure	A resource should have narrative for robust management	text.`div`.exists()
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()
mcode-description-or-id-required	error	BodyStructure	One of description or identifier MUST be present	description.exists() or identifier.exists()

Differential View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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

Snapshot ViewView

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
BodyStructure	C	0..*	RadiotherapyVolume	Specific and identified anatomical structure Constraints: mcode-description-or-id-required
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. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
BodyStructure.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
BodyStructure.identifier:displayName.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.identifier:displayName.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
BodyStructure.identifier:dicomUid.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
BodyStructure.identifier:dicomUid.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
BodyStructure.morphology	Base	extensible	Radiotherapy Volume Type Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.location	Base	extensible	Radiotherapy Treatment Location Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0
BodyStructure.locationQualifier	Base	extensible	Radiotherapy Treatment Location Qualifier Value Set	📦4.0.0	minimal Common Oncology Data Elements v4.0

Constraints

Id	Grade	Path(s)	Description	Expression
dom-2	error	BodyStructure	If the resource is contained in another resource, it SHALL NOT contain nested Resources	contained.contained.empty()
dom-3	error	BodyStructure	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	contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated	contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	BodyStructure	If a resource is contained in another resource, it SHALL NOT have a security label	contained.meta.security.empty()
dom-6	best practice	BodyStructure	A resource should have narrative for robust management	text.`div`.exists()
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()
mcode-description-or-id-required	error	BodyStructure	One of description or identifier MUST be present	description.exists() or identifier.exists()

Summary

Mandatory: 4 elements
Must-Support: 2 elements

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of BodyStructure.identifier

Other representations of profile: CSV, Excel, Schematron