Patients Search

get

Patients Search

Returns Patients based on filter criteria OR Provides provision for pagination (stateid, page, page_size, _pretty & _bundletype are query parameters used for Paging).

FHIR documentation for Patient.

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Environment URL
Live

https://fhirsandbox-prod.apigee.net/fhir/v1/Patient

Name Values Description
Authorization

Specify access token for API in the given format: Bearer [access_token].

Accept

The Accept request-header field can be used to specify certain media types which are acceptable for the response.

Name Values Description
_format

Format of data to be returned.

_content

Search the contents of the resource's data using a fulltext search

_id

The resource identity

_language

The resource language

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

_lastUpdated

Only return resources which were last updated as specified by the given range. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

_profile

Search for resources which have the given profile

_security

Search for resources which have the given security labels

_tag

Search for resources which have the given tag

_text

Search the contents of the resource's narrative using a fulltext search

active

Whether the patient record is active

address

An address in any kind of address/part of the patient

address-city

A city specified in an address

address-country

A country specified in an address

address-postalcode

A postalCode specified in an address

address-state

A state specified in an address

address-use

A use code specified in an address

animal-breed

The breed for animal patients

animal-species

The species for animal patients

birthdate

The patient's date of birth. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

birthdate

The patient's date of birth. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

careprovider

Patient's nominated care provider, could be a care manager, not the organization that manages the record

death-date

The date of death has been provided and satisfies this search value. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). The prefixes >, >=, <= and < may be used on the parameter value.

death-date

The date of death has been provided and satisfies this search value. The date parameter format is yyyy-mm-ddThh:nn:ss(TZ). Two dates can be used to specify an interval. The prefixes >, >=, <= and < may be used on the parameter value.

deceased

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

email

A value in an email contact

family

A portion of the family name of the patient

gender

Gender of the patient

given

A portion of the given name of the patient

identifier

A patient identifier

language

Language code (irrespective of use value)

link

All patients linked to the given patient

name

A portion of either family or given name of the patient

organization

The organization at which this person is a patient

phone

A value in a phone contact

phonetic

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

telecom

The value in any kind of telecom details of the patient

Working...