Patient _search

post/Patient/_search

Page View

This resource establishes demographics and identifiers for an individual visiting or receiving treatment from a healthcare organization. A patient record serves as the most common base for data being exchanged since it establishes the “who” behind the data.

You can review, retrieve, create, update, or match patient records.

Supported fields

We support any valid FHIR® field. However, we only display the fields that we’ve defined in the schema, which are usually based on what’s included in the US Core profile.

_search

This interaction allows you to query for patient records. This is a flexible search option with query parameters to refine your search.

The response can return a bundle of resources, known as a searchset bundle type. Learn about bundles and bundle types in our FHIR® glossary.

Request parameters and payload

When querying for this resource, one of the following sets of parameters must always be sent. Additional parameters may be sent at any time.

_id
identifier
given, family, birthdate

Select example

cURL request example

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Patient/_search' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'Content-Type: application/x-www-form-urlencoded' \
5
--data-urlencode '_revinclude=string' \
6
--data-urlencode 'identifier=string' \
7
--data-urlencode 'active=string' \
8
--data-urlencode 'general-practitioner=string' \
9
--data-urlencode 'general-practitioner.identifier=string' \
10
--data-urlencode 'given=string' \
11
--data-urlencode 'family=string' \
12
--data-urlencode 'birthdate=string' \
13
--data-urlencode 'gender=string' \
14
--data-urlencode 'address-line=string' \
15
--data-urlencode 'address-city=string' \
16
--data-urlencode 'address-state=string' \
17
--data-urlencode 'address-postalcode=string' \
18
--data-urlencode 'phone=string' \
19
--data-urlencode 'email=string'

Request Body Schema

identifier
Array of string
One or more external identifiers for the patient
active
Array of string
Whether or not the patient record is active
general-practitioner
Array of string
Patient's nominated general practitioner, not the organization that manages the record
general-practitioner.identifier
Array of string
One or more external identifiers for the practitioner
given
Array of string
The given (first or middle) name of the patient
family
Array of string
The family name of the patient
birthdate
Array of string
The patient's date of birth
gender
Array of string
Gender of the patient
address-line
Array of string
A line specified in an address
address-city
Array of string
A city specified in an address
address-state
Array of string
A state specified in an address
address-postalcode
Array of string
A postalCode (in the US, a ZIP code) specified in an address
phone
Array of string
A value in a phone contact
email
Array of string
A value in an email contact
_revinclude
Array of string
Set to Coverage:beneficiary and Account:subject to include insurance-related resources

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": "Patient",
9
        "id": "RedoxPatientExampleTimothy",
10
        "meta": {
11
          "extension": [
12
            {
13
              "url": "https://fhir.redoxengine.com/StructureDefinition/example-sort-order",
14
              "valueInteger": 1
15
            }
16
          ]
17
        },
18
        "extension": [
19
          {
20
            "extension": [
21
              {
22
                "url": "text",
23
                "valueString": "White"
24
              }
25
            ],
26
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race"
27
          },
28
          {
29
            "extension": [
30
              {
31
                "url": "ombCategory",
32
                "valueCoding": {
33
                  "code": "2135-2",
34
                  "system": "urn:oid:2.16.840.1.113883.6.238",
35
                  "display": "Hispanic or Latino"
36
                }
37
              },
38
              {
39
                "url": "text",
40
                "valueString": "Hispanic"
41
              }
42
            ],
43
            "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity"
44
          }
45
        ],
46
        "identifier": [
47
          {
48
            "value": "0000000001",
49
            "system": "urn:redox:health-one:MR"
50
          },
51
          {
52
            "value": "101-01-0001",
53
            "system": "http://hl7.org/fhir/sid/us-ssn"
54
          }
55
        ],
56
        "name": [
57
          {
58
            "given": [
59
              "Timothy",
60
              "Paul"
61
            ],
62
            "family": "Bixby",
63
            "use": "official"
64
          },
65
          {
66
            "text": "Billy",
67
            "use": "usual"
68
          }
69
        ],
70
        "gender": "male",
71
        "birthDate": "2008-01-06",
72
        "telecom": [
73
          {
74
            "value": "+18088675301",
75
            "system": "phone",
76
            "use": "home"
77
          },
78
          {
79
            "value": "+18008675309",
80
            "system": "phone",
81
            "use": "work"
82
          },
83
          {
84
            "value": "timothy.bixby@redoxengine.com",
85
            "system": "email"
86
          }
87
        ],
88
        "address": [
89
          {
90
            "line": [
91
              "4762 Hickory Street"
92
            ],
93
            "city": "Monroe",
94
            "district": "Greene",
95
            "state": "WI",
96
            "postalCode": "53566",
97
            "country": "US",
98
            "use": "home"
99
          }
100
        ],
101
        "maritalStatus": {
102
          "coding": [
103
            {
104
              "code": "M",
105
              "system": "http://hl7.org/fhir/v3/MaritalStatus",
106
              "display": "Married"
107
            }
108
          ],
109
          "text": "Married"
110
        },
111
        "communication": [
112
          {
113
            "language": {
114
              "coding": [
115
                {
116
                  "code": "en",
117
                  "system": "urn:ietf:bcp:47"
118
                }
119
              ],
120
              "text": "English"
121
            }
122
          }
123
        ],
124
        "contact": [
125
          {
126
            "name": {
127
              "given": [
128
                "Barbara"
129
              ],
130
              "family": "Bixby"
131
            },
132
            "telecom": [
133
              {
134
                "value": "+18088675303",
135
                "system": "phone",
136
                "use": "home"
137
              },
138
              {
139
                "value": "barbara.bixby@redoxengine.com",
140
                "system": "email"
141
              }
142
            ],
143
            "address": {
144
              "line": [
145
                "4762 Hickory St."
146
              ],
147
              "city": "Monroe",
148
              "district": "Green",
149
              "state": "WI",
150
              "postalCode": "53566",
151
              "country": "USA"
152
            },
153
            "relationship": [
154
              {
155
                "coding": [
156
                  {
157
                    "code": "MTH",
158
                    "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
159
                    "display": "mother"
160
                  }
161
                ],
162
                "text": "Mother"
163
              },
164
              {
165
                "coding": [
166
                  {
167
                    "code": "C",
168
                    "system": "http://terminology.hl7.org/CodeSystem/v2-0131",
169
                    "display": "Emergency Contact"
170
                  }
171
                ],
172
                "text": "Emergency Contact"
173
              }
174
            ]
175
          }
176
        ],
177
        "generalPractitioner": [
178
          {
179
            "reference": "Practitioner/RedoxPractitionerExamplePat"
180
          }
181
        ],
182
        "managingOrganization": {
183
          "reference": "Organization/RedoxOrganizationManagingExample"
184
        }
185
      },
186
      "search": {
187
        "mode": "match"
188
      }
189
    }
190
  ]
191
}

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®.