CodeX™ Radiation Therapy
1.0.0-ballot - ci-build

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

Resource Profile: Radiotherapy Phase Cumulative Prescription

Defining URL:http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-phase-prescription
Version:1.0.0-ballot
Name:RadiotherapyPhasePrescription
Title:Radiotherapy Phase Cumulative Prescription
Status:Active as of 2022-08-08 02:42:13+0000
Definition:

A Radioherapy Phase Prescription is a request for one series of fractionated treatments using Radiotherapy. It can define treatment parameters such as modality or technique, and prescribe dose to multiple targets.

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-phase-prescription

Formal Views of Profile Content

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:

  • The element ServiceRequest.category is sliced based on the value of pattern:$this

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modalityAndTechnique S0..*(Complex)Radiotherapy Modality And Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique
.... radiotherapyEnergyOrIsotope S0..*SimpleQuantityRadiotherapy 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 S0..*(Complex)Treatment Device
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device
.... radiotherapyTreatmentApplicatorType S0..*CodeableConceptRadiotherapy 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-prescribed S1..1positiveIntNumber of Prescribed Fractions
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-prescribed
.... extension:fractions 0..0
... radiotherapy-reason-for-revision S0..1CodeableConceptReason 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 S0..*IdentifierIdentifiers assigned to this order
.... system S0..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... basedOn 0..*Reference(CarePlan | ServiceRequest | MedicationRequest)Should Reference the Radiotherapy Course Prescription to which this Phase belongs if that exists.
... replaces S0..*Reference(ServiceRequest)Previous retired request that is replaced by this request
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: original-order
... Slices for category S1..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
.... category:required 1..1CodeableConceptClassification of service
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 108290001
...... display1..1stringRepresentation defined by the system
Fixed Value: Radiation oncology AND/OR radiotherapy
... doNotPerform 0..0
... code S1..1CodeableConceptWhat is being requested/ordered
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: USCRS-33527
..... display1..1stringRepresentation defined by the system
Fixed Value: Radiotherapy Treatment Phase (therapy/regime)
... quantity[x] 0..0
... subject S1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrenceTiming S0..1TimingWhen service should occur
.... repeat
..... boundsPeriod 0..1PeriodLength/Range of lengths, or (Start and/or end) limits
... asNeeded[x] 0..0
... requester S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... reasonCode S0..*CodeableConceptExplanation/Justification for procedure or service
Binding: Cancer Disorder Value Set (extensible)
... reasonReference S0..*Reference(Condition)Explanation/Justification for service or service
... specimen 0..0
... bodySite S0..*CodeableConceptBody site that is treated with Radiotherapy
Binding: Radiotherapy Treatment Location Value Set (required)
... note S0..*AnnotationComments

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA request for a service to be performed
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modalityAndTechnique SI0..*(Complex)Radiotherapy Modality And Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modality S1..1CodeableConceptRadiotherapy Modality Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Radiotherapy Modality Value Set (required)
.... technique S0..*CodeableConceptRadiotherapy Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Radiotherapy Technique Value Set (required)
.... radiotherapyEnergyOrIsotope S0..*SimpleQuantityRadiotherapy 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 S0..*(Complex)Treatment Device
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device
.... radiotherapyTreatmentApplicatorType S0..*CodeableConceptRadiotherapy 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..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique"
... radiotherapy-fractions-prescribed S1..1positiveIntNumber of Prescribed Fractions
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-prescribed
... radiotherapy-dose-prescribed-to-volume S0..*(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..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:volume S1..1ExtensionVolume targeted by the prescribed dose
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"volume"
..... value[x] 1..1Reference(Radiotherapy Volume)Value of extension
.... extension:fractionDose S0..1ExtensionRadiation Dose Prescribed per Fraction
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"fractionDose"
..... Slices for value[x] 0..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueQuantity 0..1QuantityValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... value0..1decimalNumerical value (with implicit precision)
....... comparator0..1code< | <= | >= | > - how to understand the value
....... unit0..1stringUnit representation
....... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
....... code1..1codeCoded form of the unit
Fixed Value: cGy
.... extension:totalDose S0..1ExtensionTotal Radiation Dose Prescribed
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"totalDose"
..... Slices for value[x] 1..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueQuantity 1..1QuantityValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... value0..1decimalNumerical value (with implicit precision)
....... comparator0..1code< | <= | >= | > - how to understand the value
....... unit0..1stringUnit representation
....... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
....... code1..1codeCoded form of the unit
Fixed Value: cGy
.... url 1..1uri"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume"
... radiotherapy-reason-for-revision S0..1CodeableConceptReason 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..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifiers assigned to this order
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)Should Reference the Radiotherapy Course Prescription to which this Phase belongs if that exists.
... replaces SΣ0..*Reference(ServiceRequest)Previous retired request that is replaced by this request
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | 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..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:required Σ1..1CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 108290001
...... display1..1stringRepresentation defined by the system
Fixed Value: Radiation oncology AND/OR radiotherapy
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code SΣ1..1CodeableConceptWhat 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: USCRS-33527
..... display1..1stringRepresentation defined by the system
Fixed Value: Radiotherapy Treatment Phase (therapy/regime)
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... subject SΣ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... Slices for occurrence[x] Σ0..1TimingWhen service should occur
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceTiming SΣ0..1TimingWhen service should occur
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... event Σ0..*dateTimeWhen the event occurs
..... repeat ΣI0..1ElementWhen the event is to occur
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for bounds[x] Σ0..1PeriodLength/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Closed by type:$this
....... bounds[x]:boundsPeriod Σ0..1PeriodLength/Range of lengths, or (Start and/or end) limits
...... count Σ0..1positiveIntNumber of times to repeat
...... countMax Σ0..1positiveIntMaximum number of times to repeat
...... duration Σ0..1decimalHow long when it happens
...... durationMax Σ0..1decimalHow long when it happens (Max)
...... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... frequency Σ0..1positiveIntEvent occurs frequency times per period
...... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
...... period Σ0..1decimalEvent occurs frequency times per period
...... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ0..*timeTime of day for action
...... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


