North West Genomic Medicine Service Alliance
0.0.7 - ci-build United Kingdom flag

North West Genomic Medicine Service Alliance, published by NHS North West GMSA. This guide is not an authorized publication; it is the continuous build for version 0.0.7 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nw-gmsa/R4/ and changes regularly. See the Directory of published versions

Resource Profile: ServiceRequest

Official URL: https://nw-gmsa.github.io/StructureDefinition/ServiceRequest Version: 0.0.7
Draft as of 2025-09-04 Computable Name: ServiceRequest

HL7 v2 ORC mapping ORC to ServiceRequest

Reference:

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.

This structure is derived from ServiceRequestLabEu

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequestLabEu Laboratory Order
... Slices for identifier S 1..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PlacerOrderNumber SO 0..1 PlacerOrderNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-2/OBR-2 Placer Order Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
.... identifier:FillerOrderNumber SO 0..1 FillerOrderNumber Identifier assigned by the lab (Order Filler)
ObligationsActor
SHALL:populate Order Filler
SHOULD:populate-if-known Order Placer
SHOULD:populate-if-known Automation Manager
... basedOn S 0..* Reference(ServiceRequest) SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario
.... identifier 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition O 0..1 PlacerGroupNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-4 Placer Group Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
... Slices for category S 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:coding.system
.... category:GenomicProcedure S 0..1 CodeableConcept Classification of service
..... 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: 116148004
.... category:GenomicsWholeCaseSequencing S 0..1 CodeableConcept Classification of service
..... coding
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory
... priority 0..1 code routine | urgent | asap | stat
Binding: Request Priority (required)
... code S 1..1 CodeableConcept See [National Genomic Test Directory](https://www.england.nhs.uk/wp-content/uploads/2018/08/rare-and-inherited-disease-eligibility-criteria-v2.pdf).
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory S 1..1 Coding Genomic Test Directory
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... orderDetail S 0..* CodeableConcept Additional order codes
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory S 1..1 Coding Genomic Test Directory
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... subject S 1..1 Reference(Patient) Individual or Entity the service is ordered for
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter S 0..1 Reference(Encounter) A reference identifier to the episode/stay/visit number in which the request was created. (HL7 v2 PV1-19)
.... identifier SO 0..1 HospitalProviderSpellIdentifier Logical reference, when literal reference is not known
ObligationsActor
SHALL:populate-if-known Order Filler
SHALL:populate-if-known Order Placer
SHALL:populate-if-known Automation Manager
... occurrence[x] S 0..1 dateTime, Period, Timing When service should occur
... authoredOn S 1..1 dateTime When the order was placed
... requester S 1..1 Reference(PractitionerRole) Who/what is requesting service
... performer 0..* Reference(Organization) Requested performer
.... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known
... reasonCode S 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Genomic Condition Codes (preferred)
... Slices for supportingInfo S 0..* Reference(Resource) Additional information: e.g AOEs and prior results
Slice: Unordered, Open by value:type
.... supportingInfo:PriorResult S 0..1 Reference(Diagnostic Report) Equivalent of HL7 v2 OML_O21 PRIOR RESULT (as PDF)
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: DiagnosticReport
..... identifier S 1..1 CorrelationIdentifier Logical reference, when literal reference is not known
.... supportingInfo:PatientSummary S 0..1 Reference(DocumentReference) Additional information: e.g AOEs and prior results
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: DocumentReference
... specimen S 1..* Reference(Specimen: Laboratory) Specimens to be used by the laboratory procedure
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.priorityrequiredRequestPriority
https://nw-gmsa.github.io/ValueSet/RequestPriority
From this IG
ServiceRequest.reasonCodepreferredGenomicConditionCodes(a valid code from Genomic Condition Code)
https://nw-gmsa.github.io/ValueSet/genomic-condition-codes
From this IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequestLabEu Laboratory Order
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PlacerOrderNumber SOΣ 0..1 PlacerOrderNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-2/OBR-2 Placer Order Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
.... identifier:FillerOrderNumber SOΣ 0..1 FillerOrderNumber Identifier assigned by the lab (Order Filler)
ObligationsActor
SHALL:populate Order Filler
SHOULD:populate-if-known Order Placer
SHOULD:populate-if-known Automation Manager
... basedOn SΣ 0..* Reference(ServiceRequest) SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario
.... identifier Σ 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition OΣ 0..1 PlacerGroupNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-4 Placer Group Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:GenomicProcedure SΣ 0..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:GenomicsWholeCaseSequencing SΣ 0..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: Request Priority (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept See [National Genomic Test Directory](https://www.england.nhs.uk/wp-content/uploads/2018/08/rare-and-inherited-disease-eligibility-criteria-v2.pdf).
Binding: Laboratory Order (preferred)
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... orderDetail SΣC 0..* CodeableConcept Additional order codes
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... subject SΣ 1..1 Reference(Patient) Individual or Entity the service is ordered for
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter SΣ 0..1 Reference(Encounter) A reference identifier to the episode/stay/visit number in which the request was created. (HL7 v2 PV1-19)
.... identifier SOΣ 0..1 HospitalProviderSpellIdentifier Logical reference, when literal reference is not known
ObligationsActor
SHALL:populate-if-known Order Filler
SHALL:populate-if-known Order Placer
SHALL:populate-if-known Automation Manager
... occurrence[x] SΣ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣ 1..1 dateTime When the order was placed
... requester SΣ 1..1 Reference(PractitionerRole) Who/what is requesting service
... performer Σ 0..* Reference(Organization) Requested performer
.... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
... reasonCode SΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Genomic Condition Codes (preferred)
... Slices for supportingInfo S 0..* Reference(Resource) Additional information: e.g AOEs and prior results
Slice: Unordered, Open by value:type
.... supportingInfo:PriorResult S 0..1 Reference(Diagnostic Report) Equivalent of HL7 v2 OML_O21 PRIOR RESULT (as PDF)
..... 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: DiagnosticReport
..... identifier SΣ 1..1 CorrelationIdentifier Logical reference, when literal reference is not known
.... supportingInfo:PatientSummary S 0..1 Reference(DocumentReference) Additional information: e.g AOEs and prior results
..... 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
... specimen SΣ 1..* Reference(Specimen: Laboratory) Specimens to be used by the laboratory procedure
... 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:GenomicProcedureexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.category:GenomicsWholeCaseSequencingexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
https://nw-gmsa.github.io/ValueSet/RequestPriority
From this IG
ServiceRequest.codepreferredLabOrderCodesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-orderCodes-eu-lab
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
ServiceRequest.reasonCodepreferredGenomicConditionCodes(a valid code from Genomic Condition Code)
https://nw-gmsa.github.io/ValueSet/genomic-condition-codes
From this IG
ServiceRequest.supportingInfo:PriorResult.typeextensiblePattern Value: DiagnosticReport
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.supportingInfo:PatientSummary.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()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequestLabEu Laboratory Order
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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PlacerOrderNumber SOΣ 0..1 PlacerOrderNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-2/OBR-2 Placer Order Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
.... identifier:FillerOrderNumber SOΣ 0..1 FillerOrderNumber Identifier assigned by the lab (Order Filler)
ObligationsActor
SHALL:populate Order Filler
SHOULD:populate-if-known Order Placer
SHOULD:populate-if-known Automation Manager
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(ServiceRequest) SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario
.... 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 OΣ 0..1 PlacerGroupNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-4 Placer Group Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:GenomicProcedure SΣ 0..1 CodeableConcept Classification of service
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: 116148004
...... 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
.... category:GenomicsWholeCaseSequencing SΣ 0..1 CodeableConcept Classification of service
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: 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 Σ 0..1 code routine | urgent | asap | stat
Binding: Request Priority (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept See [National Genomic Test Directory](https://www.england.nhs.uk/wp-content/uploads/2018/08/rare-and-inherited-disease-eligibility-criteria-v2.pdf).
Binding: Laboratory Order (preferred)
.... 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:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... 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: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
...... 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 SΣC 0..* CodeableConcept Additional order codes
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... 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:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... 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: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
...... 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
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient) 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 Σ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) A reference identifier to the episode/stay/visit number in which the request was created. (HL7 v2 PV1-19)
.... 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 SOΣ 0..1 HospitalProviderSpellIdentifier Logical reference, when literal reference is not known
ObligationsActor
SHALL:populate-if-known Order Filler
SHALL:populate-if-known Order Placer
SHALL:populate-if-known Automation Manager
.... display Σ 0..1 string Text alternative for the resource
... occurrence[x] SΣ 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Σ 1..1 dateTime When the order was placed
... requester SΣ 1..1 Reference(PractitionerRole) Who/what is requesting service
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..* Reference(Organization) 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 Σ 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 OrganisationCode 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 SΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Genomic Condition Codes (preferred)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage) Associated insurance coverage
... Slices for supportingInfo S 0..* Reference(Resource) Additional information: e.g AOEs and prior results
Slice: Unordered, Open by value:type
.... supportingInfo:PriorResult S 0..1 Reference(Diagnostic Report) Equivalent of HL7 v2 OML_O21 PRIOR RESULT (as PDF)
..... 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: DiagnosticReport
..... identifier SΣ 1..1 CorrelationIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... supportingInfo:PatientSummary S 0..1 Reference(DocumentReference) Additional information: e.g AOEs and prior results
..... 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 SΣ 1..* Reference(Specimen: Laboratory) Specimens to be used by the laboratory procedure
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): 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:GenomicProcedureexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.category:GenomicsWholeCaseSequencingexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
https://nw-gmsa.github.io/ValueSet/RequestPriority
From this IG
ServiceRequest.codepreferredLabOrderCodesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-orderCodes-eu-lab
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
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.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredGenomicConditionCodes(a valid code from Genomic Condition Code)
https://nw-gmsa.github.io/ValueSet/genomic-condition-codes
From this IG
ServiceRequest.supportingInfo:PriorResult.typeextensiblePattern Value: DiagnosticReport
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.supportingInfo:PatientSummary.typeextensiblePattern Value: DocumentReference
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
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 ServiceRequestLabEu

Summary

Mandatory: 8 elements(8 nested mandatory elements)
Must-Support: 26 elements

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.orderDetail.coding
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

Differential View

This structure is derived from ServiceRequestLabEu

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest 0..* ServiceRequestLabEu Laboratory Order
... Slices for identifier S 1..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PlacerOrderNumber SO 0..1 PlacerOrderNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-2/OBR-2 Placer Order Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
.... identifier:FillerOrderNumber SO 0..1 FillerOrderNumber Identifier assigned by the lab (Order Filler)
ObligationsActor
SHALL:populate Order Filler
SHOULD:populate-if-known Order Placer
SHOULD:populate-if-known Automation Manager
... basedOn S 0..* Reference(ServiceRequest) SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario
.... identifier 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition O 0..1 PlacerGroupNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-4 Placer Group Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
... Slices for category S 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:coding.system
.... category:GenomicProcedure S 0..1 CodeableConcept Classification of service
..... 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: 116148004
.... category:GenomicsWholeCaseSequencing S 0..1 CodeableConcept Classification of service
..... coding
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.hl7.org.uk/CodeSystem/UKCore-GenomeSequencingCategory
... priority 0..1 code routine | urgent | asap | stat
Binding: Request Priority (required)
... code S 1..1 CodeableConcept See [National Genomic Test Directory](https://www.england.nhs.uk/wp-content/uploads/2018/08/rare-and-inherited-disease-eligibility-criteria-v2.pdf).
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory S 1..1 Coding Genomic Test Directory
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... orderDetail S 0..* CodeableConcept Additional order codes
.... Slices for coding S 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory S 1..1 Coding Genomic Test Directory
...... system 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... subject S 1..1 Reference(Patient) Individual or Entity the service is ordered for
.... identifier 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter S 0..1 Reference(Encounter) A reference identifier to the episode/stay/visit number in which the request was created. (HL7 v2 PV1-19)
.... identifier SO 0..1 HospitalProviderSpellIdentifier Logical reference, when literal reference is not known
ObligationsActor
SHALL:populate-if-known Order Filler
SHALL:populate-if-known Order Placer
SHALL:populate-if-known Automation Manager
... occurrence[x] S 0..1 dateTime, Period, Timing When service should occur
... authoredOn S 1..1 dateTime When the order was placed
... requester S 1..1 Reference(PractitionerRole) Who/what is requesting service
... performer 0..* Reference(Organization) Requested performer
.... identifier 0..1 OrganisationCode Logical reference, when literal reference is not known
... reasonCode S 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Genomic Condition Codes (preferred)
... Slices for supportingInfo S 0..* Reference(Resource) Additional information: e.g AOEs and prior results
Slice: Unordered, Open by value:type
.... supportingInfo:PriorResult S 0..1 Reference(Diagnostic Report) Equivalent of HL7 v2 OML_O21 PRIOR RESULT (as PDF)
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: DiagnosticReport
..... identifier S 1..1 CorrelationIdentifier Logical reference, when literal reference is not known
.... supportingInfo:PatientSummary S 0..1 Reference(DocumentReference) Additional information: e.g AOEs and prior results
..... type 1..1 uri Type the reference refers to (e.g. "Patient")
Required Pattern: DocumentReference
... specimen S 1..* Reference(Specimen: Laboratory) Specimens to be used by the laboratory procedure
... note S 0..* Annotation Comments

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ServiceRequest.priorityrequiredRequestPriority
https://nw-gmsa.github.io/ValueSet/RequestPriority
From this IG
ServiceRequest.reasonCodepreferredGenomicConditionCodes(a valid code from Genomic Condition Code)
https://nw-gmsa.github.io/ValueSet/genomic-condition-codes
From this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequestLabEu Laboratory Order
Constraints: prr-1
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PlacerOrderNumber SOΣ 0..1 PlacerOrderNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-2/OBR-2 Placer Order Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
.... identifier:FillerOrderNumber SOΣ 0..1 FillerOrderNumber Identifier assigned by the lab (Order Filler)
ObligationsActor
SHALL:populate Order Filler
SHOULD:populate-if-known Order Placer
SHOULD:populate-if-known Automation Manager
... basedOn SΣ 0..* Reference(ServiceRequest) SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario
.... identifier Σ 0..1 CorrelationIdentifier Logical reference, when literal reference is not known
... requisition OΣ 0..1 PlacerGroupNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-4 Placer Group Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:GenomicProcedure SΣ 0..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:GenomicsWholeCaseSequencing SΣ 0..1 CodeableConcept Classification of service
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
... priority Σ 0..1 code routine | urgent | asap | stat
Binding: Request Priority (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept See [National Genomic Test Directory](https://www.england.nhs.uk/wp-content/uploads/2018/08/rare-and-inherited-disease-eligibility-criteria-v2.pdf).
Binding: Laboratory Order (preferred)
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... orderDetail SΣC 0..* CodeableConcept Additional order codes
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... Slices for coding SΣ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... system Σ 1..1 uri Identity of the terminology system
Required Pattern: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
... subject SΣ 1..1 Reference(Patient) Individual or Entity the service is ordered for
.... identifier Σ 0..1 NHSNumber Logical reference, when literal reference is not known
... encounter SΣ 0..1 Reference(Encounter) A reference identifier to the episode/stay/visit number in which the request was created. (HL7 v2 PV1-19)
.... identifier SOΣ 0..1 HospitalProviderSpellIdentifier Logical reference, when literal reference is not known
ObligationsActor
SHALL:populate-if-known Order Filler
SHALL:populate-if-known Order Placer
SHALL:populate-if-known Automation Manager
... occurrence[x] SΣ 0..1 When service should occur
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
... authoredOn SΣ 1..1 dateTime When the order was placed
... requester SΣ 1..1 Reference(PractitionerRole) Who/what is requesting service
... performer Σ 0..* Reference(Organization) Requested performer
.... identifier Σ 0..1 OrganisationCode Logical reference, when literal reference is not known
... reasonCode SΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Genomic Condition Codes (preferred)
... Slices for supportingInfo S 0..* Reference(Resource) Additional information: e.g AOEs and prior results
Slice: Unordered, Open by value:type
.... supportingInfo:PriorResult S 0..1 Reference(Diagnostic Report) Equivalent of HL7 v2 OML_O21 PRIOR RESULT (as PDF)
..... 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: DiagnosticReport
..... identifier SΣ 1..1 CorrelationIdentifier Logical reference, when literal reference is not known
.... supportingInfo:PatientSummary S 0..1 Reference(DocumentReference) Additional information: e.g AOEs and prior results
..... 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
... specimen SΣ 1..* Reference(Specimen: Laboratory) Specimens to be used by the laboratory procedure
... 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:GenomicProcedureexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.category:GenomicsWholeCaseSequencingexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
https://nw-gmsa.github.io/ValueSet/RequestPriority
From this IG
ServiceRequest.codepreferredLabOrderCodesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-orderCodes-eu-lab
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
ServiceRequest.reasonCodepreferredGenomicConditionCodes(a valid code from Genomic Condition Code)
https://nw-gmsa.github.io/ValueSet/genomic-condition-codes
From this IG
ServiceRequest.supportingInfo:PriorResult.typeextensiblePattern Value: DiagnosticReport
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.supportingInfo:PatientSummary.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()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ServiceRequest C 0..* ServiceRequestLabEu Laboratory Order
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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 1..* CorrelationIdentifier Identifiers assigned to this order
Slice: Unordered, Open by value:type
.... identifier:PlacerOrderNumber SOΣ 0..1 PlacerOrderNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-2/OBR-2 Placer Order Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
.... identifier:FillerOrderNumber SOΣ 0..1 FillerOrderNumber Identifier assigned by the lab (Order Filler)
ObligationsActor
SHALL:populate Order Filler
SHOULD:populate-if-known Order Placer
SHOULD:populate-if-known Automation Manager
... instantiatesCanonical Σ 0..* canonical(ActivityDefinition | PlanDefinition) Instantiates FHIR protocol or definition
... instantiatesUri Σ 0..* uri Instantiates external protocol or definition
... basedOn SΣ 0..* Reference(ServiceRequest) SHALL reference a parent request where this ServiceRequest is based on a previous request, e.g. in the case of reanalysis and cascade testing, or Germline Late tests in the Tumour First/Germline Late scenario
.... 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 OΣ 0..1 PlacerGroupNumber Identifier assigned by the Order Placer. (HL7 v2 ORC-4 Placer Group Number)
ObligationsActor
SHOULD:populate-if-known Order Filler
SHALL:populate Order Placer
SHOULD:populate-if-known Automation Manager
... status ?!Σ 1..1 code draft | active | on-hold | revoked | completed | entered-in-error | unknown
Binding: RequestStatus (required): The status of a service order.
... intent ?!Σ 1..1 code proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option
Binding: RequestIntent (required): The kind of service request.
... Slices for category SΣ 1..* CodeableConcept Classification of service
Slice: Unordered, Open by value:coding.system
Binding: ServiceRequestCategoryCodes (example): Classification of the requested service.
.... category:GenomicProcedure SΣ 0..1 CodeableConcept Classification of service
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: 116148004
...... 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
.... category:GenomicsWholeCaseSequencing SΣ 0..1 CodeableConcept Classification of service
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: 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 Σ 0..1 code routine | urgent | asap | stat
Binding: Request Priority (required)
... doNotPerform ?!Σ 0..1 boolean True if service/procedure should not be performed
... code SΣ 1..1 CodeableConcept See [National Genomic Test Directory](https://www.england.nhs.uk/wp-content/uploads/2018/08/rare-and-inherited-disease-eligibility-criteria-v2.pdf).
Binding: Laboratory Order (preferred)
.... 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:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... 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: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
...... 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 SΣC 0..* CodeableConcept Additional order codes
Binding: ServiceRequestOrderDetailsCodes (example): Codified order entry details which are based on order context.
.... 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:GenomicTestDirectory SΣ 1..1 Coding Genomic Test Directory
...... 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: https://fhir.nhs.uk/CodeSystem/England-GenomicTestDirectory
...... 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
... quantity[x] Σ 0..1 Service amount
.... quantityQuantity Quantity
.... quantityRatio Ratio
.... quantityRange Range
... subject SΣ 1..1 Reference(Patient) 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 Σ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) A reference identifier to the episode/stay/visit number in which the request was created. (HL7 v2 PV1-19)
.... 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 SOΣ 0..1 HospitalProviderSpellIdentifier Logical reference, when literal reference is not known
ObligationsActor
SHALL:populate-if-known Order Filler
SHALL:populate-if-known Order Placer
SHALL:populate-if-known Automation Manager
.... display Σ 0..1 string Text alternative for the resource
... occurrence[x] SΣ 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Σ 1..1 dateTime When the order was placed
... requester SΣ 1..1 Reference(PractitionerRole) Who/what is requesting service
... performerType Σ 0..1 CodeableConcept Performer role
Binding: ParticipantRoles (example): Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc.
... performer Σ 0..* Reference(Organization) 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 Σ 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 OrganisationCode 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 SΣ 0..* CodeableConcept Explanation/Justification for procedure or service
Binding: Genomic Condition Codes (preferred)
... reasonReference Σ 0..* Reference(Condition | Observation | DiagnosticReport | DocumentReference) Explanation/Justification for service or service
... insurance 0..* Reference(Coverage) Associated insurance coverage
... Slices for supportingInfo S 0..* Reference(Resource) Additional information: e.g AOEs and prior results
Slice: Unordered, Open by value:type
.... supportingInfo:PriorResult S 0..1 Reference(Diagnostic Report) Equivalent of HL7 v2 OML_O21 PRIOR RESULT (as PDF)
..... 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: DiagnosticReport
..... identifier SΣ 1..1 CorrelationIdentifier Logical reference, when literal reference is not known
..... display Σ 0..1 string Text alternative for the resource
.... supportingInfo:PatientSummary S 0..1 Reference(DocumentReference) Additional information: e.g AOEs and prior results
..... 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 SΣ 1..* Reference(Specimen: Laboratory) Specimens to be used by the laboratory procedure
... bodySite Σ 0..* CodeableConcept Location on Body
Binding: SNOMEDCTBodyStructures (example): 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:GenomicProcedureexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.category:GenomicsWholeCaseSequencingexampleServiceRequestCategoryCodes
http://hl7.org/fhir/ValueSet/servicerequest-category
From the FHIR Standard
ServiceRequest.priorityrequiredRequestPriority
https://nw-gmsa.github.io/ValueSet/RequestPriority
From this IG
ServiceRequest.codepreferredLabOrderCodesEuVs
http://hl7.eu/fhir/laboratory/ValueSet/lab-orderCodes-eu-lab
ServiceRequest.orderDetailexampleServiceRequestOrderDetailsCodes
http://hl7.org/fhir/ValueSet/servicerequest-orderdetail
From the FHIR Standard
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.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.locationCodeexampleServiceDeliveryLocationRoleType
http://terminology.hl7.org/ValueSet/v3-ServiceDeliveryLocationRoleType
ServiceRequest.reasonCodepreferredGenomicConditionCodes(a valid code from Genomic Condition Code)
https://nw-gmsa.github.io/ValueSet/genomic-condition-codes
From this IG
ServiceRequest.supportingInfo:PriorResult.typeextensiblePattern Value: DiagnosticReport
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.supportingInfo:PatientSummary.typeextensiblePattern Value: DocumentReference
http://hl7.org/fhir/ValueSet/resource-types
From the FHIR Standard
ServiceRequest.bodySiteexampleSNOMEDCTBodyStructures
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 ServiceRequestLabEu

Summary

Mandatory: 8 elements(8 nested mandatory elements)
Must-Support: 26 elements

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.orderDetail.coding
  • The element 1 is sliced based on the value of ServiceRequest.supportingInfo

 

Other representations of profile: CSV, Excel, Schematron