This page is part of the CodeX™ Radiation Therapy (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treated-plan |
Version: | 1.0.0-ballot |
Name: | RadiotherapyTreatedPlan |
Title: | Radiotherapy Treated Plan |
Status: | Draft as of 2022-08-08 02:42:13+0000 |
Definition: | A summary of Radiotherapy treatment delivered with a single Radiotherapy Treatment Plan. |
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-treated-plan
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreProcedureProfile
Summary
Mandatory: 1 element
Must-Support: 11 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
This structure is derived from USCoreProcedureProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | I | 0..* | USCoreProcedureProfile | An action that is being or was performed on a patient codexrt-procedure-status: Only the following status values are supported for Radiotherapy Summaries: in-progress | not-done | on-hold | stopped | completed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
modalityAndTechnique | S | 0..1 | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique |
radiotherapyEnergyOrIsotope | S | 0..* | SimpleQuantity | Radiotherapy Energy or Isotope URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope Binding: Unit to characterize Energy in Radiotherapy (required) |
radiotherapyTreatmentDevice | S | 0..* | (Complex) | Treatment Device URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device |
radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-applicator-type Binding: Brachytherapy Applicator Types (extensible) |
fractionsDelivered | S | 0..1 | unsignedInt | Number of Fractions Delivered URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-delivered |
doseDeliveredToVolume | S | 0..* | (Complex) | Radiotherapy Dose Delivered To Volume Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume |
extension:totalDoseDelivered | 0..1 | Extension | Extension | |
extension:fractionsDelivered | 0..0 | |||
radiotherapy-dicom-record | 0..* | (Complex) | DICOM Treatment Record URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |
basedOn | S | 0..* | Reference(CarePlan | ServiceRequest) | Should Reference a Radiotherapy Treatment Plan |
partOf | S | 0..* | Reference(Radiotherapy Treated Phase | Radiotherapy Course Summary) | Part of referenced event |
category | 0..1 | CodeableConcept | Classification of the procedure Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108290001 | |
code | 1..1 | CodeableConcept | Identification of the procedure Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33951 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Plan (therapy/regime) | |
subject | 1..1 | Reference(Cancer Patient Profile) | Who the procedure was performed on | |
performed[x] | 1..1 | Period | When the procedure was performed Slice: Unordered, Open by type:$this | |
performedPeriod | 1..1 | Period | When the procedure was performed | |
start | S | 0..1 | dateTime | The date and time when the first therapeutic radiation was delivered. |
end | S | 0..1 | dateTime | An end date is expected if the status is 'stopped' or 'completed' |
reasonCode | S | 0..* | CodeableConcept | Coded reason procedure performed Binding: Cancer Disorder Value Set (extensible) |
bodySite | 0..* | CodeableConcept | All body structure(s) treated with this plan Binding: Radiotherapy Treatment Location Value Set (required) | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Procedure | I | 0..* | USCoreProcedureProfile | An action that is being or was performed on a patient codexrt-procedure-status: Only the following status values are supported for Radiotherapy Summaries: in-progress | not-done | on-hold | stopped | completed | ||||
id | Σ | 0..1 | string | 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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
modalityAndTechnique | SI | 0..1 | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
modality | S | 1..1 | CodeableConcept | Radiotherapy Modality Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Radiotherapy Modality Value Set (required) | |||||
technique | S | 0..* | CodeableConcept | Radiotherapy Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Radiotherapy Technique Value Set (required) | |||||
radiotherapyEnergyOrIsotope | S | 0..* | SimpleQuantity | Radiotherapy Energy or Isotope URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope Binding: Unit to characterize Energy in Radiotherapy (required) | ||||
radiotherapyTreatmentDevice | S | 0..* | (Complex) | Treatment Device URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device | ||||
radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-applicator-type Binding: Brachytherapy Applicator Types (extensible) | ||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique" | |||||
fractionsDelivered | S | 0..1 | unsignedInt | Number of Fractions Delivered URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-delivered | ||||
doseDeliveredToVolume | S | 0..* | (Complex) | Radiotherapy Dose Delivered To Volume Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:volume | S | 1..1 | Extension | Volume in the body where radiation was delivered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "volume" | |||||
value[x] | 0..1 | Reference(Radiotherapy Volume Profile) | Value of extension | |||||
extension:totalDoseDelivered | S | 0..1 | Extension | Extension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "totalDoseDelivered" | |||||
Slices for value[x] | 0..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueQuantity | 0..1 | Quantity | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
unit | 0..1 | string | Unit representation | |||||
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
code | 1..1 | code | Coded form of the unit Fixed Value: cGy | |||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume" | |||||
radiotherapy-dicom-record | 0..* | (Complex) | DICOM Treatment Record URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | Should Reference a Radiotherapy Treatment Plan | ||||
partOf | SΣ | 0..* | Reference(Radiotherapy Treated Phase | Radiotherapy Course Summary) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108290001 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
code | SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33951 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Plan (therapy/regime) | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who the procedure was performed on | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
Slices for performed[x] | SΣ | 1..1 | Period | When the procedure was performed Slice: Unordered, Closed by type:$this | ||||
performed[x]:performedPeriod | SΣ | 1..1 | Period | When the procedure was performed | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣI | 0..1 | dateTime | The date and time when the first therapeutic radiation was delivered. | ||||
end | SΣI | 0..1 | dateTime | An end date is expected if the status is 'stopped' or 'completed' | ||||
recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
performer | Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | ||||
onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
location | Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: Cancer Disorder Value Set (extensible) | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
bodySite | Σ | 0..* | CodeableConcept | All body structure(s) treated with this plan Binding: Radiotherapy Treatment Location Value Set (required) | ||||
outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
note | 0..* | Annotation | Additional information about the procedure | |||||
focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
manipulated | 1..1 | Reference(Device) | Device that was changed | |||||
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
Documentation for this format |
This structure is derived from USCoreProcedureProfile
Summary
Mandatory: 1 element
Must-Support: 11 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from USCoreProcedureProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Procedure | I | 0..* | USCoreProcedureProfile | An action that is being or was performed on a patient codexrt-procedure-status: Only the following status values are supported for Radiotherapy Summaries: in-progress | not-done | on-hold | stopped | completed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
modalityAndTechnique | S | 0..1 | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique |
radiotherapyEnergyOrIsotope | S | 0..* | SimpleQuantity | Radiotherapy Energy or Isotope URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope Binding: Unit to characterize Energy in Radiotherapy (required) |
radiotherapyTreatmentDevice | S | 0..* | (Complex) | Treatment Device URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device |
radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-applicator-type Binding: Brachytherapy Applicator Types (extensible) |
fractionsDelivered | S | 0..1 | unsignedInt | Number of Fractions Delivered URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-delivered |
doseDeliveredToVolume | S | 0..* | (Complex) | Radiotherapy Dose Delivered To Volume Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume |
extension:totalDoseDelivered | 0..1 | Extension | Extension | |
extension:fractionsDelivered | 0..0 | |||
radiotherapy-dicom-record | 0..* | (Complex) | DICOM Treatment Record URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |
basedOn | S | 0..* | Reference(CarePlan | ServiceRequest) | Should Reference a Radiotherapy Treatment Plan |
partOf | S | 0..* | Reference(Radiotherapy Treated Phase | Radiotherapy Course Summary) | Part of referenced event |
category | 0..1 | CodeableConcept | Classification of the procedure Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108290001 | |
code | 1..1 | CodeableConcept | Identification of the procedure Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33951 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Plan (therapy/regime) | |
subject | 1..1 | Reference(Cancer Patient Profile) | Who the procedure was performed on | |
performed[x] | 1..1 | Period | When the procedure was performed Slice: Unordered, Open by type:$this | |
performedPeriod | 1..1 | Period | When the procedure was performed | |
start | S | 0..1 | dateTime | The date and time when the first therapeutic radiation was delivered. |
end | S | 0..1 | dateTime | An end date is expected if the status is 'stopped' or 'completed' |
reasonCode | S | 0..* | CodeableConcept | Coded reason procedure performed Binding: Cancer Disorder Value Set (extensible) |
bodySite | 0..* | CodeableConcept | All body structure(s) treated with this plan Binding: Radiotherapy Treatment Location Value Set (required) | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Procedure | I | 0..* | USCoreProcedureProfile | An action that is being or was performed on a patient codexrt-procedure-status: Only the following status values are supported for Radiotherapy Summaries: in-progress | not-done | on-hold | stopped | completed | ||||
id | Σ | 0..1 | string | 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 | |||||
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
modalityAndTechnique | SI | 0..1 | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
modality | S | 1..1 | CodeableConcept | Radiotherapy Modality Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Radiotherapy Modality Value Set (required) | |||||
technique | S | 0..* | CodeableConcept | Radiotherapy Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique" | |||||
value[x] | 1..1 | CodeableConcept | Value of extension Binding: Radiotherapy Technique Value Set (required) | |||||
radiotherapyEnergyOrIsotope | S | 0..* | SimpleQuantity | Radiotherapy Energy or Isotope URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-energy-or-isotope Binding: Unit to characterize Energy in Radiotherapy (required) | ||||
radiotherapyTreatmentDevice | S | 0..* | (Complex) | Treatment Device URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device | ||||
radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-applicator-type Binding: Brachytherapy Applicator Types (extensible) | ||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique" | |||||
fractionsDelivered | S | 0..1 | unsignedInt | Number of Fractions Delivered URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-delivered | ||||
doseDeliveredToVolume | S | 0..* | (Complex) | Radiotherapy Dose Delivered To Volume Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
extension:volume | S | 1..1 | Extension | Volume in the body where radiation was delivered | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "volume" | |||||
value[x] | 0..1 | Reference(Radiotherapy Volume Profile) | Value of extension | |||||
extension:totalDoseDelivered | S | 0..1 | Extension | Extension | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "totalDoseDelivered" | |||||
Slices for value[x] | 0..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueQuantity | 0..1 | Quantity | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
value | 0..1 | decimal | Numerical value (with implicit precision) | |||||
comparator | 0..1 | code | < | <= | >= | > - how to understand the value | |||||
unit | 0..1 | string | Unit representation | |||||
system | 1..1 | uri | System that defines coded unit form Fixed Value: http://unitsofmeasure.org | |||||
code | 1..1 | code | Coded form of the unit Fixed Value: cGy | |||||
url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-dose-delivered-to-volume" | |||||
radiotherapy-dicom-record | 0..* | (Complex) | DICOM Treatment Record URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 0..* | Identifier | External Identifiers for this procedure | ||||
instantiatesCanonical | Σ | 0..* | canonical(PlanDefinition | ActivityDefinition | Measure | OperationDefinition | Questionnaire) | Instantiates FHIR protocol or definition | ||||
instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
basedOn | SΣ | 0..* | Reference(CarePlan | ServiceRequest) | Should Reference a Radiotherapy Treatment Plan | ||||
partOf | SΣ | 0..* | Reference(Radiotherapy Treated Phase | Radiotherapy Course Summary) | Part of referenced event | ||||
status | ?!SΣ | 1..1 | code | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown Binding: EventStatus (required) | ||||
statusReason | Σ | 0..1 | CodeableConcept | Reason for current status Binding: ProcedureNotPerformedReason(SNOMED-CT) (example): A code that identifies the reason a procedure was not performed. | ||||
category | Σ | 0..1 | CodeableConcept | Classification of the procedure Binding: ProcedureCategoryCodes(SNOMEDCT) (example): A code that classifies a procedure for searching, sorting and display purposes. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 108290001 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
code | SΣ | 1..1 | CodeableConcept | Identification of the procedure Binding: US Core Procedure Codes (extensible): Codes describing the type of Procedure Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33951 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Plan (therapy/regime) | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
subject | SΣ | 1..1 | Reference(Cancer Patient Profile) | Who the procedure was performed on | ||||
encounter | Σ | 0..1 | Reference(Encounter) | Encounter created as part of | ||||
Slices for performed[x] | SΣ | 1..1 | Period | When the procedure was performed Slice: Unordered, Closed by type:$this | ||||
performed[x]:performedPeriod | SΣ | 1..1 | Period | When the procedure was performed | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
start | SΣI | 0..1 | dateTime | The date and time when the first therapeutic radiation was delivered. | ||||
end | SΣI | 0..1 | dateTime | An end date is expected if the status is 'stopped' or 'completed' | ||||
recorder | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Who recorded the procedure | ||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Person who asserts this procedure | ||||
performer | Σ | 0..* | BackboneElement | The people who performed the procedure | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | Type of performance Binding: ProcedurePerformerRoleCodes (example): A code that identifies the role of a performer of the procedure. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) | The reference to the practitioner | ||||
onBehalfOf | 0..1 | Reference(Organization) | Organization the device or practitioner was acting for | |||||
location | Σ | 0..1 | Reference(Location) | Where the procedure happened | ||||
reasonCode | SΣ | 0..* | CodeableConcept | Coded reason procedure performed Binding: Cancer Disorder Value Set (extensible) | ||||
reasonReference | Σ | 0..* | Reference(Condition | Observation | Procedure | DiagnosticReport | DocumentReference) | The justification that the procedure was performed | ||||
bodySite | Σ | 0..* | CodeableConcept | All body structure(s) treated with this plan Binding: Radiotherapy Treatment Location Value Set (required) | ||||
outcome | Σ | 0..1 | CodeableConcept | The result of procedure Binding: ProcedureOutcomeCodes(SNOMEDCT) (example): An outcome of a procedure - whether it was resolved or otherwise. | ||||
report | 0..* | Reference(DiagnosticReport | DocumentReference | Composition) | Any report resulting from the procedure | |||||
complication | 0..* | CodeableConcept | Complication following the procedure Binding: Condition/Problem/DiagnosisCodes (example): Codes describing complications that resulted from a procedure. | |||||
complicationDetail | 0..* | Reference(Condition) | A condition that is a result of the procedure | |||||
followUp | 0..* | CodeableConcept | Instructions for follow up Binding: ProcedureFollowUpCodes(SNOMEDCT) (example): Specific follow up required for a procedure e.g. removal of sutures. | |||||
note | 0..* | Annotation | Additional information about the procedure | |||||
focalDevice | 0..* | BackboneElement | Manipulated, implanted, or removed device | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
action | 0..1 | CodeableConcept | Kind of change to device Binding: ProcedureDeviceActionCodes (preferred): A kind of change that happened to the device during the procedure. | |||||
manipulated | 1..1 | Reference(Device) | Device that was changed | |||||
usedReference | 0..* | Reference(Device | Medication | Substance) | Items used during procedure | |||||
usedCode | 0..* | CodeableConcept | Coded items used during the procedure Binding: FHIRDeviceTypes (example): Codes describing items used during a procedure. | |||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet / Code |
Procedure.language | preferred | CommonLanguages Max Binding: AllLanguages |
Procedure.extension:modalityAndTechnique.extension:modality.value[x] | required | RadiotherapyModalityVS |
Procedure.extension:modalityAndTechnique.extension:technique.value[x] | required | RadiotherapyTechniqueVS |
Procedure.status | required | EventStatus |
Procedure.statusReason | example | ProcedureNotPerformedReason(SNOMED-CT) |
Procedure.category | example | Pattern: SNOMED CT code 108290001 |
Procedure.code | extensible | Pattern: USCRS-33951("Radiotherapy Treatment Plan (therapy/regime)") |
Procedure.performer.function | example | ProcedurePerformerRoleCodes |
Procedure.reasonCode | extensible | CancerDisorderVS |
Procedure.bodySite | required | RadiotherapyTreatmentLocationVS |
Procedure.outcome | example | ProcedureOutcomeCodes(SNOMEDCT) |
Procedure.complication | example | Condition/Problem/DiagnosisCodes |
Procedure.followUp | example | ProcedureFollowUpCodes(SNOMEDCT) |
Procedure.focalDevice.action | preferred | ProcedureDeviceActionCodes |
Procedure.usedCode | example | FHIRDeviceTypes |
Id | Grade | Path | Details | Requirements |
codexrt-procedure-status | error | Procedure | Only the following status values are supported for Radiotherapy Summaries: in-progress | not-done | on-hold | stopped | completed : status = 'in-progress' or status = 'not-done' or status = 'on-hold' or status = 'stopped' or status = 'completed' |