CodeX™ Radiation Therapy
1.0.0-ballot - ci-build

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

Resource Profile: Radiotherapy Volume

Defining URL:http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume
Version:1.0.0-ballot
Name:RadiotherapyVolume
Title:Radiotherapy Volume
Status:Draft as of 2022-08-08 02:42:13+0000
Definition:

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

Publisher:HL7 Cross Group Projects Work Group
Source Resource:XML / JSON / Turtle

The official URL for this profile is: 

http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-volume

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from RadiotherapyVolume

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Slices

This structure defines the following Slices:

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

This structure is derived from RadiotherapyVolume

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..*RadiotherapyVolumeSpecific and identified anatomical structure
... Slices for identifier 2..*IdentifierVolume Identifier
Slice: Unordered, Open by value:use
.... identifier:dicomUid S1..1IdentifierVolume Identifier
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 0..1uriThe namespace for the identifier value
Required Pattern: urn:dicom:uid
..... value S1..1stringThe value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure I0..*RadiotherapyVolumeSpecific and identified anatomical structure
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ2..*IdentifierVolume Identifier
Slice: Unordered, Open by value:use
.... identifier:displayName SΣ0..1IdentifierBodystructure identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dicomUid SΣ1..1IdentifierVolume Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Required Pattern: urn:dicom:uid
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this record is in active use
... morphology SΣ0..1CodeableConceptType of Radiotherapy Volume
Binding: Radiotherapy Volume Type Value Set (extensible)
... location SΣ0..1CodeableConceptBody Location Code.
Binding: Radiotherapy Treatment Location Value Set (required)
... locationQualifier S0..*CodeableConceptQualifiers on location used to specify a TG263 body structure comprising the irradiated volume.
Binding: Radiotherapy Treatment Location Qualifier Value Set (required)
... description SΣ0..1stringVolume Description
... image 0..*AttachmentAttached images
... patient SΣ1..1Reference(Cancer Patient Profile)Who this is about

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure I0..*RadiotherapyVolumeSpecific and identified anatomical structure
... Slices for identifier Σ2..*IdentifierVolume Identifier
Slice: Unordered, Open by value:use
.... identifier:displayName Σ0..1IdentifierBodystructure identifier
..... value Σ1..1stringThe value that is unique
.... identifier:dicomUid Σ1..1IdentifierVolume Identifier
..... value Σ1..1stringThe value that is unique
... morphology Σ0..1CodeableConceptType of Radiotherapy Volume
Binding: Radiotherapy Volume Type Value Set (extensible)
... location Σ0..1CodeableConceptBody Location Code.
Binding: Radiotherapy Treatment Location Value Set (required)
... description Σ0..1stringVolume Description
... patient Σ1..1Reference(Cancer Patient Profile)Who this is about

doco Documentation for this format

This structure is derived from RadiotherapyVolume

Summary

Mandatory: 3 elements
Must-Support: 2 elements

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from RadiotherapyVolume

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure 0..*RadiotherapyVolumeSpecific and identified anatomical structure
... Slices for identifier 2..*IdentifierVolume Identifier
Slice: Unordered, Open by value:use
.... identifier:dicomUid S1..1IdentifierVolume Identifier
..... use 1..1codeusual | official | temp | secondary | old (If known)
Required Pattern: official
..... system 0..1uriThe namespace for the identifier value
Required Pattern: urn:dicom:uid
..... value S1..1stringThe value that is unique

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. BodyStructure I0..*RadiotherapyVolumeSpecific and identified anatomical structure
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for identifier SΣ2..*IdentifierVolume Identifier
Slice: Unordered, Open by value:use
.... identifier:displayName SΣ0..1IdentifierBodystructure identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: usual
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... identifier:dicomUid SΣ1..1IdentifierVolume Identifier
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ1..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


Required Pattern: official
..... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Required Pattern: urn:dicom:uid
..... value SΣ1..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!Σ0..1booleanWhether this record is in active use
... morphology SΣ0..1CodeableConceptType of Radiotherapy Volume
Binding: Radiotherapy Volume Type Value Set (extensible)
... location SΣ0..1CodeableConceptBody Location Code.
Binding: Radiotherapy Treatment Location Value Set (required)
... locationQualifier S0..*CodeableConceptQualifiers on location used to specify a TG263 body structure comprising the irradiated volume.
Binding: Radiotherapy Treatment Location Qualifier Value Set (required)
... description SΣ0..1stringVolume Description
... image 0..*AttachmentAttached images
... patient SΣ1..1Reference(Cancer Patient Profile)Who this is about

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
BodyStructure.languagepreferredCommonLanguages
Max Binding: AllLanguages
BodyStructure.identifier:displayName.userequiredPattern: usual
BodyStructure.identifier:displayName.typeextensibleIdentifier Type Codes
BodyStructure.identifier:dicomUid.userequiredPattern: official
BodyStructure.identifier:dicomUid.typeextensibleIdentifier Type Codes
BodyStructure.morphologyextensibleRadiotherapyVolumeTypeVS
BodyStructure.locationrequiredRadiotherapyTreatmentLocationVS
BodyStructure.locationQualifierrequiredRadiotherapyTreatmentLocationQualifierVS