Patient Care Coordination (PCC) Implementation Guide
0.1.1-current - ci-build United Kingdom flag

Patient Care Coordination (PCC) Implementation Guide, published by Virtually Healthcare. This guide is not an authorized publication; it is the continuous build for version 0.1.1-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Virtually-Healthcare/R4/ and changes regularly. See the Directory of published versions

Resource Profile: ServiceRequest

Official URL: https://fhir.virtually.healthcare/StructureDefinition/ServiceRequest Version: 0.1.1-current
Draft as of 2025-08-14 Computable Name: ServiceRequest

Extension of UKCore-ServiceRequest plus requirements present in NHS England - e-Referral Service - FHIR API and and NHS England - Booking and Referral Standard

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:sourceOfServiceRequest N 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 Service Request (preferred): A set of codes that describe the source of the service request.
.... extension:additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Do not use, not supported. Use CareTeam instead.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... extension:coverage N 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
... Slices for identifier SΣ 0..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PatientPathwayIdentifier SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referrer. (HL7 v2 RF1-6 Originating Referral Identifier)
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... basedOn SΣ 0..* Reference(ServiceRequest) What the service request fulfils.
.... identifier Σ 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referral Booking Service.
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... 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Σ 1..* 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:PatientReferral SΣ 1..1 CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... 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 Content/Rules for all slices
..... extension:priorityReason N 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Σ 1..1 CodeableConcept What is being requested/ordered. (HL7 v2 RF1-3 Referral Type)
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.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:PatientReferralSCT SΣ 1..1 Coding Patient Referral Type UK SNOMED CT
Binding: Patient Referral (extensible)
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
... subject SΣ 1..1 Reference(Patient) The individual or entity the service is ordered for.
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter SΣ 0..1 Reference(Encounter) Encounter in which the request was created
.... identifier OΣ 0..1 HospitalProviderSpellIdentifier Episode or Stay ID (HL7 v2 PV1-19 Visit Number)
ObligationsActor
SHALL:populate-if-known Referral Initiator
SHALL:populate-if-known Referral Recipient
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrencePeriod SΣ 0..1 Period When service should occur
... 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 SΣ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... Slices for performer SΣ 1..* Reference(Practitioner | PractitionerRole | Organization | HealthcareService) Requested performer
Slice: Unordered, Open by value:type
.... performer:Clinician SΣ 0..1 Reference(Practitioner) Requested performer
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Practitioner
..... identifier SΣ 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
.... performer:Service SΣ 0..1 Reference(HealthcareService) Requested performer
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
..... identifier SΣ 0..1 EnglandServiceIdentifier Logical reference, when literal reference is not known
... Slices for supportingInfo S 0..* Reference(Observation Panel | Observation | DiagnosticReport | DocumentReference | Consent) Additional clinical information
Slice: Unordered, Open by value:type
.... supportingInfo:ReferralLetter S 0..1 Reference(DocumentReference) Additional clinical information
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: DocumentReference
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
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:PatientReferralexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
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
ServiceRequest.code.coding:PatientReferralSCTextensiblePatientReferral
https://fhir.virtually.healthcare/ValueSet/PatientReferral
From this IG
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
From the FHIR Standard
ServiceRequest.performer:Clinician.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.performer:Service.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.supportingInfo:ReferralLetter.typeextensiblePattern Value: DocumentReference
http://hl7.org/fhir/ValueSet/resource-types
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 UKCoreServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest UKCoreServiceRequest
... Slices for extension Content/Rules for all slices
.... extension:additionalContact 0..* ExtensionUKCoreAdditionalContact Do not use, not supported. Use CareTeam instead.
... Slices for identifier S 0..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PatientPathwayIdentifier SO 0..1 PatientPathwayIdentifier Identifier assigned by the Referrer. (HL7 v2 RF1-6 Originating Referral Identifier)
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... basedOn 0..* Reference(ServiceRequest) What the service request fulfils.
.... identifier 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition SO 0..1 PatientPathwayIdentifier Identifier assigned by the Referral Booking Service.
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... Slices for category 1..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
.... category:genomicsWholeCaseSequencing 0..0
.... category:PatientReferral S 1..1 CodeableConcept A code that classifies the service for searching, sorting and display purposes.
..... coding
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
... code 1..1 CodeableConcept What is being requested/ordered. (HL7 v2 RF1-3 Referral Type)
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:PatientReferralSCT S 1..1 Coding Patient Referral Type UK SNOMED CT
Binding: Patient Referral (extensible)
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
... subject 1..1 Reference(Patient) The individual or entity the service is ordered for.
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter S 0..1 Reference(Encounter) Encounter in which the request was created
.... identifier O 0..1 HospitalProviderSpellIdentifier Episode or Stay ID (HL7 v2 PV1-19 Visit Number)
ObligationsActor
SHALL:populate-if-known Referral Initiator
SHALL:populate-if-known Referral Recipient
... Slices for occurrence[x] 0..1 dateTime, Period, Timing When service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrencePeriod S 0..1 Period When service should occur
... performerType S 0..1 CodeableConcept Performer role
... Slices for performer S 1..* Reference(Practitioner | PractitionerRole | Organization | HealthcareService) Requested performer
Slice: Unordered, Open by value:type
.... performer:Clinician S 0..1 Reference(Practitioner) Requested performer
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Practitioner
..... identifier S 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
.... performer:Service S 0..1 Reference(HealthcareService) Requested performer
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: HealthcareService
..... identifier S 0..1 EnglandServiceIdentifier Logical reference, when literal reference is not known
... Slices for supportingInfo S 0..* Reference(Observation Panel | Observation | DiagnosticReport | DocumentReference | Consent) Additional clinical information
Slice: Unordered, Open by value:type
.... supportingInfo:ReferralLetter S 0..1 Reference(DocumentReference) Additional clinical information
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: DocumentReference
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.code.coding:PatientReferralSCTextensiblePatientReferral
https://fhir.virtually.healthcare/ValueSet/PatientReferral
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
Constraints: prr-1
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:sourceOfServiceRequest N 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 Service Request (preferred): A set of codes that describe the source of the service request.
.... extension:additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Do not use, not supported. Use CareTeam instead.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... extension:coverage N 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
... Slices for identifier SΣ 0..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PatientPathwayIdentifier SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referrer. (HL7 v2 RF1-6 Originating Referral Identifier)
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(ServiceRequest) What the service request fulfils.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referral Booking Service.
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... 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Σ 1..* 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:PatientReferral SΣ 1..1 CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
..... 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
Required Pattern: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... 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 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:priorityReason N 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Σ 1..1 CodeableConcept What is being requested/ordered. (HL7 v2 RF1-3 Referral Type)
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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:PatientReferralSCT SΣ 1..1 Coding Patient Referral Type UK SNOMED CT
Binding: Patient Referral (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
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... 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
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient) The individual or entity the service is ordered for.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter SΣ 0..1 Reference(Encounter) Encounter in which the request was created
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier OΣ 0..1 HospitalProviderSpellIdentifier Episode or Stay ID (HL7 v2 PV1-19 Visit Number)
ObligationsActor
SHALL:populate-if-known Referral Initiator
SHALL:populate-if-known Referral Recipient
.... display Σ 0..1 string Text alternative for the resource
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrencePeriod SΣ 0..1 Period When service should occur
... 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 SΣ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... Slices for performer SΣ 1..* Reference(Practitioner | PractitionerRole | Organization | HealthcareService) Requested performer
Slice: Unordered, Open by value:type
.... performer:Clinician SΣ 0..1 Reference(Practitioner) Requested performer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Practitioner
..... identifier SΣ 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... performer:Service SΣ 0..1 Reference(HealthcareService) Requested performer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
..... identifier SΣ 0..1 EnglandServiceIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... 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
... Slices for supportingInfo S 0..* Reference(Observation Panel | Observation | DiagnosticReport | DocumentReference | Consent) Additional clinical information
Slice: Unordered, Open by value:type
.... supportingInfo:ReferralLetter S 0..1 Reference(DocumentReference) Additional clinical information
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: DocumentReference
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.
... note S 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

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.basedOn.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
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:PatientReferralexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
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
ServiceRequest.code.coding:PatientReferralSCTextensiblePatientReferral
https://fhir.virtually.healthcare/ValueSet/PatientReferral
From this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
ServiceRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
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.performer:Clinician.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.performer:Service.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
ServiceRequest.supportingInfo:ReferralLetter.typeextensiblePattern Value: DocumentReference
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
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 UKCoreServiceRequest

