ServiceRequest

Trial Use 2 Clinical — Care Provision

A record of a request for service such as diagnostic investigations, treatments, or operations to be performed.

Endpoints

alphahttps://api.dev.ovok.com/fhir/R4/ServiceRequest

Interaction	Method	Path
Read	GET	/fhir/R4/ServiceRequest/[id]
Vread	GET	/fhir/R4/ServiceRequest/[id]/_history/[vid]
Update	PUT	/fhir/R4/ServiceRequest/[id]
Patch	PATCH	/fhir/R4/ServiceRequest/[id]
Delete	DELETE	/fhir/R4/ServiceRequest/[id]
Create	POST	/fhir/R4/ServiceRequest
Search	GET	/fhir/R4/ServiceRequest
History	GET	/fhir/R4/ServiceRequest/[id]/_history

Top-level elements

Element	Type(s)	Cardinality	Description
identifier	Identifier	0..*	Identifiers assigned to this order
instantiatesCanonical	canonical	0..*	Instantiates FHIR protocol or definition
instantiatesUri	uri	0..*	Instantiates external protocol or definition
basedOn	Reference	0..*	What request fulfills
replaces	Reference	0..*	What request replaces
requisition	Identifier	0..1	Composite Request ID
status	code	1..1	draft | active | on-hold | revoked | completed | entered-in-error | unknown modifier
intent	code	1..1	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option modifier
category	CodeableConcept	0..*	Classification of service
priority	code	0..1	routine | urgent | asap | stat
doNotPerform	boolean	0..1	True if service/procedure should not be performed modifier
code	CodeableConcept	0..1	What is being requested/ordered
orderDetail	CodeableConcept	0..*	Additional order information
quantity[x]	Quantity / Ratio / Range	0..1	Service amount
subject	Reference	1..1	Individual or Entity the service is ordered for
encounter	Reference	0..1	Encounter in which the request was created
occurrence[x]	dateTime / Period / Timing	0..1	When service should occur
asNeeded[x]	boolean / CodeableConcept	0..1	Preconditions for service
authoredOn	dateTime	0..1	Date request signed
requester	Reference	0..1	Who/what is requesting service
performerType	CodeableConcept	0..1	Performer role
performer	Reference	0..*	Requested performer
locationCode	CodeableConcept	0..*	Requested location
locationReference	Reference	0..*	Requested location
reasonCode	CodeableConcept	0..*	Explanation/Justification for procedure or service
reasonReference	Reference	0..*	Explanation/Justification for service or service
insurance	Reference	0..*	Associated insurance coverage
supportingInfo	Reference	0..*	Additional clinical information
specimen	Reference	0..*	Procedure Samples
bodySite	CodeableConcept	0..*	Location on Body
note	Annotation	0..*	Comments
patientInstruction	string	0..1	Patient or consumer-oriented instructions
relevantHistory	Reference	0..*	Request provenance

Resource-specific search parameters

Parameter	Type	Description
_compartment	string
_count	string	https://www.hl7.org/fhir/search.html#_count
_elements	string	https://www.hl7.org/fhir/search.html#_elements
_id	string
_lastUpdated	string
_profile	string
_security	string
_sort	string	https://www.hl7.org/fhir/search.html#_sort
_source	string
_summary	string	https://www.hl7.org/fhir/search.html#_summary
_tag	string
_total	string	https://www.hl7.org/fhir/search.html#_total
authored	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-authored
based-on	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-based-on
body-site	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-body-site
category	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-category
code	string	http://hl7.org/fhir/SearchParameter/clinical-code
encounter	string	http://hl7.org/fhir/SearchParameter/clinical-encounter
identifier	string	http://hl7.org/fhir/SearchParameter/clinical-identifier
instantiates-canonical	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-instantiates-canonical
instantiates-uri	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-instantiates-uri
intent	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-intent
occurrence	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence
order-detail	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-order-detail
patient	string	http://hl7.org/fhir/SearchParameter/clinical-patient
performer	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-performer
performer-type	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-performer-type
priority	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-priority
priority-order	string	https://medplum.com/fhir/SearchParameter/priority-order
reason-code	string	https://medplum.com/fhir/SearchParameter/ServiceRequest-reason-code
replaces	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-replaces
requester	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-requester
requisition	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-requisition
specimen	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-specimen
status	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-status
subject	string	http://hl7.org/fhir/SearchParameter/ServiceRequest-subject

Reference

• Official FHIR R4 spec: ServiceRequest
• Maturity: Trial Use 2 (FMM 2).