...... offset Σ0..1unsignedIntMinutes from event (before or after)
..... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... authoredOn Σ0..1dateTimeDate request signed
... requester SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer 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..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptExplanation/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..*CodeableConceptBody site that is treated with Radiotherapy
Binding: Radiotherapy Treatment Location Value Set (required)
... note S0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA request for a service to be performed
... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modalityAndTechnique I0..*(Complex)Radiotherapy Modality And Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique
.... modality 1..1CodeableConceptRadiotherapy Modality Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality
.... technique 0..*CodeableConceptRadiotherapy Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique
.... radiotherapyEnergyOrIsotope 0..*SimpleQuantityRadiotherapy 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..*CodeableConceptRadiotherapy 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-prescribed 1..1positiveIntNumber of Prescribed Fractions
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-prescribed
.... extension:volume 1..1ExtensionVolume targeted by the prescribed dose
.... extension:fractionDose 0..1ExtensionRadiation Dose Prescribed per Fraction
.... extension:totalDose 0..1ExtensionTotal Radiation Dose Prescribed
... radiotherapy-reason-for-revision 0..1CodeableConceptReason 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 Σ0..*IdentifierIdentifiers assigned to this order
.... system Σ0..1uriThe namespace for the identifier value
.... value Σ1..1stringThe value that is unique
... replaces Σ0..*Reference(ServiceRequest)Previous retired request that is replaced by this request
... status ?!Σ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!Σ1..1codeproposal | 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..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


... code Σ1..1CodeableConceptWhat 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
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: USCRS-33527
..... display1..1stringRepresentation defined by the system
Fixed Value: Radiotherapy Treatment Phase (therapy/regime)
... subject Σ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrence[x]:occurrenceTiming Σ0..1TimingWhen service should occur
... requester Σ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... reasonCode Σ0..*CodeableConceptExplanation/Justification for procedure or service
Binding: Cancer Disorder Value Set (extensible)
... reasonReference Σ0..*Reference(Condition)Explanation/Justification for service or service
... bodySite Σ0..*CodeableConceptBody site that is treated with Radiotherapy
Binding: Radiotherapy Treatment Location Value Set (required)
... note 0..*AnnotationComments