Summary

Mandatory: 7 elements(4 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.category
  • The element 1 is sliced based on the value of ServiceRequest.code.coding
  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]
  • The element 1 is sliced based on the value of ServiceRequest.performer
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:sourceOfServiceRequest N 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 Service Request (preferred): A set of codes that describe the source of the service request.
.... extension:additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Do not use, not supported. Use CareTeam instead.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... extension:coverage N 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
... Slices for identifier SΣ 0..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PatientPathwayIdentifier SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referrer. (HL7 v2 RF1-6 Originating Referral Identifier)
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... basedOn SΣ 0..* Reference(ServiceRequest) What the service request fulfils.
.... identifier Σ 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referral Booking Service.
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... 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Σ 1..* 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:PatientReferral SΣ 1..1 CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... 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 Content/Rules for all slices
..... extension:priorityReason N 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Σ 1..1 CodeableConcept What is being requested/ordered. (HL7 v2 RF1-3 Referral Type)
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.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:PatientReferralSCT SΣ 1..1 Coding Patient Referral Type UK SNOMED CT
Binding: Patient Referral (extensible)
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
... subject SΣ 1..1 Reference(Patient) The individual or entity the service is ordered for.
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter SΣ 0..1 Reference(Encounter) Encounter in which the request was created
.... identifier OΣ 0..1 HospitalProviderSpellIdentifier Episode or Stay ID (HL7 v2 PV1-19 Visit Number)
ObligationsActor
SHALL:populate-if-known Referral Initiator
SHALL:populate-if-known Referral Recipient
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrencePeriod SΣ 0..1 Period When service should occur
... 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 SΣ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... Slices for performer SΣ 1..* Reference(Practitioner | PractitionerRole | Organization | HealthcareService) Requested performer
Slice: Unordered, Open by value:type
.... performer:Clinician SΣ 0..1 Reference(Practitioner) Requested performer
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Practitioner
..... identifier SΣ 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
.... performer:Service SΣ 0..1 Reference(HealthcareService) Requested performer
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
..... identifier SΣ 0..1 EnglandServiceIdentifier Logical reference, when literal reference is not known
... Slices for supportingInfo S 0..* Reference(Observation Panel | Observation | DiagnosticReport | DocumentReference | Consent) Additional clinical information
Slice: Unordered, Open by value:type
.... supportingInfo:ReferralLetter S 0..1 Reference(DocumentReference) Additional clinical information
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: DocumentReference
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
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:PatientReferralexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
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
ServiceRequest.code.coding:PatientReferralSCTextensiblePatientReferral
https://fhir.virtually.healthcare/ValueSet/PatientReferral
From this IG
ServiceRequest.performerTypeexampleParticipantRoles
http://hl7.org/fhir/ValueSet/participant-role
From the FHIR Standard
ServiceRequest.performer:Clinician.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.performer:Service.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.supportingInfo:ReferralLetter.typeextensiblePattern Value: DocumentReference
http://hl7.org/fhir/ValueSet/resource-types
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()

