Appointment _search

post/Appointment/_search

Page View

This resource contains entries with a patient, provider, or location schedule. Each appointment entry contains the status, participants, date/time, and other details.

You can review, retrieve, create, update, or cancel appointment information.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

_search

Query for a patient, provider, or location appointment schedule. Review tips for appointment searches.

Flexible FHIR queries, different query parameters

FHIR® queries are a flexible option with 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.

We only note which query parameters are required if you're querying a FHIR® server directly. Remember that Redox (i.e., data on demand) isn't a FHIR® server, and your connection may not be either.

Query parameters will vary between sites. Work with your connection to find out which query parameters they require for a successful search.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Appointment/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode 'identifier=string' \
6
--data-urlencode 'date=string' \
7
--data-urlencode 'practitioner=string' \
8
--data-urlencode 'practitioner.identifier=string' \
9
--data-urlencode 'patient=string' \
10
--data-urlencode 'patient.identifier=string' \
11
--data-urlencode 'location=string' \
12
--data-urlencode 'location.identifier=string' \
13
--data-urlencode 'location.name=string' \
14
--data-urlencode 'location.physical-type=string' \
15
--data-urlencode 'location.name-physical-type=string' \
16
--data-urlencode 'status=string'

Request Body Schema

identifier
Array of string
One or more external identifiers for the appointment
date
Array of string
The date/time when the appointment starts
practitioner
Array of string
Any practitioner(s) that are participants in the appointment
practitioner.identifier
Array of string
One or more external identifiers for the practitioner
patient
Array of string
Any patient(s) that are participants in the appointment
patient.identifier
Array of string
One or more external identifiers for the patient
location
Array of string
Any location(s) that are participants in the appointment
location.identifier
Array of string
One or more external identifiers for the location
location.name
Array of string
The location's name.
location.physical-type
Array of string
The location's physical form
location.name-physical-type
Array of string
Specify both name and physical-type at once. This is a Redox-specific parameter.
status
Array of string
The appointment's status

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": "Appointment",
9
        "id": "RedoxAppointmentExample",
10
        "participant": [
11
          {
12
            "status": "accepted",
13
            "actor": {
14
              "reference": "Patient/RedoxPatientExampleTimothy"
15
            }
16
          },
17
          {
18
            "status": "accepted",
19
            "actor": {
20
              "reference": "Location/RedoxLocationExample"
21
            }
22
          }
23
        ],
24
        "identifier": [
25
          {
26
            "system": "urn:oid:1.2.840.114350.1.13.123.1.7.3.698084.8",
27
            "value": "321654654"
28
          }
29
        ],
30
        "appointmentType": {
31
          "coding": [
32
            {
33
              "code": "EMERGENCY",
34
              "system": "http://terminology.hl7.org/CodeSystem/v2-0276",
35
              "display": "Emergency appointment"
36
            }
37
          ]
38
        },
39
        "status": "proposed",
40
        "_status": {
41
          "extension": [
42
            {
43
              "url": "http://hl7.org/fhir/StructureDefinition/originalText",
44
              "valueString": "Intent"
45
            }
46
          ]
47
        },
48
        "start": "2012-08-20T05:00:00.000Z",
49
        "end": "2012-08-20T05:15:00.000Z",
50
        "minutesDuration": 15,
51
        "reasonCode": [
52
          {
53
            "coding": [
54
              {
55
                "code": "99241",
56
                "system": "http://www.ama-assn.org/go/cpt",
57
                "display": "Office consultation - 15 minutes"
58
              }
59
            ]
60
          }
61
        ]
62
      },
63
      "search": {
64
        "mode": "match"
65
      }
66
    }
67
  ]
68
}

Response to an Appointment 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 Appointment or Other
A resource matching the search criteria or related to a matching resource

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.