doco 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:

  • The element ServiceRequest.category is sliced based on the value of pattern:$this

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest 0..*ServiceRequestA request for a service to be performed
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modalityAndTechnique S0..*(Complex)Radiotherapy Modality And Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique
.... radiotherapyEnergyOrIsotope S0..*SimpleQuantityRadiotherapy 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 S0..*(Complex)Treatment Device
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device
.... radiotherapyTreatmentApplicatorType S0..*CodeableConceptRadiotherapy 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-prescribed S1..1positiveIntNumber of Prescribed Fractions
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-prescribed
.... extension:fractions 0..0
... radiotherapy-reason-for-revision S0..1CodeableConceptReason 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 S0..*IdentifierIdentifiers assigned to this order
.... system S0..1uriThe namespace for the identifier value
.... value S1..1stringThe value that is unique
... basedOn 0..*Reference(CarePlan | ServiceRequest | MedicationRequest)Should Reference the Radiotherapy Course Prescription to which this Phase belongs if that exists.
... replaces S0..*Reference(ServiceRequest)Previous retired request that is replaced by this request
... status S1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
... intent S1..1codeproposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Required Pattern: original-order
... Slices for category S1..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
.... category:required 1..1CodeableConceptClassification of service
Required Pattern: At least the following
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 108290001
...... display1..1stringRepresentation defined by the system
Fixed Value: Radiation oncology AND/OR radiotherapy
... doNotPerform 0..0
... code S1..1CodeableConceptWhat is being requested/ordered
Required Pattern: At least the following
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: USCRS-33527
..... display1..1stringRepresentation defined by the system
Fixed Value: Radiotherapy Treatment Phase (therapy/regime)
... quantity[x] 0..0
... subject S1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... occurrenceTiming S0..1TimingWhen service should occur
.... repeat
..... boundsPeriod 0..1PeriodLength/Range of lengths, or (Start and/or end) limits
... asNeeded[x] 0..0
... requester S0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... reasonCode S0..*CodeableConceptExplanation/Justification for procedure or service
Binding: Cancer Disorder Value Set (extensible)
... reasonReference S0..*Reference(Condition)Explanation/Justification for service or service
... specimen 0..0
... bodySite S0..*CodeableConceptBody site that is treated with Radiotherapy
Binding: Radiotherapy Treatment Location Value Set (required)
... note S0..*AnnotationComments

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest I0..*ServiceRequestA request for a service to be performed
... id Σ0..1stringLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... Slices for extension S1..*ExtensionExtension
Slice: Unordered, Open by value:url
... modalityAndTechnique SI0..*(Complex)Radiotherapy Modality And Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... modality S1..1CodeableConceptRadiotherapy Modality Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Radiotherapy Modality Value Set (required)
.... technique S0..*CodeableConceptRadiotherapy Technique Extension
URL: http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-technique"
..... value[x] 1..1CodeableConceptValue of extension
Binding: Radiotherapy Technique Value Set (required)
.... radiotherapyEnergyOrIsotope S0..*SimpleQuantityRadiotherapy 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 S0..*(Complex)Treatment Device
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotheraphy-treatment-device
.... radiotherapyTreatmentApplicatorType S0..*CodeableConceptRadiotherapy 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..1uri"http://hl7.org/fhir/us/mcode/StructureDefinition/mcode-radiotherapy-modality-and-technique"
... radiotherapy-fractions-prescribed S1..1positiveIntNumber of Prescribed Fractions
URL: http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-fractions-prescribed
... radiotherapy-dose-prescribed-to-volume S0..*(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..1stringUnique id for inter-element referencing
.... Slices for extension 1..*ExtensionExtension
Slice: Unordered, Open by value:url
.... extension:volume S1..1ExtensionVolume targeted by the prescribed dose
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"volume"
..... value[x] 1..1Reference(Radiotherapy Volume)Value of extension
.... extension:fractionDose S0..1ExtensionRadiation Dose Prescribed per Fraction
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"fractionDose"
..... Slices for value[x] 0..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueQuantity 0..1QuantityValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... value0..1decimalNumerical value (with implicit precision)
....... comparator0..1code< | <= | >= | > - how to understand the value
....... unit0..1stringUnit representation
....... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
....... code1..1codeCoded form of the unit
Fixed Value: cGy
.... extension:totalDose S0..1ExtensionTotal Radiation Dose Prescribed
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..0
..... url 1..1uri"totalDose"
..... Slices for value[x] 1..1QuantityValue of extension
Slice: Unordered, Closed by type:$this
...... value[x]:valueQuantity 1..1QuantityValue of extension
Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... value0..1decimalNumerical value (with implicit precision)
....... comparator0..1code< | <= | >= | > - how to understand the value
....... unit0..1stringUnit representation
....... system1..1uriSystem that defines coded unit form
Fixed Value: http://unitsofmeasure.org
....... code1..1codeCoded form of the unit
Fixed Value: cGy
.... url 1..1uri"http://hl7.org/fhir/us/codex-radiation-therapy/StructureDefinition/codexrt-radiotherapy-dose-prescribed-to-volume"
... radiotherapy-reason-for-revision S0..1CodeableConceptReason 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..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..*IdentifierIdentifiers assigned to this order
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system SΣ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣ1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... instantiatesCanonical Σ0..*canonical(ActivityDefinition | PlanDefinition)Instantiates FHIR protocol or definition
... instantiatesUri Σ0..*uriInstantiates external protocol or definition
... basedOn Σ0..*Reference(CarePlan | ServiceRequest | MedicationRequest)Should Reference the Radiotherapy Course Prescription to which this Phase belongs if that exists.
... replaces SΣ0..*Reference(ServiceRequest)Previous retired request that is replaced by this request
... requisition Σ0..1IdentifierComposite Request ID
... status ?!SΣ1..1codedraft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ1..1codeproposal | 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..*CodeableConceptClassification of service
Slice: Unordered, Open by pattern:$this
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:required Σ1..1CodeableConceptClassification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.



Required Pattern: At least the following
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
...... id0..1stringUnique id for inter-element referencing
...... extension0..*ExtensionAdditional content defined by implementations
...... system1..1uriIdentity of the terminology system
Fixed Value: http://snomed.info/sct
...... version0..1stringVersion of the system - if relevant
...... code1..1codeSymbol in syntax defined by the system
Fixed Value: 108290001
...... display1..1stringRepresentation defined by the system
Fixed Value: Radiation oncology AND/OR radiotherapy
...... userSelected0..1booleanIf this coding was chosen directly by the user
..... text0..1stringPlain text representation of the concept
... priority Σ0..1coderoutine | urgent | asap | stat
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

... code SΣ1..1CodeableConceptWhat 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
.... id0..1stringUnique id for inter-element referencing
.... extension0..*ExtensionAdditional content defined by implementations
.... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
..... id0..1stringUnique id for inter-element referencing
..... extension0..*ExtensionAdditional content defined by implementations
..... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/codex-radiation-therapy/CodeSystem/snomed-requested-cs
..... version0..1stringVersion of the system - if relevant
..... code1..1codeSymbol in syntax defined by the system
Fixed Value: USCRS-33527
..... display1..1stringRepresentation defined by the system
Fixed Value: Radiotherapy Treatment Phase (therapy/regime)
..... userSelected0..1booleanIf this coding was chosen directly by the user
.... text0..1stringPlain text representation of the concept
... orderDetail ΣI0..*CodeableConceptAdditional order information
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.


... subject SΣ1..1Reference(US Core Patient Profile)Individual or Entity the service is ordered for
... encounter Σ0..1Reference(Encounter)Encounter in which the request was created
... Slices for occurrence[x] Σ0..1TimingWhen service should occur
Slice: Unordered, Closed by type:$this
.... occurrence[x]:occurrenceTiming SΣ0..1TimingWhen service should occur
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... event Σ0..*dateTimeWhen the event occurs
..... repeat ΣI0..1ElementWhen the event is to occur
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... Slices for bounds[x] Σ0..1PeriodLength/Range of lengths, or (Start and/or end) limits
Slice: Unordered, Closed by type:$this
....... bounds[x]:boundsPeriod Σ0..1PeriodLength/Range of lengths, or (Start and/or end) limits
...... count Σ0..1positiveIntNumber of times to repeat
...... countMax Σ0..1positiveIntMaximum number of times to repeat
...... duration Σ0..1decimalHow long when it happens
...... durationMax Σ0..1decimalHow long when it happens (Max)
...... durationUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... frequency Σ0..1positiveIntEvent occurs frequency times per period
...... frequencyMax Σ0..1positiveIntEvent occurs up to frequencyMax times per period
...... period Σ0..1decimalEvent occurs frequency times per period
...... periodMax Σ0..1decimalUpper limit of period (3-4 hours)
...... periodUnit Σ0..1codes | min | h | d | wk | mo | a - unit of time (UCUM)
Binding: UnitsOfTime (required): A unit of time (units from UCUM).

...... dayOfWeek Σ0..*codemon | tue | wed | thu | fri | sat | sun
Binding: DaysOfWeek (required)
...... timeOfDay Σ0..*timeTime of day for action
...... when Σ0..*codeCode for time period of occurrence
Binding: EventTiming (required): Real world event relating to the schedule.


...... offset Σ0..1unsignedIntMinutes from event (before or after)
..... code Σ0..1CodeableConceptBID | TID | QID | AM | PM | QD | QOD | +
Binding: TimingAbbreviation (preferred): Code for a known / defined timing pattern.

... authoredOn Σ0..1dateTimeDate request signed
... requester SΣ0..1Reference(US Core Practitioner Profile | US Core PractitionerRole Profile | US Core Organization Profile)Who/what is requesting service
... performerType Σ0..1CodeableConceptPerformer 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..*CodeableConceptRequested location
Binding: ServiceDeliveryLocationRoleType (example): A location type where services are delivered.


... locationReference Σ0..*Reference(Location)Requested location
... reasonCode SΣ0..*CodeableConceptExplanation/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..*CodeableConceptBody site that is treated with Radiotherapy
Binding: Radiotherapy Treatment Location Value Set (required)
... note S0..*AnnotationComments
... patientInstruction Σ0..1stringPatient or consumer-oriented instructions
... relevantHistory 0..*Reference(Provenance)Request provenance

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
ServiceRequest.languagepreferredCommonLanguages
Max Binding: AllLanguages
ServiceRequest.extension:modalityAndTechnique.extension:modality.value[x]requiredRadiotherapyModalityVS
ServiceRequest.extension:modalityAndTechnique.extension:technique.value[x]requiredRadiotherapyTechniqueVS
ServiceRequest.identifier.userequiredIdentifierUse
ServiceRequest.identifier.typeextensibleIdentifier Type Codes
ServiceRequest.statusrequiredRequestStatus
ServiceRequest.intentrequiredPattern: original-order
ServiceRequest.categoryexampleServiceRequestCategoryCodes
ServiceRequest.category:requiredexamplePattern: SNOMED CT code 108290001("Radiation oncology AND/OR radiotherapy")
ServiceRequest.priorityrequiredRequestPriority
ServiceRequest.codeexamplePattern: USCRS-33527("Radiotherapy Treatment Phase (therapy/regime)")
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
ServiceRequest.occurrence[x]:occurrenceTiming.repeat.durationUnitrequiredUnitsOfTime
ServiceRequest.occurrence[x]:occurrenceTiming.repeat.periodUnitrequiredUnitsOfTime
ServiceRequest.occurrence[x]:occurrenceTiming.repeat.dayOfWeekrequiredDaysOfWeek
ServiceRequest.occurrence[x]:occurrenceTiming.repeat.whenrequiredEventTiming
ServiceRequest.occurrence[x]:occurrenceTiming.codepreferredTimingAbbreviation
ServiceRequest.performerTypeexampleParticipantRoles
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
ServiceRequest.reasonCodeextensibleCancerDisorderVS
ServiceRequest.bodySiterequiredRadiotherapyTreatmentLocationVS