Release 5 R6 Ballot (3rd Draft)

This page is part of the FHIR Specification (v5.0.0: R5 - STU v6.0.0-ballot3: Release 6 Ballot (3rd Draft) (see Ballot Notes ). This is the The current published version in it's permanent home (it will always be available at this URL). is 5.0.0 . For a full list of available versions, see the Directory of published versions

12.18.14 Resource ServiceRequest - Search Parameters

Orders and Observations icon Work Group Maturity Level : N/A   Trial Use Security Category : Patient Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson

Search parameters for the Resource ServiceRequest - Search Parameters resource. Also check the Extensions registry for search parameters on extensions related to this resource.

The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

http://hl7.org/fhir/SearchParameter/ServiceRequest-authored

Generated Narrative: SearchParameter ServiceRequest-authored

12.18.15 authored

Parameter authored : date

Date request signed

Resource ServiceRequest
Expression ServiceRequest.authoredOn
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-based-on

Generated Narrative: SearchParameter ServiceRequest-based-on

12.18.16 based-on

Parameter based-on : reference

What request fulfills

Resource ServiceRequest
Expression ServiceRequest.basedOn
Processing Mode Normal
Target Resources RequestOrchestration , ServiceRequest , CarePlan , MedicationRequest , NutritionOrder
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-body-site

Generated Narrative: SearchParameter ServiceRequest-body-site

12.18.17 body-site

Parameter body-site : token

Where procedure is going to be done

Resource ServiceRequest
Expression ServiceRequest.bodySite
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-body-structure

Generated Narrative: SearchParameter ServiceRequest-body-structure

12.18.18 body-structure

Parameter body-structure : reference

Body structure Where procedure is going to be done

Resource ServiceRequest
Expression ServiceRequest.bodyStructure
Processing Mode Normal
Target Resources BodyStructure
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-category

Generated Narrative: SearchParameter ServiceRequest-category

12.18.19 category

Parameter category : token

Classification of service

Resource ServiceRequest
Expression ServiceRequest.category
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-code-concept

Generated Narrative: SearchParameter ServiceRequest-code-concept

12.18.20 code-concept

Parameter code-concept : token

What is being requested/ordered

Resource ServiceRequest
Expression ServiceRequest.code.concept
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-code-reference

Generated Narrative: SearchParameter ServiceRequest-code-reference

12.18.21 code-reference

Parameter code-reference : reference

What is being requested/ordered

Resource ServiceRequest
Expression ServiceRequest.code.reference
Processing Mode Normal
Target Resources ActivityDefinition , PlanDefinition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-encounter
This search parameter is part of the common search parameter clinical-encounter

Generated Narrative: SearchParameter clinical-encounter

12.18.22 encounter

Parameter encounter : reference

ServiceRequest : An encounter in which this request is made

Resource ServiceRequest
Expression ServiceRequest.encounter
Processing Mode Normal
Target Resources Encounter
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-group-or-identifier

Generated Narrative: SearchParameter ServiceRequest-group-or-identifier

12.18.23 group-or-identifier

Parameter group-or-identifier : token

Requisition ID or other identifier

Resource ServiceRequest
Expression ServiceRequest.requisition | ServiceRequest.identifier
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/clinical-identifier
This search parameter is part of the common search parameter clinical-identifier

12.18.23 Generated Narrative: SearchParameter clinical-identifier

12.18.24 identifier

Parameter identifier : token

ServiceRequest : Identifiers assigned to this order

Resource ServiceRequest
Expression ServiceRequest.identifier
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-instantiates-canonical

12.18.24 Generated Narrative: SearchParameter ServiceRequest-instantiates-canonical

12.18.25 instantiates-canonical

Parameter instantiates-canonical : reference

Instantiates FHIR protocol or definition

Resource ServiceRequest
Expression ServiceRequest.instantiatesCanonical
Processing Mode Normal
Target Resources ActivityDefinition , PlanDefinition
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-instantiates-uri

12.18.25 Generated Narrative: SearchParameter ServiceRequest-instantiates-uri

12.18.26 instantiates-uri

Parameter instantiates-uri : uri

Instantiates external protocol or definition

Resource ServiceRequest
Expression ServiceRequest.instantiatesUri
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-intent

12.18.26 Generated Narrative: SearchParameter ServiceRequest-intent

12.18.27 intent

Parameter intent : token

proposal | plan | directive | order +

Resource ServiceRequest
Expression ServiceRequest.intent
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-location-code

Generated Narrative: SearchParameter ServiceRequest-location-code

12.18.28 location-code

Parameter location-code : token

The preferred location specified in the ServiceRequest (coded)

Resource ServiceRequest
Expression ServiceRequest.location.concept
Processing Mode Normal
Multiples
  • multipleAnd: It's up to the server whether the parameter may repeat in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-location-reference

Generated Narrative: SearchParameter ServiceRequest-location-reference

12.18.29 location-reference

Parameter location-reference : reference

The preferred location specified in the ServiceRequest (resource reference)

Resource ServiceRequest
Expression ServiceRequest.location.reference
Processing Mode Normal
Target Resources Location
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-occurrence

12.18.27 Generated Narrative: SearchParameter ServiceRequest-occurrence

12.18.30 occurrence

Parameter occurrence : date

When service should occur

Resource ServiceRequest
Expression ServiceRequest.occurrence.ofType(dateTime) | ServiceRequest.occurrence.ofType(Period) | ServiceRequest.occurrence.ofType(Timing)
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
Comparators Allowed: eq, ne, gt, ge, lt, le, sa, eb, ap
 
http://hl7.org/fhir/SearchParameter/clinical-patient
This search parameter is part of the common search parameter clinical-patient

12.18.28 Generated Narrative: SearchParameter clinical-patient

12.18.31 patient

Parameter patient : reference

ServiceRequest : Search by subject - a patient

Resource ServiceRequest
Expression ServiceRequest.subject.where(resolve() is Patient)
Processing Mode Normal
Target Resources Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-performer

12.18.29 Generated Narrative: SearchParameter ServiceRequest-performer

12.18.32 performer

Parameter performer : reference

Requested performer

Resource ServiceRequest
Expression ServiceRequest.performer
Processing Mode Normal
Target Resources HealthcareService , Organization , CareTeam , Device , RelatedPerson , PractitionerRole , Practitioner , Group , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-performer-type

12.18.30 Generated Narrative: SearchParameter ServiceRequest-performer-type

12.18.33 performer-type

Parameter performer-type : token

Performer role

Resource ServiceRequest
Expression ServiceRequest.performerType
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-priority

12.18.31 Generated Narrative: SearchParameter ServiceRequest-priority

12.18.34 priority

Parameter priority : token

routine | urgent | asap | stat

Resource ServiceRequest
Expression ServiceRequest.priority
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-replaces

12.18.32 Generated Narrative: SearchParameter ServiceRequest-replaces

12.18.35 replaces

Parameter replaces : reference

What request replaces

Resource ServiceRequest
Expression ServiceRequest.replaces
Processing Mode Normal
Target Resources ServiceRequest
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-requester

12.18.33 Generated Narrative: SearchParameter ServiceRequest-requester

12.18.36 requester

Parameter requester : reference

Who/what is requesting service

Resource ServiceRequest
Expression ServiceRequest.requester
Processing Mode Normal
Target Resources Organization , Device , RelatedPerson , PractitionerRole , Practitioner , Group , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-requisition

12.18.34 Generated Narrative: SearchParameter ServiceRequest-requisition

12.18.37 requisition

Parameter requisition : token

Composite Request ID

Resource ServiceRequest
Expression ServiceRequest.requisition
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-specimen

12.18.35 Generated Narrative: SearchParameter ServiceRequest-specimen

12.18.38 specimen

Parameter specimen : reference

Specimen to be tested

Resource ServiceRequest
Expression ServiceRequest.specimen
Processing Mode Normal
Target Resources Specimen
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-status

12.18.36 Generated Narrative: SearchParameter ServiceRequest-status

12.18.39 status

Parameter status : token

draft | active | on-hold | revoked | completed | entered-in-error | unknown

Resource ServiceRequest
Expression ServiceRequest.status
Processing Mode Normal
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true
 
http://hl7.org/fhir/SearchParameter/ServiceRequest-subject

12.18.37 Generated Narrative: SearchParameter ServiceRequest-subject

12.18.40 subject

Parameter subject : reference

Search by subject

Resource ServiceRequest
Expression ServiceRequest.subject
Processing Mode Normal
Target Resources Device , Group , Location , Patient
Multiples The
  • multipleAnd: It's up to the server whether the parameter cannot may repeat or in order to specify multiple values that must all be true
  • multipleOr: It's up to the server whether the parameter can have multiple values (separated by comma) where at least one must be true