Search Patients

post

https://fhir-api.zapehr.com/r4b/Patient/_search

Patient on the FHIR specification website.

Demographics and other administrative information about an individual or animal receiving care or other health-related services.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

given

string

A portion of the given name of the patient

identifier

string

A patient identifier

address

string

A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text

birthdate

string

The patient's date of birth

deceased

string

This patient has been marked as deceased, or has a death date entered

address-state

string

A state specified in an address

gender

string

Gender of the patient

general-practitioner

string

Patient's nominated general practitioner, not the organization that manages the record

link

string

All patients linked to the given patient

active

string

Whether the patient record is active

language

string

Language code (irrespective of use value)

address-postalcode

string

A postalCode specified in an address

address-country

string

A country specified in an address

death-date

string

The date of death has been provided and satisfies this search value

phonetic

string

A portion of either family or given name using some kind of phonetic matching algorithm

phone

string

A value in a phone contact

organization

string

The organization that is the custodian of the patient record

address-use

string

A use code specified in an address

name

string

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

telecom

string

The value in any kind of telecom details of the patient

address-city

string

A city specified in an address

family

string

A portion of the family name of the patient

string

A value in an email contact

Responses

401

Unauthorized

403

Forbidden

500

Internal server error

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200List of Patients

400Bad request

404Not found