ServiceRequest search-type

Request Fields and Example
patient
[string]

The patient for whom the service was ordered

patient.identifier
[string]

One or more external identifiers for the patient

occurrenceDateTime
[string]

The expected occurrence date-time of service

status
[string]

The status of the service: draft | active | on-hold | revoked | completed | entered-in-error | unknown

code
[string]

The code for the service that is being requested

post/ServiceRequest/_search
Response Fields and Example

Response to a Service Request search operation

resourceType
required, string

Identifies the type of the resource

Value: Bundle
type
required, string

Identifies this bundle as a response to a search

Value: searchset
total
required, number

The total number of matches

entry
[ServiceRequest, Other]

A resource matching the search criteria or related to a matching resource

Any of:
resource
required, object

A record of request for a procedure or diagnostic or other service to be performed on a patient

resourceType
required, string

Identifies the type of the resource

Value: ServiceRequest
status
required, string

The status of the order.

Possible Values: draft, active, on-hold, revoked, completed, entered-in-error, unknown
_status
required, object

This element contains extensions for status. Depending on the extensions present it could be used in place of status or contain additional information about status. See the extension element for more details on the possible extensions being sent.

extension
[OriginalText, Other]

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Any of:

A human language representation of the concept (resource/element) as seen/selected/uttered by the user who entered the data and/or which represents the full intended meaning of the user.

See http://hl7.org/fhir/StructureDefinition/originalText for more information

url
required, string

Source of the definition for the extension code - a logical name or a URL.

Value: http://hl7.org/fhir/StructureDefinition/originalText
valueString
required, string

The original text

intent
required, string

Whether the request is a proposal, plan, an original order or a reflex order.

Possible Values: proposal, plan, directive, order, original-order, reflex-order, filler-order, instance-order, option
subject
required, object

On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans).

Must be a resource of type Patient.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

id
string

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

identifier
[object]

Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller.

extension
[Boolean, String, CodeableConcept, Coding, HumanName, Reference]

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

One of:
url
required, string

Source of the definition for the extension code - a logical name or a URL.

valueBoolean
boolean

A single value for the extension.

use
string

The purpose of this identifier.

Possible Values: usual, official, temp, secondary, old (If known)
system
string

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

value
string

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

category
[planOfCareType, Other]

A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure").

Any of:

When mapping CDA to FHIR, several entries in the Plan of Treatment section become ServiceRequest resources. This category can identify what type of entry created this ServiceRequest.

coding
[object]

A reference to a code defined by a terminology system.

system
required, string

The identification of the code system that defines the meaning of the symbol in the code.

Value: urn:redox:plan_of_care_type
code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Possible Values: Orders, Services, Procedures
text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

code
object

A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested.

coding
[object]

A reference to a code defined by a terminology system.

system
string

The identification of the code system that defines the meaning of the symbol in the code.

code
string

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

text
string

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

encounter
object

An encounter that provides additional information about the healthcare context in which this request is made.

Must be a resource of type Encounter.

reference
string

A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.

occurrenceDateTime
string

The date/time at which the requested service should occur.

search
required, object

Information about the search process that lead to the creation of this entry.

mode
required, string

Identifies the ServiceRequest as matching the search parameters

Value: match