CodeX Radiation Therapy
1.0.0 - STU 1
CodeX Radiation Therapy
1.0.0 - STU 1
This page is part of the CodeX™ Radiation Therapy (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-plan | Version: 1.0.0 | |||
| Draft as of 2023-07-28 | Computable Name: RadiotherapyTreatmentPlan | |||
A Radiotherapy Treatment Plan resource describes the radiotherapy treatment that is planned to be delivered with a single treatment plan.
This profile is used to represent a single radiotherapy treatment plan as elaborated in a radiotherapy treatment planning system. An overview of radiotherapy courses, phases, and treatment plans is shown here. In FHIR, treatment plans are represented as filler orders, and the corresponding prescriptions as original orders. The relationships between the various radiotherapy profiles are shown here.
ServiceRequest resource instances whose code is SNOMEDCT 1255724003 (Radiotherapy treatment plan (regime/therapy)) and whose intent is http://hl7.org/fhir/request-intent#filler-order “Filler Order” MUST conform to this profile. Any resource intended to conform to this profile SHOULD populate meta.profile accordingly.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed codexrt-motion-management-none: If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed. They would also be 'none' or contradict the 'none'. SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" codexrt-free-breathing-technique: The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing. SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" |
  Slices for extension | S | 1..* | 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: Radiotherapy Energy Unit Value Set (required) |
 radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-applicator-type Binding: Brachytherapy Applicator Type Value Set (extensible) |
| imageGuidedRadiotherapyModality | S | 0..* | (Complex) | Image Guided Radiotherapy Modality URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-image-guided-radiotherapy-modality |
| radiotherapyFractionsPlanned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned |
| radiotherapyDosePlannedToVolume | S | 0..* | (Complex) | Planned Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume |
| extension:fractions | 0..0 | |||
| pointDose | S | 0..1 | boolean | Point Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-point-dose |
| primaryPlanDose | S | 0..1 | boolean | Primary Plan Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose |
| radiotherapyReasonForRevisionOrAdaptation | S | 0..* | CodeableConcept | Reason for Revision or Adaptation URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision-or-adaptation Binding: Radiotherapy Reason for Revision or Adaptation Value Set (required) |
| respiratoryMotionManagement | S | 0..* | CodeableConcept | Respiratory Motion Management URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management Binding: Radiotherapy Respiratory Motion Management Value Set (required) |
| freeBreathingMotionManagementTechnique | S | 0..* | CodeableConcept | Free-Breathing Motion Management Technique URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique Binding: Radiotherapy Free-Breathing Motion Management Technique Value Set (required) |
| radiotherapyDicomPlan | 0..1 | (Complex) | DICOM Treatment Plan URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |
 Slices for identifier | S | 2..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:use |
 identifier:displayName | S | 1..1 | Identifier | The name that is displayed to the user. |
  use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
 identifier:official | S | 1..* | Identifier | A business identifier for the request or procedure, which is independent of its FHIR representation, such as a GUID or DICOM UID. |
 use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| Slices for basedOn | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills Slice: Unordered, Open by profile:$this.resolve() | |
 basedOn:plan-prescription | S | 0..1 | Reference(Radiotherapy Plan Prescription) | Radiotherapy Plan Prescription that this Treatment Plan fulfills. |
| basedOn:planned-phase | S | 0..1 | Reference(Radiotherapy Planned Phase) | Radiotherapy Planned Phase that this Treatment Plan fulfills (in most cases together with other treatment plans). |
 basedOn:planned-course | S | 0..1 | Reference(Radiotherapy Planned Course) | Radiotherapy Planned Course that this Treatment Plan fulfills (in most cases together with other treatment plans). |
 replaces | S | 0..* | Reference(Radiotherapy Treatment Plan) | Previous retired plan that is replaced by this plan |
| status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: filler-order |
| Slices for category | S | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this |
| category:required | 1..1 | CodeableConcept | Classification of service 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 | |
 display | 1..1 | string | Representation defined by the system Fixed Value: Radiation oncology AND/OR radiotherapy | |
| doNotPerform | 0..0 | |||
| code | S | 1..1 | CodeableConcept | What is being requested/ordered 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: 1255724003 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy treatment plan (regime/therapy) | |
| quantity[x] | 0..0 | |||
| subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
| asNeeded[x] | 0..0 | |||
| requester | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service | |
| Slices for performer | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer Slice: Unordered, Open by profile:$this.resolve() |
| performer:treatmentOrSeedDevice | S | 0..* | Reference(Radiotherapy Treatment Device | Radiotherapy Seed Device) | Radiotherapy Treatment Device or Seed Device used as part of therapy. |
| locationReference | S | 0..* | Reference(US Core Location Profile) | Requested location |
| reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) |
| reasonReference | S | 0..* | Reference(Condition) | Explanation/Justification for service or service |
| specimen | 0..0 | |||
| bodySite | S | 0..* | CodeableConcept | Body site that is treated with radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) |
| locationQualifier | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
| lateralityQualifier | 0..1 | CodeableConcept | Laterality qualifier for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.reasonCode | extensible | CancerDisorderVS |
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
| Id | Grade | Path(s) | Details | Requirements |
| codexrt-free-breathing-technique | error | ServiceRequest | The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing.
SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique') implies extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721071000124104' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) | |
| codexrt-motion-management-none | error | ServiceRequest | If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed.
They would also be 'none' or contradict the 'none'.
SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721031000124102' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) implies extension.where(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management').count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed codexrt-motion-management-none: If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed. They would also be 'none' or contradict the 'none'. SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" codexrt-free-breathing-technique: The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing. SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| modalityAndTechnique | SC | 0..1 | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique |
| 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 |
 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 |
