Encounter _search

post/Encounter/_search

Page View

This resource contains details and outcomes for a patient encounter, which can include one or more providers, locations, and services.

Encounters may encompass preadmission, outpatient visits, telehealth visits, inpatient stays, and discharges, depending on the organization and context for the encounter.

Encounters may contain references to procedures if:

A procedure was completed during a patient visit.
A follow-up procedure is scheduled as a result of the encounter.

You can review, retrieve, save, or cancel encounter details.

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 details about a patient visit.

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.

Data on demand requirements

For data on demand searches, you must include at least one of these query parameters:

FHIR® resource ID for Patient resource (learn about FHIR® references or review HL7's docs on references)
_id
identifier (learn about handling FHIR® identifiers)
date
status

Request parameters and payload

cURL request example

bash

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

Request Body Schema

identifier
Array of string
Identifier(s) by which this encounter is known
date
Array of string
A date within the period the Encounter lasted
practitioner
Array of string
Persons involved in the encounter other than the patient
practitioner.identifier
Array of string
One or more external identifiers for the practitioner
patient
Array of string
The patient or group present at the encounter
patient.identifier
Array of string
One or more external identifiers for the patient
location
Array of string
Location the encounter takes place
location.name
Array of string
The location's name.
location.name-physical-type
Array of string
Specify both name and physical-type at once. This is a Redox-specific parameter.
destination
Array of string
Location to which the patient is discharged
status
Array of string
The encounter's status
class-display
Array of string
The encounter's class; inpatient | outpatient | ambulatory | emergency +
_include
Array of string
Set to Encounter:location and Location:partof to include all location information associated with encounters.

Additionally, Encounter:patient and Encounter:practitioner can be included to return patient and practitioners resources within the same search result bundle. If omitted, these resources can also be retrieved individually at a later time.

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": "Encounter",
9
        "id": "RedoxEncounterExample",
10
        "identifier": [
11
          {
12
            "system": "urn:oid:1.2.840.114350.1.13.12345.1.7.2.698084.11",
13
            "value": "9601346482"
14
          }
15
        ],
16
        "status": "finished",
17
        "class": {
18
          "code": "IMP",
19
          "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
20
          "display": "inpatient encounter"
21
        },
22
        "type": [
23
          {
24
            "coding": [
25
              {
26
                "code": "99222",
27
                "system": "http://www.ama-assn.org/go/cpt",
28
                "display": "InPatient Admission"
29
              }
30
            ]
31
          }
32
        ],
33
        "diagnosis": [
34
          {
35
            "condition": {
36
              "reference": "Condition/RedoxConditionExampleEncounterDx"
37
            }
38
          }
39
        ],
40
        "participant": [
41
          {
42
            "individual": {
43
              "reference": "Practitioner/RedoxPractitionerExampleEncounter"
44
            }
45
          }
46
        ],
47
        "location": [
48
          {
49
            "location": {
50
              "reference": "Location/RedoxLocationExampleEncounter"
51
            }
52
          }
53
        ],
54
        "subject": {
55
          "reference": "Patient/RedoxPatientExampleTimothy"
56
        },
57
        "period": {
58
          "start": "2022-02-06T04:00:00.000Z",
59
          "end": "2022-02-06T04:15:00.000Z"
60
        },
61
        "length": {
62
          "value": 16,
63
          "code": "m",
64
          "system": "http://unitsofmeasure.org"
65
        },
66
        "reasonCode": [
67
          {
68
            "coding": [
69
              {
70
                "code": "23360407",
71
                "system": "http://snomed.info/sct"
72
              }
73
            ],
74
            "text": "Pneumonia"
75
          }
76
        ]
77
      },
78
      "search": {
79
        "mode": "match"
80
      }
81
    }
82
  ]
83
}

Response to an Encounter search operation containing encounter resources

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 Encounter, Location, Practitioner, Patient 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®.