Differential View

This structure is derived from UKCoreServiceRequest

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest UKCoreServiceRequest
... Slices for extension Content/Rules for all slices
.... extension:additionalContact 0..* ExtensionUKCoreAdditionalContact Do not use, not supported. Use CareTeam instead.
... Slices for identifier S 0..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PatientPathwayIdentifier SO 0..1 PatientPathwayIdentifier Identifier assigned by the Referrer. (HL7 v2 RF1-6 Originating Referral Identifier)
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... basedOn 0..* Reference(ServiceRequest) What the service request fulfils.
.... identifier 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition SO 0..1 PatientPathwayIdentifier Identifier assigned by the Referral Booking Service.
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... Slices for category 1..* CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Slice: Unordered, Open by value:coding.system
.... category:genomicsWholeCaseSequencing 0..0
.... category:PatientReferral S 1..1 CodeableConcept A code that classifies the service for searching, sorting and display purposes.
..... coding
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... code 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
... code 1..1 CodeableConcept What is being requested/ordered. (HL7 v2 RF1-3 Referral Type)
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:PatientReferralSCT S 1..1 Coding Patient Referral Type UK SNOMED CT
Binding: Patient Referral (extensible)
...... system 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
... subject 1..1 Reference(Patient) The individual or entity the service is ordered for.
.... reference S 0..1 string Literal reference, Relative, internal or absolute URL
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter S 0..1 Reference(Encounter) Encounter in which the request was created
.... identifier O 0..1 HospitalProviderSpellIdentifier Episode or Stay ID (HL7 v2 PV1-19 Visit Number)
ObligationsActor
SHALL:populate-if-known Referral Initiator
SHALL:populate-if-known Referral Recipient
... Slices for occurrence[x] 0..1 dateTime, Period, Timing When service should occur
Slice: Unordered, Open by type:$this
.... occurrence[x]:occurrencePeriod S 0..1 Period When service should occur
... performerType S 0..1 CodeableConcept Performer role
... Slices for performer S 1..* Reference(Practitioner | PractitionerRole | Organization | HealthcareService) Requested performer
Slice: Unordered, Open by value:type
.... performer:Clinician S 0..1 Reference(Practitioner) Requested performer
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: Practitioner
..... identifier S 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
.... performer:Service S 0..1 Reference(HealthcareService) Requested performer
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: HealthcareService
..... identifier S 0..1 EnglandServiceIdentifier Logical reference, when literal reference is not known
... Slices for supportingInfo S 0..* Reference(Observation Panel | Observation | DiagnosticReport | DocumentReference | Consent) Additional clinical information
Slice: Unordered, Open by value:type
.... supportingInfo:ReferralLetter S 0..1 Reference(DocumentReference) Additional clinical information
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: DocumentReference
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.code.coding:PatientReferralSCTextensiblePatientReferral
https://fhir.virtually.healthcare/ValueSet/PatientReferral
From this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* UKCoreServiceRequest A request for a service to be performed
Constraints: prr-1
... 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
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... extension:sourceOfServiceRequest N 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 Service Request (preferred): A set of codes that describe the source of the service request.
.... extension:additionalContact 0..* Reference(Organization | Practitioner | PractitionerRole) Do not use, not supported. Use CareTeam instead.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AdditionalContact
.... extension:coverage N 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
... Slices for identifier SΣ 0..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PatientPathwayIdentifier SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referrer. (HL7 v2 RF1-6 Originating Referral Identifier)
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(ServiceRequest) What the service request fulfils.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... replaces Σ 0..* Reference(ServiceRequest) What request replaces
... requisition SOΣ 0..1 PatientPathwayIdentifier Identifier assigned by the Referral Booking Service.
ObligationsActor
SHOULD:populate-if-known Referral Recipient
SHALL:populate Referral Initiator
... 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Σ 1..* 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:PatientReferral SΣ 1..1 CodeableConcept A code that classifies the service for searching, sorting and display purposes.
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
..... 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
Required Pattern: http://snomed.info/sct
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code Symbol in syntax defined by the system
Required Pattern: 3457005
...... 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 Additional content defined by implementations
Slice: Unordered, Open by value:url
..... extension:priorityReason N 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Σ 1..1 CodeableConcept What is being requested/ordered. (HL7 v2 RF1-3 Referral Type)
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.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:PatientReferralSCT SΣ 1..1 Coding Patient Referral Type UK SNOMED CT
Binding: Patient Referral (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
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: http://snomed.info/sct
...... 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
... orderDetail ΣC 0..* CodeableConcept Additional order information
Binding: UK Core Procedure Code (preferred): Codified order entry details which are based on order context.
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient) The individual or entity the service is ordered for.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter SΣ 0..1 Reference(Encounter) Encounter in which the request was created
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier OΣ 0..1 HospitalProviderSpellIdentifier Episode or Stay ID (HL7 v2 PV1-19 Visit Number)
ObligationsActor
SHALL:populate-if-known Referral Initiator
SHALL:populate-if-known Referral Recipient
.... display Σ 0..1 string Text alternative for the resource
... Slices for occurrence[x] Σ 0..1 When service should occur
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrencePeriod SΣ 0..1 Period When service should occur
... 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 SΣ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... Slices for performer SΣ 1..* Reference(Practitioner | PractitionerRole | Organization | HealthcareService) Requested performer
Slice: Unordered, Open by value:type
.... performer:Clinician SΣ 0..1 Reference(Practitioner) Requested performer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: Practitioner
..... identifier SΣ 0..1 PractitionerIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... performer:Service SΣ 0..1 Reference(HealthcareService) Requested performer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: HealthcareService
..... identifier SΣ 0..1 EnglandServiceIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... 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
... Slices for supportingInfo S 0..* Reference(Observation Panel | Observation | DiagnosticReport | DocumentReference | Consent) Additional clinical information
Slice: Unordered, Open by value:type
.... supportingInfo:ReferralLetter S 0..1 Reference(DocumentReference) Additional clinical information
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... reference ΣC 0..1 string Literal reference, Relative, internal or absolute URL
..... type Σ 1..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Required Pattern: DocumentReference
..... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
... specimen Σ 0..* Reference(Specimen) Procedure Samples
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (preferred): Codes describing anatomical locations. May include laterality.
... note S 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

