Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: UK Core ServiceRequest

Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-ServiceRequest Version: 2.5.0
Active as of 2023-12-12 Computable Name: UKCoreServiceRequest

Copyright/Legal: Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.

This profile defines the UK constraints and extensions on the International FHIR resource ServiceRequest.

This profile is a record of a request for a procedure or diagnostic or other service to be planned, proposed, or performed, as distinguished by the ServiceRequest.intent field value, with or on a patient.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ServiceRequest
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.

.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.

... basedOn S 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What the service request fulfils.
... status S 1..1 code The status of the order.
... Slices for category S 0..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
.... category:genomicsWholeCaseSequencing 0..* CodeableConcept Classification of Genomics service
Binding: UK Core Genome Sequencing Category (extensible)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory
... priority S 0..1 code Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


... code S 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... orderDetail 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred)
... subject S 1..1 Reference(Patient | Group | Location | Device) The individual or entity the service is ordered for.
... authoredOn S 0..1 dateTime The date the request was signed.
... requester S 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... reasonCode 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request.

... bodySite 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.category:genomicsWholeCaseSequencingextensibleUKCoreGenomeSequencingCategory (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory)
https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory
from this IG
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
from this IG
ServiceRequest.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code The status of the order.
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ 0..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:genomicsWholeCaseSequencing Σ 0..* CodeableConcept Classification of Genomics service
Binding: UK Core Genome Sequencing Category (extensible)
... priority SΣ 0..1 code Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred)
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) The individual or entity the service is ordered for.
... authoredOn SΣ 0..1 dateTime The date the request was signed.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request.


... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:genomicsWholeCaseSequencingextensibleUKCoreGenomeSequencingCategory (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory)
https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
from this IG
ServiceRequest.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifiers assigned to this order
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What the service request fulfils.
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code The status of the order.
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ 0..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:genomicsWholeCaseSequencing Σ 0..* CodeableConcept Classification of Genomics service
Binding: UK Core Genome Sequencing Category (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... priority SΣ 0..1 code Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


.... value 0..1 string Primitive value for code
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred)
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) The individual or entity the service is ordered for.
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... occurrence[x] Σ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SΣ 0..1 dateTime The date the request was signed.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the 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 Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request.


... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.


... note 0..* Annotation Comments
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:genomicsWholeCaseSequencingextensibleUKCoreGenomeSequencingCategory (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory)
https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
from this IG
ServiceRequest.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 9 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.category

Differential View

This structure is derived from ServiceRequest

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest ServiceRequest
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.

.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.

... basedOn S 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What the service request fulfils.
... status S 1..1 code The status of the order.
... Slices for category S 0..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
.... category:genomicsWholeCaseSequencing 0..* CodeableConcept Classification of Genomics service
Binding: UK Core Genome Sequencing Category (extensible)
..... coding
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory
... priority S 0..1 code Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


... code S 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... orderDetail 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred)
... subject S 1..1 Reference(Patient | Group | Location | Device) The individual or entity the service is ordered for.
... authoredOn S 0..1 dateTime The date the request was signed.
... requester S 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... reasonCode 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request.

... bodySite 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.


doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.category:genomicsWholeCaseSequencingextensibleUKCoreGenomeSequencingCategory (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory)
https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory
from this IG
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
from this IG
ServiceRequest.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!SΣ 1..1 code The status of the order.
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ 0..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:genomicsWholeCaseSequencing Σ 0..* CodeableConcept Classification of Genomics service
Binding: UK Core Genome Sequencing Category (extensible)
... priority SΣ 0..1 code Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred)
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) The individual or entity the service is ordered for.
... authoredOn SΣ 0..1 dateTime The date the request was signed.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the service
... reasonCode Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request.


... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:genomicsWholeCaseSequencingextensibleUKCoreGenomeSequencingCategory (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory)
https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
from this IG
ServiceRequest.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ServiceRequest C 0..* ServiceRequest A request for a service to be performed
prr-1: orderDetail SHALL only be present if code is present
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... sourceOfServiceRequest 0..1 CodeableConcept Describes the source of the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-SourceOfServiceRequest
Binding: UK Core Source Of ServiceRequest (preferred): A set of codes that describe the source of the service request.


.... additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Supports recording of additional contacts, who should be contacted regarding questions arising from the service request. This differs from the requester and responsibleClinician.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... coverage 0..1 CodeableConcept Supports the exchange of information describing the method of funding for the Service Request.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-Coverage
Binding: UK Core Funding Category (extensible): A set of codes that define the funding category for a service request.


... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Identifiers assigned to this order
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(CarePlan | ServiceRequest | MedicationRequest) What the service request fulfils.
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition Σ 0..1 Identifier Composite Request ID
... status ?!SΣ 1..1 code The status of the order.
Binding: RequestStatus (required): The status of a service order.

... intent ?!SΣ 1..1 code Whether the request is a proposal, plan, an original order or a reflex order.
Binding: RequestIntent (required): The kind of service request.

... Slices for category SΣ 0..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.


.... category:genomicsWholeCaseSequencing Σ 0..* CodeableConcept Classification of Genomics service
Binding: UK Core Genome Sequencing Category (extensible)
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 0..* Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
...... display Σ 0..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... text Σ 0..1 string Plain text representation of the concept
... priority SΣ 0..1 code Indicates how quickly the ServiceRequest should be addressed with respect to other requests.
Binding: RequestPriority (required): Identifies the level of importance to be assigned to actioning the request.

.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... priorityReason 0..* CodeableConcept Supports the underlying reason why a Service Request is urgent.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PriorityReason
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define the reason why a service request is urgent.


.... value 0..1 string Primitive value for code
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 0..1 CodeableConcept What is being requested/ordered.
Binding: UK Core Procedure Code (preferred): A set of codes that define a procedure or a procedure with explicit context. Selected from the SNOMED CT UK coding system.

... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred)
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient | Group | Location | Device) The individual or entity the service is ordered for.
... encounter Σ 0..1 Reference(Encounter) Encounter in which the request was created
... occurrence[x] Σ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... asNeeded[x] Σ 0..1 Preconditions for service
Binding: SNOMEDCTMedicationAsNeededReasonCodes (example): A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc.

.... asNeededBoolean boolean
.... asNeededCodeableConcept CodeableConcept
... authoredOn SΣ 0..1 dateTime The date the request was signed.
... requester SΣ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device) Who / what is requesting the 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 Σ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: UK Core Service Request Reason Code (preferred): A set of codes that define a reason for a service request.


... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage | ClaimResponse) Associated insurance coverage
... supportingInfo 0..* Reference(Resource) Additional clinical information
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.


... note 0..* Annotation Comments
... patientInstruction Σ 0..1 string Patient or consumer-oriented instructions
... relevantHistory 0..* Reference(Provenance) Request provenance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ServiceRequest.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ServiceRequest.statusrequiredRequestStatus
http://hl7.org/fhir/ValueSet/request-status|4.0.1
from the FHIR Standard
ServiceRequest.intentrequiredRequestIntent
http://hl7.org/fhir/ValueSet/request-intent|4.0.1
from the FHIR Standard
ServiceRequest.categoryexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
from the FHIR Standard
ServiceRequest.category:genomicsWholeCaseSequencingextensibleUKCoreGenomeSequencingCategory (a valid code from https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory)
https://fhir.hl7.org.uk/ValueSet/UKCore-GenomeSequencingCategory
from this IG
ServiceRequest.priorityrequiredRequestPriority
http://hl7.org/fhir/ValueSet/request-priority|4.0.1
from the FHIR Standard
ServiceRequest.codepreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
from this IG
ServiceRequest.asNeeded[x]exampleSNOMEDCTMedicationAsNeededReasonCodes
http://hl7.org/fhir/ValueSet/medication-as-needed-reason
from the FHIR Standard
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
from the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
from this IG
ServiceRequest.bodySitepreferredSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorServiceRequestIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorServiceRequestIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorServiceRequestIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceServiceRequestA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
prr-1errorServiceRequestorderDetail SHALL only be present if code is present
: orderDetail.empty() or code.exists()

This structure is derived from ServiceRequest

Summary

Mandatory: 0 element(1 nested mandatory element)
Must-Support: 9 elements
Fixed: 1 element

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.category

 

Other representations of profile: CSV, Excel, Schematron