CodeX™ Radiation Therapy
1.0.0-ballot - ci-build
CodeX™ Radiation Therapy
1.0.0-ballot - ci-build
This page is part of the CodeX™ Radiation Therapy (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR 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-planned-phase |
| Version: | 1.0.0-ballot |
| Name: | RadiotherapyPlannedPhase |
| Title: | Radiotherapy Planned Phase |
| Status: | Draft as of 2022-08-08 02:42:13+0000 |
| Definition: | A Radiotherapy Planned Phase is the summary over all Radiotherapy Plans to deliver a single Phase of Radiotherapy treatment. |
| 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-planned-phase
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
Summary
Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 23 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:
This structure is derived from ServiceRequest
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ServiceRequest | 0..* | ServiceRequest | A request for a service to be performed | |
  Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
  modalityAndTechnique | S | 0..* | (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) |
| radiotherapy-fractions-planned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned |
| radiotherapy-dose-planned-to-volume | 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 | |||
| radiotherapy-reason-for-revision | S | 0..1 | CodeableConcept | Reason for Revision URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision Binding: Reason for Revision Value Set (required) |
 identifier | S | 0..* | Identifier | Identifiers assigned to this order |
| system | S | 0..1 | uri | The namespace for the identifier value |
 value | S | 1..1 | string | The value that is unique |
| basedOn | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | Should Reference a Radiotherapy Phase Prescription and the Radiotherapy Planned Course to which this Phase belongs. | |
| replaces | S | 0..* | Reference(ServiceRequest) | Previous retired request that is replaced by this request |
| 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://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-33527 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Phase (therapy/regime) | |
| quantity[x] | 0..0 | |||
 subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
 occurrenceTiming | S | 0..1 | Timing | When service should occur |
| repeat | ||||
| boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| asNeeded[x] | 0..0 | |||
| requester | S | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
| 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) |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | I | 0..* | ServiceRequest | A request for a service to be performed | ||||
 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 | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modalityAndTechnique | SI | 0..* | (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" | |||||
| radiotherapy-fractions-planned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned | ||||
| radiotherapy-dose-planned-to-volume | 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" | |||||
| 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 | |||||
| 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" | |||||
| Slices for value[x] | 1..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueQuantity | 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 | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume" | |||||
| radiotherapy-reason-for-revision | S | 0..1 | CodeableConcept | Reason for Revision URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision Binding: Reason for Revision Value Set (required) | ||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order | ||||
| 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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| 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Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | Should Reference a Radiotherapy Phase Prescription and the Radiotherapy Planned Course to which this Phase belongs. | ||||
| replaces | SΣ | 0..* | Reference(ServiceRequest) | Previous retired request that is replaced by this request | ||||
| 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://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-33527 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Phase (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 | |||||
| orderDetail | ΣI | 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 | ||||
| Slices for occurrence[x] | Σ | 0..1 | Timing | When service should occur Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceTiming | SΣ | 0..1 | Timing | When service should occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event | Σ | 0..* | dateTime | When the event occurs | ||||
| repeat | ΣI | 0..1 | Element | When the event is to occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this | ||||
 bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | ||||
| count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration | Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
| frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period | Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
| periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay | Σ | 0..* | time | Time of day for action | ||||
| when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | SΣ | 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. | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | Σ | 0..* | Reference(Location) | 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) | ||||
| note | S | 0..* | Annotation | Comments | ||||
| patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
This structure is derived from ServiceRequest
Summary
Mandatory: 5 elements (1 nested mandatory element)
Must-Support: 23 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 | 0..* | ServiceRequest | A request for a service to be performed | |
| Slices for extension | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url |
| modalityAndTechnique | S | 0..* | (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) |
| radiotherapy-fractions-planned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned |
| radiotherapy-dose-planned-to-volume | 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 | |||
| radiotherapy-reason-for-revision | S | 0..1 | CodeableConcept | Reason for Revision URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision Binding: Reason for Revision Value Set (required) |
| identifier | S | 0..* | Identifier | Identifiers assigned to this order |
| system | S | 0..1 | uri | The namespace for the identifier value |
| value | S | 1..1 | string | The value that is unique |
| basedOn | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | Should Reference a Radiotherapy Phase Prescription and the Radiotherapy Planned Course to which this Phase belongs. | |
| replaces | S | 0..* | Reference(ServiceRequest) | Previous retired request that is replaced by this request |
| 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://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-33527 | |
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Phase (therapy/regime) | |
| quantity[x] | 0..0 | |||
| subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
| occurrenceTiming | S | 0..1 | Timing | When service should occur |
| repeat | ||||
| boundsPeriod | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | |
| asNeeded[x] | 0..0 | |||
| requester | S | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
| 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) |
| note | S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| ServiceRequest | I | 0..* | ServiceRequest | A request for a service to be performed | ||||
| 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 | S | 1..* | Extension | Extension Slice: Unordered, Open by value:url | ||||
| modalityAndTechnique | SI | 0..* | (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" | |||||
| radiotherapy-fractions-planned | S | 1..1 | positiveInt | Number of Planned Fractions URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-planned | ||||
| radiotherapy-dose-planned-to-volume | 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" | |||||
| 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 | |||||
| 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" | |||||
| Slices for value[x] | 1..1 | Quantity | Value of extension Slice: Unordered, Closed by type:$this | |||||
| value[x]:valueQuantity | 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 | |||||
| url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-planned-to-volume" | |||||
| radiotherapy-reason-for-revision | S | 0..1 | CodeableConcept | Reason for Revision URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-reason-for-revision Binding: Reason for Revision Value Set (required) | ||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | SΣ | 0..* | Identifier | Identifiers assigned to this order | ||||
| 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 | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| 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Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Instantiates FHIR protocol or definition | ||||
| instantiatesUri | Σ | 0..* | uri | Instantiates external protocol or definition | ||||
| basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) | Should Reference a Radiotherapy Phase Prescription and the Radiotherapy Planned Course to which this Phase belongs. | ||||
| replaces | SΣ | 0..* | Reference(ServiceRequest) | Previous retired request that is replaced by this request | ||||
| 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://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-33527 | |||||
| display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Treatment Phase (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 | |||||
| orderDetail | ΣI | 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 | ||||
| Slices for occurrence[x] | Σ | 0..1 | Timing | When service should occur Slice: Unordered, Closed by type:$this | ||||
| occurrence[x]:occurrenceTiming | SΣ | 0..1 | Timing | When service should occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| event | Σ | 0..* | dateTime | When the event occurs | ||||
| repeat | ΣI | 0..1 | Element | When the event is to occur | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| Slices for bounds[x] | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits Slice: Unordered, Closed by type:$this | ||||
| bounds[x]:boundsPeriod | Σ | 0..1 | Period | Length/Range of lengths, or (Start and/or end) limits | ||||
| count | Σ | 0..1 | positiveInt | Number of times to repeat | ||||
| countMax | Σ | 0..1 | positiveInt | Maximum number of times to repeat | ||||
| duration | Σ | 0..1 | decimal | How long when it happens | ||||
| durationMax | Σ | 0..1 | decimal | How long when it happens (Max) | ||||
| durationUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| frequency | Σ | 0..1 | positiveInt | Event occurs frequency times per period | ||||
| frequencyMax | Σ | 0..1 | positiveInt | Event occurs up to frequencyMax times per period | ||||
| period | Σ | 0..1 | decimal | Event occurs frequency times per period | ||||
| periodMax | Σ | 0..1 | decimal | Upper limit of period (3-4 hours) | ||||
| periodUnit | Σ | 0..1 | code | s | min | h | d | wk | mo | a - unit of time (UCUM) Binding: UnitsOfTime (required): A unit of time (units from UCUM). | ||||
| dayOfWeek | Σ | 0..* | code | mon | tue | wed | thu | fri | sat | sun Binding: DaysOfWeek (required) | ||||
| timeOfDay | Σ | 0..* | time | Time of day for action | ||||
| when | Σ | 0..* | code | Code for time period of occurrence Binding: EventTiming (required): Real world event relating to the schedule. | ||||
| offset | Σ | 0..1 | unsignedInt | Minutes from event (before or after) | ||||
| code | Σ | 0..1 | CodeableConcept | BID | TID | QID | AM | PM | QD | QOD | + Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern. | ||||
| authoredOn | Σ | 0..1 | dateTime | Date request signed | ||||
| requester | SΣ | 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. | ||||
| performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) | Requested performer | ||||
| locationCode | Σ | 0..* | CodeableConcept | Requested location Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered. | ||||
| locationReference | Σ | 0..* | Reference(Location) | 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) | ||||
| note | S | 0..* | Annotation | Comments | ||||
| patientInstruction | Σ | 0..1 | string | Patient or consumer-oriented instructions | ||||
| relevantHistory | 0..* | Reference(Provenance) | Request provenance | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet / Code |
| ServiceRequest.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ServiceRequest.extension:modalityAndTechnique.extension:modality.value[x] | required | RadiotherapyModalityVS |
| ServiceRequest.extension:modalityAndTechnique.extension:technique.value[x] | required | RadiotherapyTechniqueVS |
| ServiceRequest.identifier.use | required | IdentifierUse |
| ServiceRequest.identifier.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: USCRS-33527("Radiotherapy Treatment Phase (therapy/regime)") |
| ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnit | required | UnitsOfTime |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnit | required | UnitsOfTime |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeek | required | DaysOfWeek |
| ServiceRequest.occurrence[x]:occurrenceTiming.repeat.when | required | EventTiming |
| ServiceRequest.occurrence[x]:occurrenceTiming.code | preferred | TimingAbbreviation |
| ServiceRequest.performerType | example | ParticipantRoles |
| ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
| ServiceRequest.reasonCode | extensible | CancerDisorderVS |
| ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |
IG © 2021+ HL7 Cross Group Projects Work Group. Package hl7.fhir.us.codex-radiation-therapy#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-08-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change