PathConformanceValueSet / CodeURI
ServiceRequest.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ServiceRequest.basedOn.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
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:PatientReferralexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
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
ServiceRequest.code.coding:PatientReferralSCTextensiblePatientReferral
https://fhir.virtually.healthcare/ValueSet/PatientReferral
From this IG
ServiceRequest.orderDetailpreferredUKCoreProcedureCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ProcedureCode
ServiceRequest.subject.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.encounter.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
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.performer:Clinician.typeextensiblePattern Value: Practitioner
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.performer:Service.typeextensiblePattern Value: HealthcareService
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredUKCoreServiceRequestReasonCode
https://fhir.hl7.org.uk/ValueSet/UKCore-ServiceRequestReasonCode
ServiceRequest.supportingInfo:ReferralLetter.typeextensiblePattern Value: DocumentReference
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
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 UKCoreServiceRequest

Summary

Mandatory: 7 elements(4 nested mandatory elements)
Must-Support: 18 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ServiceRequest.identifier
  • The element 1 is sliced based on the value of ServiceRequest.category
  • The element 1 is sliced based on the value of ServiceRequest.code.coding
  • The element 1 is sliced based on the value of ServiceRequest.occurrence[x]
  • The element 1 is sliced based on the value of ServiceRequest.performer
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

 

Other representations of profile: CSV, Excel, Schematron