This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
Orders
and
Observations
Work
Group
|
Maturity Level : 2 | Trial Use | Security Category : Patient | Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson |
A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.
This resource is a request resource from a FHIR workflow perspective - see Workflow .
ServiceRequest
is
a
record
of
a
request
for
a
procedure
or
diagnostic
represents
an
order
or
other
service
to
be
planned,
proposed,
proposal
or
performed,
plan,
as
distinguished
by
the
ServiceRequest.intent
field
value,
with
to
perform
a
diagnostic
or
other
service
on
or
for
a
patient.
The
procedure
will
lead
ServiceRequest
represents
a
proposal
or
plan
or
order
for
a
service
to
either
be
performed
that
would
result
in
a
Procedure
or
DiagnosticReport
,
which
in
turn
may
reference
one
or
more
Observations
,
which
summarize
the
performance
of
the
procedures
and
associated
documentation
such
as
observations,
images,
findings
that
are
relevant
to
the
treatment/management
of
the
subject.
This
resource
may
be
used
to
share
relevant
information
required
to
support
a
referral
or
a
transfer
of
care
request
from
one
practitioner
or
organization
to
another
when
a
patient
is
required
to
be
referred
to
another
provider
for
a
consultation
/second
opinion
and/or
for
short
term
or
longer
term
management
of
one
or
more
health
issues
or
problems.
Examples include:
Procedures may be performed by a healthcare professional, a friend or relative or in some cases by the patient themselves.
The principal intention of ServiceRequest is to support ordering procedures for one patient (which includes non-human patients in veterinary medicine). However, in many contexts, healthcare related processes include performing diagnostic investigations on groups of subjects, devices involved in the provision of healthcare, and even environmental locations such as ducts, bodies of water, etc. ServiceRequest supports all these usages. The service request may represent an order that is entered by a practitioner in a CPOE system as well as a proposal made by a clinical decision support (CDS) system based on a patient's clinical record and context of care. Planned procedures referenced by a CarePlan may also be represented by this resource.
The general work flow that this resource facilitates is that a clinical system creates a service request. The service request is then accessed by or exchanged with a system, perhaps via intermediaries, that represents an organization (e.g., diagnostic or imaging service, surgical team, physical therapy department) that can perform the procedure. The organization receiving the service request will, after it accepts the request, update the request as the work is performed, and then finally issue a report that references the requests that it fulfilled.
The ServiceRequest resource allows requesting only a single procedure. If a workflow requires requesting multiple procedures simultaneously, this is done using multiple instances of this resource. These instances can be linked in different ways, depending on the needs of the workflow. For guidance, refer to the Request pattern
ServiceRequest is a record of a proposal/plan or order for a service to be performed that would result in a Procedure , Observation , DiagnosticReport , ImagingStudy or similar resource. In contrast to ServiceRequest, Task which spans both intent and event and tracks the execution through to completion and is intended for "administrative" actions like requesting and tracking things to be done to a record, or keeping track of a checklist of steps such to be performed as part of a fulfilment process. A ServiceRequest can be higher-level authorization that triggered the creation of Task, or it can be the "request" resource Task is seeking to fulfill.
ServiceRequest and CommunicationRequest are related. A CommunicationRequest is a request to merely disclose information. Whereas a ServiceRequest would be used to request information as part of training or counseling - i.e. when the process will involve verification of the patient's comprehension or an attempt to change the patient's mental state. In some workflows both may exist. For example, upon receiving a CommunicationRequest a practitioner might initiate a ServiceRequest.
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
A
request
for
a
service
to
be
performed
+ Rule: orderDetail SHALL only be present if code is present Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Identifiers
assigned
to
this
order
|
|
Σ | 0..* | canonical ( ActivityDefinition | PlanDefinition ) |
Instantiates
FHIR
protocol
or
definition
|
|
Σ | 0..* | uri |
Instantiates
external
protocol
or
definition
|
|
Σ | 0..* | Reference ( CarePlan | ServiceRequest | MedicationRequest ) |
What
request
fulfills
|
|
Σ | 0..* | Reference ( ServiceRequest ) |
What
request
replaces
|
|
Σ | 0..1 | Identifier |
Composite
Request
ID
|
|
?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
RequestStatus ( Required ) |
|
?! Σ | 1..1 | code |
proposal
|
plan
|
directive
|
order
RequestIntent ( Required ) |
|
Σ | 0..* | CodeableConcept |
Classification
of
service
Service Request Category Codes ( Example ) |
|
Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
RequestPriority ( Required ) |
|
?! Σ | 0..1 | boolean |
True
if
service/procedure
should
not
be
performed
|
|
Σ | 0..1 |
|
What
is
being
requested/ordered
Procedure Codes (SNOMED CT) ( Example ) |
|
Σ
|
0..* | CodeableConcept |
Additional
order
information
Service Request Order Details Codes ( Example ) |
|
Σ | 0..1 |
Service
amount
|
|
|
Quantity | |||
|
Ratio | |||
|
Range | |||
|
Σ | 1..1 | Reference ( Patient | Group | Location | Device ) |
Individual
or
Entity
the
service
is
ordered
for
|
| Σ | 0..* | Reference ( Any ) |
What
the
service
request
is
about,
when
it
is
not
about
the
subject
of
record
|
![]() ![]() |
Σ | 0..1 | Reference ( Encounter ) |
Encounter
in
which
the
request
was
created
|
|
Σ | 0..1 |
When
service
should
occur
|
|
|
dateTime | |||
|
Period | |||
|
Timing | |||
|
Σ | 0..1 |
Preconditions
for
service
SNOMED CT Medication As Needed Reason Codes ( Example ) |
|
|
boolean | |||
|
CodeableConcept | |||
|
Σ | 0..1 | dateTime |
Date
request
signed
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) |
Who/what
is
requesting
service
|
|
Σ | 0..1 | CodeableConcept |
Performer
role
|
|
Σ | 0..* | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson ) |
Requested
|
|
Σ | 0..* |
|
Requested
location
ServiceDeliveryLocationRoleType
(
Example
)
|
|
Σ | 0..* |
|
Explanation/Justification
for
procedure
or
service
Procedure Reason Codes ( Example ) |
|
|
0..* |
Reference
(
|
|
|
0..* |
Reference
(
|
|
|
|
Σ | 0..* |
Reference
(
|
|
|
Σ | 0..* |
|
Coded
location
on
Body
SNOMED CT Body Structures ( |
|
Σ C |
|
|
|
|
0..* | Annotation |
Comments
|
|
|
Σ | 0..1 | string |
Patient
or
consumer-oriented
instructions
|
|
0..* | Reference ( Provenance ) |
Request
provenance
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
UML Diagram ( Legend )
XML Template
<ServiceRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifiers assigned to this order --></identifier> <instantiatesCanonical><!-- 0..* canonical(ActivityDefinition|PlanDefinition) Instantiates FHIR protocol or definition --></instantiatesCanonical> <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition --> <basedOn><!-- 0..* Reference(CarePlan|MedicationRequest|ServiceRequest) What request fulfills --></basedOn> <replaces><!-- 0..* Reference(ServiceRequest) What request replaces --></replaces> <requisition><!-- 0..1 Identifier Composite Request ID --></requisition> <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
<<intent value="[code]"/><!-- 1..1 proposal | plan | directive | order + --> <category><!-- 0..* CodeableConcept Classification of service --></category> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- 0..1 True if service/procedure should not be performed --><</code> <</orderDetail><code><!-- 0..1 CodeableReference(ActivityDefinition|PlanDefinition) What is being requested/ordered --></code> <orderDetail><!-- I 0..* CodeableConcept Additional order information --></orderDetail> <quantity[x]><!-- 0..1 Quantity|Ratio|Range Service amount --></quantity[x]> <subject><!-- 1..1 Reference(Device|Group|Location|Patient) Individual or Entity the service is ordered for --></subject> <focus><!-- 0..* Reference(Any) What the service request is about, when it is not about the subject of record --></focus> <encounter><!-- 0..1 Reference(Encounter) Encounter in which the request was created --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When service should occur --></occurrence[x]> <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]> <authoredOn value="[dateTime]"/><!-- 0..1 Date request signed --> <requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who/what is requesting service --></requester><</performerType><performerType><!-- 0..1 CodeableConcept Performer role --></performerType> <performer><!-- 0..* Reference(CareTeam|Device|HealthcareService|Organization| Patient|Practitioner|PractitionerRole|RelatedPerson) Requested performer --></performer><</locationCode> <</locationReference> <</reasonCode> <| </reasonReference><location><!-- 0..* CodeableReference(Location) Requested location--></location> <reason><!-- 0..* CodeableReference(Condition|DetectedIssue|DiagnosticReport| DocumentReference|Observation) Explanation/Justification for procedure or service --></reason> <insurance><!-- 0..* Reference(ClaimResponse|Coverage) Associated insurance coverage --></insurance> <supportingInfo><!-- 0..* Reference(Any) Additional clinical information --></supportingInfo> <specimen><!-- 0..* Reference(Specimen) Procedure Samples --></specimen>
<</bodySite><bodySite><!-- 0..* CodeableConcept Coded location on Body --></bodySite> <bodyStructure><!-- 0..1 Reference(BodyStructure) BodyStructure-based location on the body --></bodyStructure> <note><!-- 0..* Annotation Comments --></note> <patientInstruction value="[string]"/><!-- 0..1 Patient or consumer-oriented instructions --> <relevantHistory><!-- 0..* Reference(Provenance) Request provenance --></relevantHistory> </ServiceRequest>
JSON Template
{
"resourceType" : "ServiceRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifiers assigned to this order
"
"instantiatesCanonical" : ["<canonical(ActivityDefinition|PlanDefinition)>"], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"basedOn" : [{ Reference(CarePlan|MedicationRequest|ServiceRequest) }], // What request fulfills
"replaces" : [{ Reference(ServiceRequest) }], // What request replaces
"requisition" : { Identifier }, // Composite Request ID
"status" : "<code>", // R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
"
"intent" : "<code>", // R! proposal | plan | directive | order +
"category" : [{ CodeableConcept }], // Classification of service
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if service/procedure should not be performed
"
"
"code" : { CodeableReference(ActivityDefinition|PlanDefinition) }, // What is being requested/ordered
"orderDetail" : [{ CodeableConcept }], // I Additional order information
// quantity[x]: Service amount. One of these 3:
"quantityQuantity" : { Quantity },
"quantityRatio" : { Ratio },
"quantityRange" : { Range },
"subject" : { Reference(Device|Group|Location|Patient) }, // R! Individual or Entity the service is ordered for
"focus" : [{ Reference(Any) }], // What the service request is about, when it is not about the subject of record
"encounter" : { Reference(Encounter) }, // Encounter in which the request was created
// occurrence[x]: When service should occur. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
// asNeeded[x]: Preconditions for service. One of these 2:
"asNeededBoolean" : <boolean>,
"asNeededCodeableConcept" : { CodeableConcept },
"authoredOn" : "<dateTime>", // Date request signed
"requester" : { Reference(Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Who/what is requesting service
"
"performerType" : { CodeableConcept }, // Performer role
"performer" : [{ Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Requested performer
"
"
"
"|
"location" : [{ CodeableReference(Location) }], // Requested location
"reason" : [{ CodeableReference(Condition|DetectedIssue|DiagnosticReport|
DocumentReference|Observation) }], // Explanation/Justification for procedure or service
"insurance" : [{ Reference(ClaimResponse|Coverage) }], // Associated insurance coverage
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"specimen" : [{ Reference(Specimen) }], // Procedure Samples
"
"bodySite" : [{ CodeableConcept }], // Coded location on Body
"bodyStructure" : { Reference(BodyStructure) }, // BodyStructure-based location on the body
"note" : [{ Annotation }], // Comments
"patientInstruction" : "<string>", // Patient or consumer-oriented instructions
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:ServiceRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ServiceRequest.identifier [ Identifier ], ... ; # 0..* Identifiers assigned to this order fhir:ServiceRequest.instantiatesCanonical [ canonical(ActivityDefinition|PlanDefinition) ], ... ; # 0..* Instantiates FHIR protocol or definition fhir:ServiceRequest.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition fhir:ServiceRequest.basedOn [ Reference(CarePlan|MedicationRequest|ServiceRequest) ], ... ; # 0..* What request fulfills fhir:ServiceRequest.replaces [ Reference(ServiceRequest) ], ... ; # 0..* What request replaces fhir:ServiceRequest.requisition [ Identifier ]; # 0..1 Composite Request ID fhir:ServiceRequest.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
fhir:fhir:ServiceRequest.intent [ code ]; # 1..1 proposal | plan | directive | order + fhir:ServiceRequest.category [ CodeableConcept ], ... ; # 0..* Classification of service fhir:ServiceRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat fhir:ServiceRequest.doNotPerform [ boolean ]; # 0..1 True if service/procedure should not be performedfhir: fhir:fhir:ServiceRequest.code [ CodeableReference(ActivityDefinition|PlanDefinition) ]; # 0..1 What is being requested/ordered fhir:ServiceRequest.orderDetail [ CodeableConcept ], ... ; # 0..* I Additional order information # ServiceRequest.quantity[x] : 0..1 Service amount. One of these 3 fhir:ServiceRequest.quantityQuantity [ Quantity ] fhir:ServiceRequest.quantityRatio [ Ratio ] fhir:ServiceRequest.quantityRange [ Range ] fhir:ServiceRequest.subject [ Reference(Device|Group|Location|Patient) ]; # 1..1 Individual or Entity the service is ordered for fhir:ServiceRequest.focus [ Reference(Any) ], ... ; # 0..* What the service request is about, when it is not about the subject of record fhir:ServiceRequest.encounter [ Reference(Encounter) ]; # 0..1 Encounter in which the request was created # ServiceRequest.occurrence[x] : 0..1 When service should occur. One of these 3 fhir:ServiceRequest.occurrenceDateTime [ dateTime ] fhir:ServiceRequest.occurrencePeriod [ Period ] fhir:ServiceRequest.occurrenceTiming [ Timing ] # ServiceRequest.asNeeded[x] : 0..1 Preconditions for service. One of these 2 fhir:ServiceRequest.asNeededBoolean [ boolean ] fhir:ServiceRequest.asNeededCodeableConcept [ CodeableConcept ] fhir:ServiceRequest.authoredOn [ dateTime ]; # 0..1 Date request signed fhir:ServiceRequest.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who/what is requesting service fhir:ServiceRequest.performerType [ CodeableConcept ]; # 0..1 Performer role fhir:ServiceRequest.performer [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ], ... ; # 0..* Requested performerfhir: fhir: fhir: fhir:fhir:ServiceRequest.location [ CodeableReference(Location) ], ... ; # 0..* Requested location fhir:ServiceRequest.reason [ CodeableReference(Condition|DetectedIssue|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Explanation/Justification for procedure or service fhir:ServiceRequest.insurance [ Reference(ClaimResponse|Coverage) ], ... ; # 0..* Associated insurance coverage fhir:ServiceRequest.supportingInfo [ Reference(Any) ], ... ; # 0..* Additional clinical information fhir:ServiceRequest.specimen [ Reference(Specimen) ], ... ; # 0..* Procedure Samplesfhir:fhir:ServiceRequest.bodySite [ CodeableConcept ], ... ; # 0..* Coded location on Body fhir:ServiceRequest.bodyStructure [ Reference(BodyStructure) ]; # 0..1 BodyStructure-based location on the body fhir:ServiceRequest.note [ Annotation ], ... ; # 0..* Comments fhir:ServiceRequest.patientInstruction [ string ]; # 0..1 Patient or consumer-oriented instructions fhir:ServiceRequest.relevantHistory [ Reference(Provenance) ], ... ; # 0..* Request provenance ]
Changes since R4
| ServiceRequest | |
| ServiceRequest.code |
|
| ServiceRequest.focus |
|
| ServiceRequest.location |
|
| ServiceRequest.reason |
|
| ServiceRequest.bodyStructure |
|
| ServiceRequest.locationCode |
|
| ServiceRequest.locationReference |
|
| ServiceRequest.reasonCode |
|
| ServiceRequest.reasonReference |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
Structure
| Name | Flags | Card. | Type |
Description
&
Constraints
|
|---|---|---|---|---|
|
TU | DomainResource |
A
request
for
a
service
to
be
performed
+ Rule: orderDetail SHALL only be present if code is present Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension |
|
|
Σ | 0..* | Identifier |
Identifiers
assigned
to
this
order
|
|
Σ | 0..* | canonical ( ActivityDefinition | PlanDefinition ) |
Instantiates
FHIR
protocol
or
definition
|
|
Σ | 0..* | uri |
Instantiates
external
protocol
or
definition
|
|
Σ | 0..* | Reference ( CarePlan | ServiceRequest | MedicationRequest ) |
What
request
fulfills
|
|
Σ | 0..* | Reference ( ServiceRequest ) |
What
request
replaces
|
|
Σ | 0..1 | Identifier |
Composite
Request
ID
|
|
?! Σ | 1..1 | code |
draft
|
active
|
on-hold
|
revoked
|
completed
|
entered-in-error
|
unknown
RequestStatus ( Required ) |
|
?! Σ | 1..1 | code |
proposal
|
plan
|
directive
|
order
RequestIntent ( Required ) |
|
Σ | 0..* | CodeableConcept |
Classification
of
service
Service Request Category Codes ( Example ) |
|
Σ | 0..1 | code |
routine
|
urgent
|
asap
|
stat
RequestPriority ( Required ) |
|
?! Σ | 0..1 | boolean |
True
if
service/procedure
should
not
be
performed
|
|
Σ | 0..1 |
|
What
is
being
requested/ordered
Procedure Codes (SNOMED CT) ( Example ) |
|
Σ
|
0..* | CodeableConcept |
Additional
order
information
Service Request Order Details Codes ( Example ) |
|
Σ | 0..1 |
Service
amount
|
|
|
Quantity | |||
|
Ratio | |||
|
Range | |||
|
Σ | 1..1 | Reference ( Patient | Group | Location | Device ) |
Individual
or
Entity
the
service
is
ordered
for
|
| Σ | 0..* | Reference ( Any ) |
What
the
service
request
is
about,
when
it
is
not
about
the
subject
of
record
|
![]() ![]() |
Σ | 0..1 | Reference ( Encounter ) |
Encounter
in
which
the
request
was
created
|
|
Σ | 0..1 |
When
service
should
occur
|
|
|
dateTime | |||
|
Period | |||
|
Timing | |||
|
Σ | 0..1 |
Preconditions
for
service
SNOMED CT Medication As Needed Reason Codes ( Example ) |
|
|
boolean | |||
|
CodeableConcept | |||
|
Σ | 0..1 | dateTime |
Date
request
signed
|
|
Σ | 0..1 | Reference ( Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device ) |
Who/what
is
requesting
service
|
|
Σ | 0..1 | CodeableConcept |
Performer
role
|
|
Σ | 0..* | Reference ( Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson ) |
Requested
|
|
Σ | 0..* |
|
Requested
location
ServiceDeliveryLocationRoleType
(
Example
)
|
|
Σ | 0..* |
|
Explanation/Justification
for
procedure
or
service
Procedure Reason Codes ( Example ) |
|
|
0..* |
Reference
(
|
|
|
0..* |
Reference
(
|
|
|
|
Σ | 0..* |
Reference
(
|
|
|
Σ | 0..* |
|
Coded
location
on
Body
SNOMED CT Body Structures ( |
|
Σ C |
|
|
|
|
0..* | Annotation |
Comments
|
|
|
Σ | 0..1 | string |
Patient
or
consumer-oriented
instructions
|
|
0..* | Reference ( Provenance ) |
Request
provenance
|
|
Documentation
for
this
format
|
||||
See the Extensions for this resource
XML Template
<ServiceRequest xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Identifiers assigned to this order --></identifier> <instantiatesCanonical><!-- 0..* canonical(ActivityDefinition|PlanDefinition) Instantiates FHIR protocol or definition --></instantiatesCanonical> <instantiatesUri value="[uri]"/><!-- 0..* Instantiates external protocol or definition --> <basedOn><!-- 0..* Reference(CarePlan|MedicationRequest|ServiceRequest) What request fulfills --></basedOn> <replaces><!-- 0..* Reference(ServiceRequest) What request replaces --></replaces> <requisition><!-- 0..1 Identifier Composite Request ID --></requisition> <status value="[code]"/><!-- 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown -->
<<intent value="[code]"/><!-- 1..1 proposal | plan | directive | order + --> <category><!-- 0..* CodeableConcept Classification of service --></category> <priority value="[code]"/><!-- 0..1 routine | urgent | asap | stat --> <doNotPerform value="[boolean]"/><!-- 0..1 True if service/procedure should not be performed --><</code> <</orderDetail><code><!-- 0..1 CodeableReference(ActivityDefinition|PlanDefinition) What is being requested/ordered --></code> <orderDetail><!-- I 0..* CodeableConcept Additional order information --></orderDetail> <quantity[x]><!-- 0..1 Quantity|Ratio|Range Service amount --></quantity[x]> <subject><!-- 1..1 Reference(Device|Group|Location|Patient) Individual or Entity the service is ordered for --></subject> <focus><!-- 0..* Reference(Any) What the service request is about, when it is not about the subject of record --></focus> <encounter><!-- 0..1 Reference(Encounter) Encounter in which the request was created --></encounter> <occurrence[x]><!-- 0..1 dateTime|Period|Timing When service should occur --></occurrence[x]> <asNeeded[x]><!-- 0..1 boolean|CodeableConcept Preconditions for service --></asNeeded[x]> <authoredOn value="[dateTime]"/><!-- 0..1 Date request signed --> <requester><!-- 0..1 Reference(Device|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) Who/what is requesting service --></requester><</performerType><performerType><!-- 0..1 CodeableConcept Performer role --></performerType> <performer><!-- 0..* Reference(CareTeam|Device|HealthcareService|Organization| Patient|Practitioner|PractitionerRole|RelatedPerson) Requested performer --></performer><</locationCode> <</locationReference> <</reasonCode> <| </reasonReference><location><!-- 0..* CodeableReference(Location) Requested location--></location> <reason><!-- 0..* CodeableReference(Condition|DetectedIssue|DiagnosticReport| DocumentReference|Observation) Explanation/Justification for procedure or service --></reason> <insurance><!-- 0..* Reference(ClaimResponse|Coverage) Associated insurance coverage --></insurance> <supportingInfo><!-- 0..* Reference(Any) Additional clinical information --></supportingInfo> <specimen><!-- 0..* Reference(Specimen) Procedure Samples --></specimen>
<</bodySite><bodySite><!-- 0..* CodeableConcept Coded location on Body --></bodySite> <bodyStructure><!-- 0..1 Reference(BodyStructure) BodyStructure-based location on the body --></bodyStructure> <note><!-- 0..* Annotation Comments --></note> <patientInstruction value="[string]"/><!-- 0..1 Patient or consumer-oriented instructions --> <relevantHistory><!-- 0..* Reference(Provenance) Request provenance --></relevantHistory> </ServiceRequest>
JSON Template
{
"resourceType" : "ServiceRequest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifiers assigned to this order
"
"instantiatesCanonical" : ["<canonical(ActivityDefinition|PlanDefinition)>"], // Instantiates FHIR protocol or definition
"instantiatesUri" : ["<uri>"], // Instantiates external protocol or definition
"basedOn" : [{ Reference(CarePlan|MedicationRequest|ServiceRequest) }], // What request fulfills
"replaces" : [{ Reference(ServiceRequest) }], // What request replaces
"requisition" : { Identifier }, // Composite Request ID
"status" : "<code>", // R! draft | active | on-hold | revoked | completed | entered-in-error | unknown
"
"intent" : "<code>", // R! proposal | plan | directive | order +
"category" : [{ CodeableConcept }], // Classification of service
"priority" : "<code>", // routine | urgent | asap | stat
"doNotPerform" : <boolean>, // True if service/procedure should not be performed
"
"
"code" : { CodeableReference(ActivityDefinition|PlanDefinition) }, // What is being requested/ordered
"orderDetail" : [{ CodeableConcept }], // I Additional order information
// quantity[x]: Service amount. One of these 3:
"quantityQuantity" : { Quantity },
"quantityRatio" : { Ratio },
"quantityRange" : { Range },
"subject" : { Reference(Device|Group|Location|Patient) }, // R! Individual or Entity the service is ordered for
"focus" : [{ Reference(Any) }], // What the service request is about, when it is not about the subject of record
"encounter" : { Reference(Encounter) }, // Encounter in which the request was created
// occurrence[x]: When service should occur. One of these 3:
"occurrenceDateTime" : "<dateTime>",
"occurrencePeriod" : { Period },
"occurrenceTiming" : { Timing },
// asNeeded[x]: Preconditions for service. One of these 2:
"asNeededBoolean" : <boolean>,
"asNeededCodeableConcept" : { CodeableConcept },
"authoredOn" : "<dateTime>", // Date request signed
"requester" : { Reference(Device|Organization|Patient|Practitioner|
PractitionerRole|RelatedPerson) }, // Who/what is requesting service
"
"performerType" : { CodeableConcept }, // Performer role
"performer" : [{ Reference(CareTeam|Device|HealthcareService|Organization|
Patient|Practitioner|PractitionerRole|RelatedPerson) }], // Requested performer
"
"
"
"|
"location" : [{ CodeableReference(Location) }], // Requested location
"reason" : [{ CodeableReference(Condition|DetectedIssue|DiagnosticReport|
DocumentReference|Observation) }], // Explanation/Justification for procedure or service
"insurance" : [{ Reference(ClaimResponse|Coverage) }], // Associated insurance coverage
"supportingInfo" : [{ Reference(Any) }], // Additional clinical information
"specimen" : [{ Reference(Specimen) }], // Procedure Samples
"
"bodySite" : [{ CodeableConcept }], // Coded location on Body
"bodyStructure" : { Reference(BodyStructure) }, // BodyStructure-based location on the body
"note" : [{ Annotation }], // Comments
"patientInstruction" : "<string>", // Patient or consumer-oriented instructions
"relevantHistory" : [{ Reference(Provenance) }] // Request provenance
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .[ a fhir:ServiceRequest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:ServiceRequest.identifier [ Identifier ], ... ; # 0..* Identifiers assigned to this order fhir:ServiceRequest.instantiatesCanonical [ canonical(ActivityDefinition|PlanDefinition) ], ... ; # 0..* Instantiates FHIR protocol or definition fhir:ServiceRequest.instantiatesUri [ uri ], ... ; # 0..* Instantiates external protocol or definition fhir:ServiceRequest.basedOn [ Reference(CarePlan|MedicationRequest|ServiceRequest) ], ... ; # 0..* What request fulfills fhir:ServiceRequest.replaces [ Reference(ServiceRequest) ], ... ; # 0..* What request replaces fhir:ServiceRequest.requisition [ Identifier ]; # 0..1 Composite Request ID fhir:ServiceRequest.status [ code ]; # 1..1 draft | active | on-hold | revoked | completed | entered-in-error | unknown
fhir:fhir:ServiceRequest.intent [ code ]; # 1..1 proposal | plan | directive | order + fhir:ServiceRequest.category [ CodeableConcept ], ... ; # 0..* Classification of service fhir:ServiceRequest.priority [ code ]; # 0..1 routine | urgent | asap | stat fhir:ServiceRequest.doNotPerform [ boolean ]; # 0..1 True if service/procedure should not be performedfhir: fhir:fhir:ServiceRequest.code [ CodeableReference(ActivityDefinition|PlanDefinition) ]; # 0..1 What is being requested/ordered fhir:ServiceRequest.orderDetail [ CodeableConcept ], ... ; # 0..* I Additional order information # ServiceRequest.quantity[x] : 0..1 Service amount. One of these 3 fhir:ServiceRequest.quantityQuantity [ Quantity ] fhir:ServiceRequest.quantityRatio [ Ratio ] fhir:ServiceRequest.quantityRange [ Range ] fhir:ServiceRequest.subject [ Reference(Device|Group|Location|Patient) ]; # 1..1 Individual or Entity the service is ordered for fhir:ServiceRequest.focus [ Reference(Any) ], ... ; # 0..* What the service request is about, when it is not about the subject of record fhir:ServiceRequest.encounter [ Reference(Encounter) ]; # 0..1 Encounter in which the request was created # ServiceRequest.occurrence[x] : 0..1 When service should occur. One of these 3 fhir:ServiceRequest.occurrenceDateTime [ dateTime ] fhir:ServiceRequest.occurrencePeriod [ Period ] fhir:ServiceRequest.occurrenceTiming [ Timing ] # ServiceRequest.asNeeded[x] : 0..1 Preconditions for service. One of these 2 fhir:ServiceRequest.asNeededBoolean [ boolean ] fhir:ServiceRequest.asNeededCodeableConcept [ CodeableConcept ] fhir:ServiceRequest.authoredOn [ dateTime ]; # 0..1 Date request signed fhir:ServiceRequest.requester [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ]; # 0..1 Who/what is requesting service fhir:ServiceRequest.performerType [ CodeableConcept ]; # 0..1 Performer role fhir:ServiceRequest.performer [ Reference(CareTeam|Device|HealthcareService|Organization|Patient|Practitioner| PractitionerRole|RelatedPerson) ], ... ; # 0..* Requested performerfhir: fhir: fhir: fhir:fhir:ServiceRequest.location [ CodeableReference(Location) ], ... ; # 0..* Requested location fhir:ServiceRequest.reason [ CodeableReference(Condition|DetectedIssue|DiagnosticReport|DocumentReference|Observation) ], ... ; # 0..* Explanation/Justification for procedure or service fhir:ServiceRequest.insurance [ Reference(ClaimResponse|Coverage) ], ... ; # 0..* Associated insurance coverage fhir:ServiceRequest.supportingInfo [ Reference(Any) ], ... ; # 0..* Additional clinical information fhir:ServiceRequest.specimen [ Reference(Specimen) ], ... ; # 0..* Procedure Samplesfhir:fhir:ServiceRequest.bodySite [ CodeableConcept ], ... ; # 0..* Coded location on Body fhir:ServiceRequest.bodyStructure [ Reference(BodyStructure) ]; # 0..1 BodyStructure-based location on the body fhir:ServiceRequest.note [ Annotation ], ... ; # 0..* Comments fhir:ServiceRequest.patientInstruction [ string ]; # 0..1 Patient or consumer-oriented instructions fhir:ServiceRequest.relevantHistory [ Reference(Provenance) ], ... ; # 0..* Request provenance ]
Changes since Release 4
| ServiceRequest | |
| ServiceRequest.code |
|
| ServiceRequest.focus |
|
| ServiceRequest.location |
|
| ServiceRequest.reason |
|
| ServiceRequest.bodyStructure |
|
| ServiceRequest.locationCode |
|
| ServiceRequest.locationReference |
|
| ServiceRequest.reasonCode |
|
| ServiceRequest.reasonReference |
|
See the Full Difference for further information
This analysis is available as XML or JSON .
See
the
Profiles
&
Extensions
and
the
alternate
Additional
definitions:
Master
Definition
XML
+
JSON
,
XML
Schema
/
Schematron
+
JSON
Schema
,
ShEx
(for
Turtle
)
+
see
the
extensions
,
the
spreadsheet
version
&
the
dependency
analysis
| Path | Definition | Type | Reference |
|---|---|---|---|
| ServiceRequest.status |
Codes identifying the lifecycle stage of a request. |
Required | RequestStatus |
| ServiceRequest.intent |
Codes indicating the degree of authority/intentionality associated with a request. |
Required | RequestIntent |
| ServiceRequest.category |
An example value set of SNOMED CT concepts that can classify a requested service |
Example | ServiceRequestCategoryCodes |
| ServiceRequest.priority |
Identifies the level of importance to be assigned to actioning the request. |
Required | RequestPriority |
| ServiceRequest.code |
Procedure Code: All SNOMED CT procedure codes. |
Example | ProcedureCodes(SNOMEDCT) |
| ServiceRequest.orderDetail |
An example value set of Codified order entry details concepts. These concepts only make sense in the context of what is being ordered. This example is for a patient ventilation order |
Example | ServiceRequestOrderDetailsCodes |
| ServiceRequest.asNeeded[x] |
This value set includes all clinical findings from SNOMED CT - provided as an exemplar value set. |
Example | SNOMEDCTMedicationAsNeededReasonCodes |
| ServiceRequest.performerType |
Roles of participants that may be included in a care team. Defined as: Healthcare professional (occupation) or Services (qualifier value). |
Example |
|
|
|
A role of a place that further classifies the setting (e.g., accident site, road side, work site, community location) in which services are delivered. |
Example |
ServiceDeliveryLocationRoleType
|
|
|
This example value set defines the set of codes that can be used to indicate a reason for a procedure. |
Example | ProcedureReasonCodes |
| ServiceRequest.bodySite |
This
value
set
includes
all
codes
from
SNOMED
CT
|
Example | SNOMEDCTBodyStructures |
|
|
Level | Location | Description | Expression |
bdystr-1
| Rule | ServiceRequest.bodyStructure | bodyStructure SHALL only be present if bodySite is not present | bodySite.exists() or bodyStructure.exists() |
prr-1
|
Rule | (base) | orderDetail SHALL only be present if code is present | orderDetail.empty() or code.exists() |
code
will
often
have
this
information
embedded
in
it
-
for
example,
'serum
glucose'
or
'chest
x-ray'.
Alternatively,
the
specimen
or
bodysite
element
may
be
used
to
specify
it.
reasonCode
element
is
often
for
billing
purposes.
It
may
relate
to
the
resources
referred
to
in
supportingInfo
element
and
may
be
used
to
decide
how
a
procedure
or
diagnostic
investigation
will
be
performed,
or
even
if
it
will
be
performed
at
all
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| authored N | date | Date request signed | ServiceRequest.authoredOn | |
| based-on | reference | What request fulfills |
ServiceRequest.basedOn
( CarePlan , MedicationRequest , ServiceRequest ) |
|
| body-site | token | Where procedure is going to be done | ServiceRequest.bodySite | |
| body-structure | reference | Body structure Where procedure is going to be done |
ServiceRequest.bodyStructure
( BodyStructure ) | |
| category | token | Classification of service | ServiceRequest.category | |
|
|
token | What is being requested/ordered |
| |
| code-reference | reference | What is being requested/ordered | ServiceRequest.code.reference | |
| encounter | reference | An encounter in which this request is made |
ServiceRequest.encounter
( Encounter ) |
|
| identifier | token | Identifiers assigned to this order | ServiceRequest.identifier | |
| instantiates-canonical N | reference | Instantiates FHIR protocol or definition |
ServiceRequest.instantiatesCanonical
( PlanDefinition , ActivityDefinition ) |
|
| instantiates-uri N | uri | Instantiates external protocol or definition | ServiceRequest.instantiatesUri | |
| intent N | token |
proposal
|
plan
|
directive
|
order
|
ServiceRequest.intent | |
| occurrence | date | When service should occur | ServiceRequest.occurrence | |
| patient | reference | Search by subject - a patient |
ServiceRequest.subject.where(resolve()
is
Patient)
( Patient ) |
|
| performer | reference | Requested performer |
ServiceRequest.performer
( Practitioner , Organization , CareTeam , Device , Patient , HealthcareService , PractitionerRole , RelatedPerson ) |
|
| performer-type | token | Performer role | ServiceRequest.performerType | |
| priority N | token | routine | urgent | asap | stat | ServiceRequest.priority | |
| replaces | reference | What request replaces |
ServiceRequest.replaces
( ServiceRequest ) |
|
| requester | reference | Who/what is requesting service |
ServiceRequest.requester
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson ) |
|
| requisition | token | Composite Request ID | ServiceRequest.requisition | |
| specimen | reference | Specimen to be tested |
ServiceRequest.specimen
( Specimen ) |
|
| status N | token | draft | active | on-hold | revoked | completed | entered-in-error | unknown | ServiceRequest.status | |
| subject | reference | Search by subject |
ServiceRequest.subject
( Group , Device , Patient , Location ) |