| 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: Radiotherapy Energy Unit Value Set (required) |
| radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-applicator-type Binding: Brachytherapy Applicator Type Value Set (extensible) |
| url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique" | |
| imageGuidedRadiotherapyModality | SC | 0..* | (Complex) | Image Guided Radiotherapy Modality URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-image-guided-radiotherapy-modality |
| radiotherapyFractionsPlanned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned |
| radiotherapyDosePlannedToVolume | S | 0..* | (Complex) | Planned Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:volume | S | 1..1 | Extension | Volume targeted by the planned dose |
| extension | 0..0 | |||
| url | 1..1 | uri | "volume" | |
| value[x] | 1..1 | Reference(Radiotherapy Volume) | Value of extension | |
| extension:fractionDose | S | 0..1 | Extension | Radiation Dose Planned per Fraction |
| extension | 0..0 | |||
| url | 1..1 | uri | "fractionDose" | |
| extension:totalDose | S | 0..1 | Extension | Total Planned Radiation Dose |
| extension | 0..0 | |||
| url | 1..1 | uri | "totalDose" | |
| value[x] | 1..1 | Quantity | Value of extension Required Pattern: At least the following | |
| 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 | |
| pointDose | S | 0..1 | boolean | Point Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-point-dose |
| primaryPlanDose | S | 0..1 | boolean | Primary Plan Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose |
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume" | |
| radiotherapyReasonForRevisionOrAdaptation | S | 0..* | CodeableConcept | Reason for Revision or Adaptation URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision-or-adaptation Binding: Radiotherapy Reason for Revision or Adaptation Value Set (required) |
| respiratoryMotionManagement | S | 0..* | CodeableConcept | Respiratory Motion Management URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management Binding: Radiotherapy Respiratory Motion Management Value Set (required) |
| freeBreathingMotionManagementTechnique | S | 0..* | CodeableConcept | Free-Breathing Motion Management Technique URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique Binding: Radiotherapy Free-Breathing Motion Management Technique Value Set (required) |
| radiotherapyDicomPlan | 0..1 | (Complex) | DICOM Treatment Plan URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 2..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:use |
| identifier:displayName | SΣ | 1..1 | Identifier | The name that is displayed to the user. |
| 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 |
| system | SΣ | 1..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 |
| identifier:official | SΣ | 1..* | Identifier | A business identifier for the request or procedure, which is independent of its FHIR representation, such as a GUID or DICOM UID. |
| 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 | SΣ | 1..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 |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills Slice: Unordered, Open by profile:$this.resolve() |
| basedOn:plan-prescription | SΣ | 0..1 | Reference(Radiotherapy Plan Prescription) | Radiotherapy Plan Prescription that this Treatment Plan fulfills. |
| basedOn:planned-phase | SΣ | 0..1 | Reference(Radiotherapy Planned Phase) | Radiotherapy Planned Phase that this Treatment Plan fulfills (in most cases together with other treatment plans). |
| basedOn:planned-course | SΣ | 0..1 | Reference(Radiotherapy Planned Course) | Radiotherapy Planned Course that this Treatment Plan fulfills (in most cases together with other treatment plans). |
| replaces | SΣ | 0..* | Reference(Radiotherapy Treatment Plan) | Previous retired plan that is replaced by this plan |
| status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Required Pattern: filler-order |
| Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:required | Σ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiation oncology AND/OR radiotherapy | |
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. 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: 1255724003 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy treatment plan (regime/therapy) | |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
| requester | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
| Slices for performer | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer Slice: Unordered, Open by profile:$this.resolve() |
| performer:treatmentOrSeedDevice | SΣ | 0..* | Reference(Radiotherapy Treatment Device | Radiotherapy Seed Device) | Radiotherapy Treatment Device or Seed Device used as part of therapy. |
| locationReference | SΣ | 0..* | Reference(US Core Location Profile) | Requested location |
| reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) |
| reasonReference | SΣ | 0..* | Reference(Condition) | Explanation/Justification for service or service |
| bodySite | SΣ | 0..* | CodeableConcept | Body site that is treated with radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) |
| locationQualifier | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
| lateralityQualifier | 0..1 | CodeableConcept | Laterality qualifier for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ServiceRequest.extension:modalityAndTechnique.extension:modality.value[x] | required | RadiotherapyModalityVS |
| ServiceRequest.extension:modalityAndTechnique.extension:technique.value[x] | required | RadiotherapyTechniqueVS |
| ServiceRequest.identifier:displayName.use | required | Pattern: usual |
| ServiceRequest.identifier:official.use | required | Pattern: official |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | Pattern: filler-order |
| ServiceRequest.category | example | ServiceRequestCategoryCodes |
| ServiceRequest.category:required | example | Pattern: SNOMED CT code 108290001("Radiation oncology AND/OR radiotherapy") |
| ServiceRequest.code | example | Pattern: SNOMED CT code 1255724003("Radiotherapy treatment plan (regime/therapy)") |
| ServiceRequest.reasonCode | extensible | CancerDisorderVS |
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
| Id | Grade | Path(s) | Details | Requirements |
| codexrt-free-breathing-technique | error | ServiceRequest | The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing.
SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique') implies extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721071000124104' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) | |
| codexrt-motion-management-none | error | ServiceRequest | If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed.
They would also be 'none' or contradict the 'none'.
SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721031000124102' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) implies extension.where(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management').count() = 1 |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed codexrt-motion-management-none: If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed. They would also be 'none' or contradict the 'none'. SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" codexrt-free-breathing-technique: The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing. SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" | ||||
| 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 | |||||
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modalityAndTechnique | SC | 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: Radiotherapy Energy Unit Value Set (required) | ||||
| radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-applicator-type Binding: Brachytherapy Applicator Type Value Set (extensible) | ||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique" | |||||
| imageGuidedRadiotherapyModality | SC | 0..* | (Complex) | Image Guided Radiotherapy Modality URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-image-guided-radiotherapy-modality | ||||
| radiotherapyFractionsPlanned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned | ||||
| radiotherapyDosePlannedToVolume | S | 0..* | (Complex) | Planned Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-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 targeted by the planned dose | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "volume" | |||||
| value[x] | 1..1 | Reference(Radiotherapy Volume) | Value of extension | |||||
| extension:fractionDose | S | 0..1 | Extension | Radiation Dose Planned per Fraction | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "fractionDose" | |||||
| value[x] | 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 | |||||
| extension:totalDose | S | 0..1 | Extension | Total Planned Radiation Dose | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "totalDose" | |||||
| value[x] | 1..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 | |||||
| pointDose | S | 0..1 | boolean | Point Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-point-dose | ||||
| primaryPlanDose | S | 0..1 | boolean | Primary Plan Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose | ||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume" | |||||
| radiotherapyReasonForRevisionOrAdaptation | S | 0..* | CodeableConcept | Reason for Revision or Adaptation URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision-or-adaptation Binding: Radiotherapy Reason for Revision or Adaptation Value Set (required) | ||||
| respiratoryMotionManagement | S | 0..* | CodeableConcept | Respiratory Motion Management URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management Binding: Radiotherapy Respiratory Motion Management Value Set (required) | ||||
| freeBreathingMotionManagementTechnique | S | 0..* | CodeableConcept | Free-Breathing Motion Management Technique URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique Binding: Radiotherapy Free-Breathing Motion Management Technique Value Set (required) | ||||
| radiotherapyDicomPlan | 0..1 | (Complex) | DICOM Treatment Plan URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 2..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:use | ||||
| identifier:displayName | SΣ | 1..1 | Identifier | The name that is displayed to the user. | ||||
| 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 | SΣ | 1..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:official | SΣ | 1..* | Identifier | A business identifier for the request or procedure, which is independent of its FHIR representation, such as a GUID or DICOM UID. | ||||
| 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 | SΣ | 1..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) | ||||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills Slice: Unordered, Open by profile:$this.resolve() | ||||
| basedOn:plan-prescription | SΣ | 0..1 | Reference(Radiotherapy Plan Prescription) | Radiotherapy Plan Prescription that this Treatment Plan fulfills. | ||||
| basedOn:planned-phase | SΣ | 0..1 | Reference(Radiotherapy Planned Phase) | Radiotherapy Planned Phase that this Treatment Plan fulfills (in most cases together with other treatment plans). | ||||
| basedOn:planned-course | SΣ | 0..1 | Reference(Radiotherapy Planned Course) | Radiotherapy Planned Course that this Treatment Plan fulfills (in most cases together with other treatment plans). | ||||
| replaces | SΣ | 0..* | Reference(Radiotherapy Treatment Plan) | Previous retired plan that is replaced by this plan | ||||
| requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Required Pattern: filler-order | ||||
| Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:required | Σ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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 | 1..1 | string | Representation defined by the system Fixed Value: Radiation oncology AND/OR radiotherapy | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. 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: 1255724003 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy treatment plan (regime/therapy) | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
 occurrence[x] | Σ | 0..1 | When service should occur | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| occurrenceTiming | Timing | |||||||
| authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| Slices for performer | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer Slice: Unordered, Open by profile:$this.resolve() | ||||
| performer:treatmentOrSeedDevice | SΣ | 0..* | Reference(Radiotherapy Treatment Device | Radiotherapy Seed Device) | Radiotherapy Treatment Device or Seed Device used as part of therapy. | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | SΣ | 0..* | Reference(US Core Location Profile) | Requested location | ||||
| reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) | ||||
| reasonReference | SΣ | 0..* | Reference(Condition) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
| bodySite | SΣ | 0..* | CodeableConcept | Body site that is treated with radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| locationQualifier | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |||||
| lateralityQualifier | 0..1 | CodeableConcept | Laterality qualifier for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| note | 0..* | Annotation | Comments | |||||
| patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.extension:modalityAndTechnique.extension:modality.value[x] | required | RadiotherapyModalityVS | ||||
| ServiceRequest.extension:modalityAndTechnique.extension:technique.value[x] | required | RadiotherapyTechniqueVS | ||||
| ServiceRequest.identifier:displayName.use | required | Pattern: usual | ||||
| ServiceRequest.identifier:displayName.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.identifier:official.use | required | Pattern: official | ||||
| ServiceRequest.identifier:official.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | Pattern: filler-order | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.category:required | example | Pattern: SNOMED CT code 108290001("Radiation oncology AND/OR radiotherapy") | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | example | Pattern: SNOMED CT code 1255724003("Radiotherapy treatment plan (regime/therapy)") | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.performerType | example | ParticipantRoles | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | extensible | CancerDisorderVS | ||||
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
This structure is derived from ServiceRequest
Summary
Mandatory: 13 elements
Must-Support: 34 elements
Prohibited: 5 elements
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 ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed codexrt-motion-management-none: If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed. They would also be 'none' or contradict the 'none'. SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" codexrt-free-breathing-technique: The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing. SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" |
| Slices for extension | S | 1..* | 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: Radiotherapy Energy Unit Value Set (required) |
| radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-applicator-type Binding: Brachytherapy Applicator Type Value Set (extensible) |
| imageGuidedRadiotherapyModality | S | 0..* | (Complex) | Image Guided Radiotherapy Modality URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-image-guided-radiotherapy-modality |
| radiotherapyFractionsPlanned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned |
| radiotherapyDosePlannedToVolume | S | 0..* | (Complex) | Planned Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume |
| extension:fractions | 0..0 | |||
| pointDose | S | 0..1 | boolean | Point Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-point-dose |
| primaryPlanDose | S | 0..1 | boolean | Primary Plan Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose |
| radiotherapyReasonForRevisionOrAdaptation | S | 0..* | CodeableConcept | Reason for Revision or Adaptation URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision-or-adaptation Binding: Radiotherapy Reason for Revision or Adaptation Value Set (required) |
| respiratoryMotionManagement | S | 0..* | CodeableConcept | Respiratory Motion Management URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management Binding: Radiotherapy Respiratory Motion Management Value Set (required) |
| freeBreathingMotionManagementTechnique | S | 0..* | CodeableConcept | Free-Breathing Motion Management Technique URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique Binding: Radiotherapy Free-Breathing Motion Management Technique Value Set (required) |
| radiotherapyDicomPlan | 0..1 | (Complex) | DICOM Treatment Plan URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |
| Slices for identifier | S | 2..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:use |
| identifier:displayName | S | 1..1 | Identifier | The name that is displayed to the user. |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: usual | |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| identifier:official | S | 1..* | Identifier | A business identifier for the request or procedure, which is independent of its FHIR representation, such as a GUID or DICOM UID. |
| use | 1..1 | code | usual | official | temp | secondary | old (If known) Required Pattern: official | |
| system | S | 1..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| Slices for basedOn | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills Slice: Unordered, Open by profile:$this.resolve() | |
| basedOn:plan-prescription | S | 0..1 | Reference(Radiotherapy Plan Prescription) | Radiotherapy Plan Prescription that this Treatment Plan fulfills. |
| basedOn:planned-phase | S | 0..1 | Reference(Radiotherapy Planned Phase) | Radiotherapy Planned Phase that this Treatment Plan fulfills (in most cases together with other treatment plans). |
| basedOn:planned-course | S | 0..1 | Reference(Radiotherapy Planned Course) | Radiotherapy Planned Course that this Treatment Plan fulfills (in most cases together with other treatment plans). |
| replaces | S | 0..* | Reference(Radiotherapy Treatment Plan) | Previous retired plan that is replaced by this plan |
| status | S | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown |
| intent | S | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Required Pattern: filler-order |
| Slices for category | S | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this |
| category:required | 1..1 | CodeableConcept | Classification of service 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiation oncology AND/OR radiotherapy | |
| doNotPerform | 0..0 | |||
| code | S | 1..1 | CodeableConcept | What is being requested/ordered 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: 1255724003 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy treatment plan (regime/therapy) | |
| quantity[x] | 0..0 | |||
| subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
| asNeeded[x] | 0..0 | |||
| requester | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service | |
| Slices for performer | S | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer Slice: Unordered, Open by profile:$this.resolve() |
| performer:treatmentOrSeedDevice | S | 0..* | Reference(Radiotherapy Treatment Device | Radiotherapy Seed Device) | Radiotherapy Treatment Device or Seed Device used as part of therapy. |
| locationReference | S | 0..* | Reference(US Core Location Profile) | Requested location |
| reasonCode | S | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) |
| reasonReference | S | 0..* | Reference(Condition) | Explanation/Justification for service or service |
| specimen | 0..0 | |||
| bodySite | S | 0..* | CodeableConcept | Body site that is treated with radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) |
| locationQualifier | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
| lateralityQualifier | 0..1 | CodeableConcept | Laterality qualifier for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| ServiceRequest.reasonCode | extensible | CancerDisorderVS |
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
| Id | Grade | Path(s) | Details | Requirements |
| codexrt-free-breathing-technique | error | ServiceRequest | The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing.
SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique') implies extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721071000124104' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) | |
| codexrt-motion-management-none | error | ServiceRequest | If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed.
They would also be 'none' or contradict the 'none'.
SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721031000124102' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) implies extension.where(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management').count() = 1 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed codexrt-motion-management-none: If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed. They would also be 'none' or contradict the 'none'. SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" codexrt-free-breathing-technique: The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing. SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| modalityAndTechnique | SC | 0..1 | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique |
| 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 |
| 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 |
| 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: Radiotherapy Energy Unit Value Set (required) |
| radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-applicator-type Binding: Brachytherapy Applicator Type Value Set (extensible) |
| url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique" | |
| imageGuidedRadiotherapyModality | SC | 0..* | (Complex) | Image Guided Radiotherapy Modality URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-image-guided-radiotherapy-modality |
| radiotherapyFractionsPlanned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned |
| radiotherapyDosePlannedToVolume | S | 0..* | (Complex) | Planned Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume |
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:volume | S | 1..1 | Extension | Volume targeted by the planned dose |
| extension | 0..0 | |||
| url | 1..1 | uri | "volume" | |
| value[x] | 1..1 | Reference(Radiotherapy Volume) | Value of extension | |
| extension:fractionDose | S | 0..1 | Extension | Radiation Dose Planned per Fraction |
| extension | 0..0 | |||
| url | 1..1 | uri | "fractionDose" | |
| extension:totalDose | S | 0..1 | Extension | Total Planned Radiation Dose |
| extension | 0..0 | |||
| url | 1..1 | uri | "totalDose" | |
| value[x] | 1..1 | Quantity | Value of extension Required Pattern: At least the following | |
| 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 | |
| pointDose | S | 0..1 | boolean | Point Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-point-dose |
| primaryPlanDose | S | 0..1 | boolean | Primary Plan Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose |
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume" | |
| radiotherapyReasonForRevisionOrAdaptation | S | 0..* | CodeableConcept | Reason for Revision or Adaptation URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision-or-adaptation Binding: Radiotherapy Reason for Revision or Adaptation Value Set (required) |
| respiratoryMotionManagement | S | 0..* | CodeableConcept | Respiratory Motion Management URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management Binding: Radiotherapy Respiratory Motion Management Value Set (required) |
| freeBreathingMotionManagementTechnique | S | 0..* | CodeableConcept | Free-Breathing Motion Management Technique URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique Binding: Radiotherapy Free-Breathing Motion Management Technique Value Set (required) |
| radiotherapyDicomPlan | 0..1 | (Complex) | DICOM Treatment Plan URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for identifier | SΣ | 2..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:use |
| identifier:displayName | SΣ | 1..1 | Identifier | The name that is displayed to the user. |
| 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 |
| system | SΣ | 1..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 |
| identifier:official | SΣ | 1..* | Identifier | A business identifier for the request or procedure, which is independent of its FHIR representation, such as a GUID or DICOM UID. |
| 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 | SΣ | 1..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 |
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills Slice: Unordered, Open by profile:$this.resolve() |
| basedOn:plan-prescription | SΣ | 0..1 | Reference(Radiotherapy Plan Prescription) | Radiotherapy Plan Prescription that this Treatment Plan fulfills. |
| basedOn:planned-phase | SΣ | 0..1 | Reference(Radiotherapy Planned Phase) | Radiotherapy Planned Phase that this Treatment Plan fulfills (in most cases together with other treatment plans). |
| basedOn:planned-course | SΣ | 0..1 | Reference(Radiotherapy Planned Course) | Radiotherapy Planned Course that this Treatment Plan fulfills (in most cases together with other treatment plans). |
| replaces | SΣ | 0..* | Reference(Radiotherapy Treatment Plan) | Previous retired plan that is replaced by this plan |
| status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
| intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Required Pattern: filler-order |
| Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
| category:required | Σ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiation oncology AND/OR radiotherapy | |
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. 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: 1255724003 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy treatment plan (regime/therapy) | |
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
| requester | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
| Slices for performer | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer Slice: Unordered, Open by profile:$this.resolve() |
| performer:treatmentOrSeedDevice | SΣ | 0..* | Reference(Radiotherapy Treatment Device | Radiotherapy Seed Device) | Radiotherapy Treatment Device or Seed Device used as part of therapy. |
| locationReference | SΣ | 0..* | Reference(US Core Location Profile) | Requested location |
| reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) |
| reasonReference | SΣ | 0..* | Reference(Condition) | Explanation/Justification for service or service |
| bodySite | SΣ | 0..* | CodeableConcept | Body site that is treated with radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) |
| locationQualifier | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |
| lateralityQualifier | 0..1 | CodeableConcept | Laterality qualifier for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| ServiceRequest.extension:modalityAndTechnique.extension:modality.value[x] | required | RadiotherapyModalityVS |
| ServiceRequest.extension:modalityAndTechnique.extension:technique.value[x] | required | RadiotherapyTechniqueVS |
| ServiceRequest.identifier:displayName.use | required | Pattern: usual |
| ServiceRequest.identifier:official.use | required | Pattern: official |
| ServiceRequest.status | required | RequestStatus |
| ServiceRequest.intent | required | Pattern: filler-order |
| ServiceRequest.category | example | ServiceRequestCategoryCodes |
| ServiceRequest.category:required | example | Pattern: SNOMED CT code 108290001("Radiation oncology AND/OR radiotherapy") |
| ServiceRequest.code | example | Pattern: SNOMED CT code 1255724003("Radiotherapy treatment plan (regime/therapy)") |
| ServiceRequest.reasonCode | extensible | CancerDisorderVS |
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
| Id | Grade | Path(s) | Details | Requirements |
| codexrt-free-breathing-technique | error | ServiceRequest | The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing.
SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique') implies extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721071000124104' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) | |
| codexrt-motion-management-none | error | ServiceRequest | If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed.
They would also be 'none' or contradict the 'none'.
SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" : extension.exists(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management' and value.exists(coding.exists(code = '721031000124102' and system = 'http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs'))) implies extension.where(url = 'http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management').count() = 1 |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | C | 0..* | ServiceRequest | A request for a service to be performed codexrt-motion-management-none: If the respiratory motion management is 'none', then no other respiratory motion management extensions are allowed. They would also be 'none' or contradict the 'none'. SNOMEDCT code 721031000124102 is "Radiotherapy without respiratory motion management (regime/therapy)" codexrt-free-breathing-technique: The extension for the technique of free-breathing motion management is only allowed if motion management is free-breathing. SNOMEDCT code 721071000124104 is "Radiotherapy with free breathing (regime/therapy)" | ||||
| 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 | |||||
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modalityAndTechnique | SC | 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: Radiotherapy Energy Unit Value Set (required) | ||||
| radiotherapyTreatmentApplicatorType | S | 0..* | CodeableConcept | Radiotherapy Treatment Applicator Type URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-treatment-applicator-type Binding: Brachytherapy Applicator Type Value Set (extensible) | ||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique" | |||||
| imageGuidedRadiotherapyModality | SC | 0..* | (Complex) | Image Guided Radiotherapy Modality URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-image-guided-radiotherapy-modality | ||||
| radiotherapyFractionsPlanned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned | ||||
| radiotherapyDosePlannedToVolume | S | 0..* | (Complex) | Planned Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-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 targeted by the planned dose | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "volume" | |||||
| value[x] | 1..1 | Reference(Radiotherapy Volume) | Value of extension | |||||
| extension:fractionDose | S | 0..1 | Extension | Radiation Dose Planned per Fraction | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "fractionDose" | |||||
| value[x] | 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 | |||||
| extension:totalDose | S | 0..1 | Extension | Total Planned Radiation Dose | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..0 | |||||||
| url | 1..1 | uri | "totalDose" | |||||
| value[x] | 1..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 | |||||
| pointDose | S | 0..1 | boolean | Point Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-point-dose | ||||
| primaryPlanDose | S | 0..1 | boolean | Primary Plan Dose URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-primary-plan-dose | ||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume" | |||||
| radiotherapyReasonForRevisionOrAdaptation | S | 0..* | CodeableConcept | Reason for Revision or Adaptation URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision-or-adaptation Binding: Radiotherapy Reason for Revision or Adaptation Value Set (required) | ||||
| respiratoryMotionManagement | S | 0..* | CodeableConcept | Respiratory Motion Management URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-respiratory-motion-management Binding: Radiotherapy Respiratory Motion Management Value Set (required) | ||||
| freeBreathingMotionManagementTechnique | S | 0..* | CodeableConcept | Free-Breathing Motion Management Technique URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-free-breathing-motion-mgmt-technique Binding: Radiotherapy Free-Breathing Motion Management Technique Value Set (required) | ||||
| radiotherapyDicomPlan | 0..1 | (Complex) | DICOM Treatment Plan URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-dicom-reference | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for identifier | SΣ | 2..* | Identifier | Identifiers assigned to this order Slice: Unordered, Open by value:use | ||||
| identifier:displayName | SΣ | 1..1 | Identifier | The name that is displayed to the user. | ||||
| 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 | SΣ | 1..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:official | SΣ | 1..* | Identifier | A business identifier for the request or procedure, which is independent of its FHIR representation, such as a GUID or DICOM UID. | ||||
| 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 | SΣ | 1..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) | ||||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| Slices for basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | What request fulfills Slice: Unordered, Open by profile:$this.resolve() | ||||
| basedOn:plan-prescription | SΣ | 0..1 | Reference(Radiotherapy Plan Prescription) | Radiotherapy Plan Prescription that this Treatment Plan fulfills. | ||||
| basedOn:planned-phase | SΣ | 0..1 | Reference(Radiotherapy Planned Phase) | Radiotherapy Planned Phase that this Treatment Plan fulfills (in most cases together with other treatment plans). | ||||
| basedOn:planned-course | SΣ | 0..1 | Reference(Radiotherapy Planned Course) | Radiotherapy Planned Course that this Treatment Plan fulfills (in most cases together with other treatment plans). | ||||
| replaces | SΣ | 0..* | Reference(Radiotherapy Treatment Plan) | Previous retired plan that is replaced by this plan | ||||
| requisition | Σ | 0..1 | Identifier | Composite Request ID | ||||
| status | ?!SΣ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. | ||||
| intent | ?!SΣ | 1..1 | code | proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option Binding: RequestIntent (required): The kind of service request. Required Pattern: filler-order | ||||
| Slices for category | SΣ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. | ||||
| category:required | Σ | 1..1 | CodeableConcept | Classification of service Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. 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 | 1..1 | string | Representation defined by the system Fixed Value: Radiation oncology AND/OR radiotherapy | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| priority | Σ | 0..1 | code | routine | urgent | asap | stat Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request. | ||||
| code | SΣ | 1..1 | CodeableConcept | What is being requested/ordered Binding: ProcedureCodes(SNOMEDCT) (example): Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is preferred and a valueset using LOINC Order codes is available here. 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: 1255724003 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy treatment plan (regime/therapy) | |||||
| userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
| text | 0..1 | string | Plain text representation of the concept | |||||
| orderDetail | ΣC | 0..* | CodeableConcept | Additional order information Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context. | ||||
| subject | SΣ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for | ||||
| encounter | Σ | 0..1 | Reference(Encounter) | Encounter in which the request was created | ||||
| occurrence[x] | Σ | 0..1 | When service should occur | |||||
| occurrenceDateTime | dateTime | |||||||
| occurrencePeriod | Period | |||||||
| occurrenceTiming | Timing | |||||||
| authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service | ||||
| performerType | Σ | 0..1 | CodeableConcept | Performer role Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. | ||||
| Slices for performer | SΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer Slice: Unordered, Open by profile:$this.resolve() | ||||
| performer:treatmentOrSeedDevice | SΣ | 0..* | Reference(Radiotherapy Treatment Device | Radiotherapy Seed Device) | Radiotherapy Treatment Device or Seed Device used as part of therapy. | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | SΣ | 0..* | Reference(US Core Location Profile) | Requested location | ||||
| reasonCode | SΣ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) | ||||
| reasonReference | SΣ | 0..* | Reference(Condition) | Explanation/Justification for service or service | ||||
| insurance | 0..* | Reference(Coverage | ClaimResponse) | Associated insurance coverage | |||||
| supportingInfo | 0..* | Reference(Resource) | Additional clinical information | |||||
| bodySite | SΣ | 0..* | CodeableConcept | Body site that is treated with radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| locationQualifier | 0..* | CodeableConcept | General location qualifier (excluding laterality) for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-body-location-qualifier Binding: Body Location Qualifier Value Set (required) | |||||
| lateralityQualifier | 0..1 | CodeableConcept | Laterality qualifier for this bodySite URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-laterality-qualifier Binding: Laterality Qualifier Value Set (required) | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| note | 0..* | Annotation | Comments | |||||
| patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| ServiceRequest.language | preferred | CommonLanguages
| ||||
| ServiceRequest.extension:modalityAndTechnique.extension:modality.value[x] | required | RadiotherapyModalityVS | ||||
| ServiceRequest.extension:modalityAndTechnique.extension:technique.value[x] | required | RadiotherapyTechniqueVS | ||||
| ServiceRequest.identifier:displayName.use | required | Pattern: usual | ||||
| ServiceRequest.identifier:displayName.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.identifier:official.use | required | Pattern: official | ||||
| ServiceRequest.identifier:official.type | extensible | Identifier Type Codes | ||||
| ServiceRequest.status | required | RequestStatus | ||||
| ServiceRequest.intent | required | Pattern: filler-order | ||||
| ServiceRequest.category | example | ServiceRequestCategoryCodes | ||||
| ServiceRequest.category:required | example | Pattern: SNOMED CT code 108290001("Radiation oncology AND/OR radiotherapy") | ||||
| ServiceRequest.priority | required | RequestPriority | ||||
| ServiceRequest.code | example | Pattern: SNOMED CT code 1255724003("Radiotherapy treatment plan (regime/therapy)") | ||||
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes | ||||
| ServiceRequest.performerType | example | ParticipantRoles | ||||
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType | ||||
| ServiceRequest.reasonCode | extensible | CancerDisorderVS | ||||
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
This structure is derived from ServiceRequest
Summary
Mandatory: 13 elements
Must-Support: 34 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 Cross Group Projects Work Group. Package hl7.fhir.us.codex-radiation-therapy#1.0.0 based on FHIR 4.0.1. Generated 2023-07-28
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change