ServiceRequest

ResourceClinical · Care ProvisionTrial useMaturity 2

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

21 of 21 parameters tested

Structure

Show inherited elements (8)

Element	Card.	Type	Description
identifierΣ	0..*	Identifier	Identifiers assigned to this order
instantiatesCanonicalΣ	0..*	canonical(ActivityDefinition | PlanDefinition)	Instantiates FHIR protocol or definition
instantiatesUriΣ	0..*	uri	Instantiates external protocol or definition
basedOnΣ	0..*	Reference(CarePlan | ServiceRequest | MedicationRequest)	What request fulfills
replacesΣ	0..*	Reference(ServiceRequest)	What request replaces
requisitionΣ	0..1	Identifier	Composite Request ID
statusRequired?!Σ	1..1	code	draft | active | on-hold | revoked | completed | entered-in-error | unknownBinding (required): request-status
intentRequired?!Σ	1..1	code	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | optionBinding (required): request-intent
categoryΣ	0..*	CodeableConcept	Classification of serviceBinding (example): servicerequest-category
priorityΣ	0..1	code	routine | urgent | asap | statBinding (required): request-priority
doNotPerform?!Σ	0..1	boolean	True if service/procedure should not be performed
codeΣ	0..1	CodeableConcept	What is being requested/orderedBinding (example): procedure-code
orderDetailΣ	0..*	CodeableConcept	Additional order informationBinding (example): servicerequest-orderdetail
quantity[x]Σ	0..1	Quantity | Ratio | Range	Service amount
subjectRequiredΣ	1..1	Reference(Patient | Group | Location | Device)	Individual or Entity the service is ordered for
encounterΣ	0..1	Reference(Encounter)	Encounter in which the request was created
occurrence[x]Σ	0..1	dateTime | Period | Timing	When service should occur
asNeeded[x]Σ	0..1	boolean | CodeableConcept	Preconditions for serviceBinding (example): medication-as-needed-reason
authoredOnΣ	0..1	dateTime	Date request signed
requesterΣ	0..1	Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | Device)	Who/what is requesting service
performerTypeΣ	0..1	CodeableConcept	Performer roleBinding (example): participant-role
performerΣ	0..*	Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson)	Requested performer
locationCodeΣ	0..*	CodeableConcept	Requested locationBinding (example): v3-ServiceDeliveryLocationRoleType
locationReferenceΣ	0..*	Reference(Location)	Requested location
reasonCodeΣ	0..*	CodeableConcept	Explanation/Justification for procedure or serviceBinding (example): procedure-reason
reasonReferenceΣ	0..*	Reference(Condition | Observation | DiagnosticReport | DocumentReference)	Explanation/Justification for service or service
insurance	0..*	Reference(Coverage | ClaimResponse)	Associated insurance coverage
supportingInfo	0..*	Reference(Resource)	Additional clinical information
specimenΣ	0..*	Reference(Specimen)	Procedure Samples
bodySiteΣ	0..*	CodeableConcept	Location on BodyBinding (example): body-site
note	0..*	Annotation	Comments
patientInstructionΣ	0..1	string	Patient or consumer-oriented instructions
relevantHistory	0..*	Reference(Provenance)	Request provenance

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/ServiceRequest?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
authored	date	Date request signed ServiceRequest.authoredOn
based-on	reference	What request fulfills ServiceRequest.basedOn
body-site	token	Where procedure is going to be done ServiceRequest.bodySite
category	token	Classification of service ServiceRequest.category
code	token	What is being requested/ordered ServiceRequest.code
encounter	reference	An encounter in which this request is made ServiceRequest.encounter
identifier	token	Identifiers assigned to this order ServiceRequest.identifier
instantiates-canonical	reference	Instantiates FHIR protocol or definition ServiceRequest.instantiatesCanonical
instantiates-uri	uri	Instantiates external protocol or definition ServiceRequest.instantiatesUri
intent	token	proposal | plan | directive | order | original-order | reflex-order | filler-order | instance-order | option ServiceRequest.intent
occurrence	date	When service should occur ServiceRequest.occurrence
patient	reference	Search by subject - a patient ServiceRequest.subject.where(resolve() is Patient)
performer	reference	Requested performer ServiceRequest.performer
performer-type	token	Performer role ServiceRequest.performerType
priority	token	routine | urgent | asap | stat ServiceRequest.priority
replaces	reference	What request replaces ServiceRequest.replaces
requester	reference	Who/what is requesting service ServiceRequest.requester
requisition	token	Composite Request ID ServiceRequest.requisition
specimen	reference	Specimen to be tested ServiceRequest.specimen
status	token	draft | active | on-hold | revoked | completed | entered-in-error | unknown ServiceRequest.status
subject	reference	Search by subject ServiceRequest.subject

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition