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-course-prescription |
Version: | 1.0.0-ballot |
Name: | RadiotherapyCoursePrescription |
Title: | Radiotherapy Course Cumulative Prescription |
Status: | Draft as of 2022-08-08 02:42:13+0000 |
Definition: | A Radiotherapy Course Prescription is a high-level request for a complete Course of Radiotherapy, which may be fulfilled by one or more Phases. |
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-course-prescription
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 22 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 | 0..* | 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) |
treatment-intent | S | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) |
radiotherapy-dose-prescribed-to-volume | S | 0..* | (Complex) | Prescribed Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume |
extension:fractionDose | 0..0 | |||
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 |
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: original-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/mcode/CodeSystem/snomed-requested-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33529 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Course of Treatment (regime/therapy) | |
quantity[x] | 0..0 | |||
subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
occurrencePeriod | S | 0..1 | Period | When service should occur |
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 | 0..* | 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" | |||||
treatment-intent | S | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) | ||||
radiotherapy-dose-prescribed-to-volume | S | 0..* | (Complex) | Prescribed Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-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 prescribed 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:totalDose | S | 0..1 | Extension | Total Radiation Dose Prescribed | ||||
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 | |||||
extension:fractions | S | 0..1 | Extension | Number of Prescribed Fractions | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "fractions" | |||||
value[x] | 0..1 | positiveInt | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume" | |||||
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) | What request fulfills | ||||
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: original-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/mcode/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-33529 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Course of Treatment (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 | Σ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 | Period | When service should occur Slice: Unordered, Closed by type:$this | ||||
occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur | ||||
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 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ServiceRequest | I | 0..* | ServiceRequest | A request for a service to be performed |
Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
modalityAndTechnique | I | 0..* | (Complex) | Radiotherapy Modality And Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique |
modality | 1..1 | CodeableConcept | Radiotherapy Modality Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality | |
technique | 0..* | CodeableConcept | Radiotherapy Technique Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique | |
radiotherapyEnergyOrIsotope | 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 | 0..* | (Complex) | Treatment Device URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device | |
radiotherapyTreatmentApplicatorType | 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) | |
treatment-intent | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) | |
radiotherapy-dose-prescribed-to-volume | 0..* | (Complex) | Prescribed Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume | |
extension:volume | 1..1 | Extension | Volume targeted by the prescribed dose | |
extension:totalDose | 0..1 | Extension | Total Radiation Dose Prescribed | |
extension:fractions | 0..1 | Extension | Number of Prescribed Fractions | |
identifier | Σ | 0..* | Identifier | Identifiers assigned to this order |
system | Σ | 0..1 | uri | The namespace for the identifier value |
value | Σ | 1..1 | string | The value that is unique |
replaces | Σ | 0..* | Reference(ServiceRequest) | Previous retired request that is replaced by this request |
status | ?!Σ | 1..1 | code | draft | active | on-hold | revoked | completed | entered-in-error | unknown Binding: RequestStatus (required): The status of a service order. |
intent | ?!Σ | 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: original-order |
category | Σ | 1..* | CodeableConcept | Classification of service Slice: Unordered, Open by pattern:$this Binding: ServiceRequestCategoryCodes (example): Classification of the requested service. |
code | Σ | 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://hl7.org/fhir/us/mcode/CodeSystem/snomed-requested-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33529 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Course of Treatment (regime/therapy) | |
subject | Σ | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
occurrence[x]:occurrencePeriod | Σ | 0..1 | Period | When service should occur |
requester | Σ | 0..1 | Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile) | Who/what is requesting service |
reasonCode | Σ | 0..* | CodeableConcept | Explanation/Justification for procedure or service Binding: Cancer Disorder Value Set (extensible) |
reasonReference | Σ | 0..* | Reference(Condition) | Explanation/Justification for service or service |
bodySite | Σ | 0..* | CodeableConcept | Body site that is treated with Radiotherapy Binding: Radiotherapy Treatment Location Value Set (required) |
note | 0..* | Annotation | Comments | |
Documentation for this format |
This structure is derived from ServiceRequest
Summary
Mandatory: 3 elements (1 nested mandatory element)
Must-Support: 22 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 | 0..* | 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) |
treatment-intent | S | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) |
radiotherapy-dose-prescribed-to-volume | S | 0..* | (Complex) | Prescribed Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume |
extension:fractionDose | 0..0 | |||
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 |
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: original-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/mcode/CodeSystem/snomed-requested-cs | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: USCRS-33529 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Course of Treatment (regime/therapy) | |
quantity[x] | 0..0 | |||
subject | S | 1..1 | Reference(US Core Patient Profile) | Individual or Entity the service is ordered for |
occurrencePeriod | S | 0..1 | Period | When service should occur |
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 | 0..* | 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" | |||||
treatment-intent | S | 0..1 | CodeableConcept | Procedure Intent Extension URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-procedure-intent Binding: Procedure Intent Value Set (required) | ||||
radiotherapy-dose-prescribed-to-volume | S | 0..* | (Complex) | Prescribed Dose to a Dose Reference URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-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 prescribed 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:totalDose | S | 0..1 | Extension | Total Radiation Dose Prescribed | ||||
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 | |||||
extension:fractions | S | 0..1 | Extension | Number of Prescribed Fractions | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "fractions" | |||||
value[x] | 0..1 | positiveInt | Value of extension | |||||
url | 1..1 | uri | "http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume" | |||||
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) | What request fulfills | ||||
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: original-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/mcode/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-33529 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Radiotherapy Course of Treatment (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 | Σ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 | Period | When service should occur Slice: Unordered, Closed by type:$this | ||||
occurrence[x]:occurrencePeriod | SΣ | 0..1 | Period | When service should occur | ||||
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: original-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-33529("Radiotherapy Course of Treatment (regime/therapy)") |
ServiceRequest.orderDetail | example | ServiceRequestOrderDetailsCodes |
ServiceRequest.performerType | example | ParticipantRoles |
ServiceRequest.locationCode | example | ServiceDeliveryLocationRoleType |
ServiceRequest.reasonCode | extensible | CancerDisorderVS |
ServiceRequest.bodySite | required | RadiotherapyTreatmentLocationVS |