Home
API reference
FHIR® API
FHIR® resources
ServiceRequest
_search

ServiceRequest _search

post/ServiceRequest/_search
Page View

This resource contains a request for patient services like treatment(s), operation(s), consulting, skilled nursing, or other medical-related service(s).

You can review, retrieve, create, update, or cancel service requests.

_search

Query for details about a service request order.

This is a flexible option with query parameters to refine your search. The response returns a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/ServiceRequest/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'patient=string' \
6
--data-urlencode 'patient.identifier=string' \
7
--data-urlencode 'occurrenceDateTime=string' \
8
--data-urlencode 'authored=string' \
9
--data-urlencode 'status=string' \
10
--data-urlencode 'code=string'

Request Body Schema

  • patient
    Array of string

    The patient for whom the service was ordered

  • patient.identifier
    Array of string

    One or more external identifiers for the patient

  • occurrenceDateTime
    Array of string

    The expected occurrence date-time of service

  • authored
    Array of string

    Date request signed

  • status
    Array of string

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

  • code
    Array of string

    The code for the service that is being requested

Response fields and example

Example payload generated from schema
1
{
2
  "resourceType": "Bundle",
3
  "type": "searchset",
4
  "total": 1,
5
  "entry": [
6
    {
7
      "resource": {
8
        "resourceType": "ServiceRequest",
9
        "id": "RedoxServiceRequestExamplePlanOfCareOrder",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.798268",
13
            "value": "8567903823"
14
          }
15
        ],
16
        "subject": {
17
          "reference": "Patient/RedoxPatientExampleTimothy"
18
        },
19
        "encounter": {
20
          "reference": "Encounter/RedoxEncompassingEncounterExample"
21
        },
22
        "occurrenceDateTime": "2012-08-20T05:00:00.000Z",
23
        "status": "active",
24
        "_status": {
25
          "extension": [
26
            {
27
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
28
              "valueString": "Request"
29
            }
30
          ]
31
        },
32
        "category": [
33
          {
34
            "coding": [
35
              {
36
                "code": "Orders",
37
                "system": "urn:redox:plan_of_care_type"
38
              }
39
            ]
40
          }
41
        ],
42
        "code": {
43
          "coding": [
44
            {
45
              "code": "624-7",
46
              "system": "http://snomed.info/sct",
47
              "display": "Sputum Culture"
48
            }
49
          ]
50
        },
51
        "intent": "plan"
52
      },
53
      "search": {
54
        "mode": "match"
55
      }
56
    }
57
  ]
58
}

    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
    Array of ServiceRequest or Other

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

    • 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
          Array of OriginalText or 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.

            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
        Array of object

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

        • extension
          Array of Boolean, String, CodeableConcept, Coding, HumanName or 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.

          • 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
        Array of planOfCareType or Other

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

          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
          Array of 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
          Array of 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.

      • authoredOn
        string

        When the request transitioned to being actionable.

      • requester
        object

        The individual who initiated the request and has responsibility for its activation.

        Must reference one of the following types of resources:

        • Practitioner
        • PractitionerRole
        • Organization
        • Patient
        • RelatedPerson
        • Device
        • 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