Get Patients

get

https://fhir-api.fhirprod.aws.greenwayhealth.com/fhir/R4/TENANT_ID/Patient

The Patient resource contains demographics and other administrative information about an individual receiving care or other health-related services.

See also:
US Core Patient Profile

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_has

string

Return resources linked to by the given target

_id

string

The ID of the resource

_lastUpdated

date

Only return resources which were last updated as specified by the given range

_security

string

Search for resources which have the given security labels

_count

string

Returns the number of results on a single page

active

boolean

Whether the patient record is active

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

address-city

string

A city specified in an address

address-country

string

A country specified in an address

address-postalcode

string

A postalCode specified in an address

address-state

string

A state specified in an address

address-use

string

A use code specified in an address

birthdate

date

The patient's date of birth

death-date

date

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

deceased

string

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

string

A value in an email contact

family

string

A portion of the family name of the patient

gender

string

Gender of the patient

general-practitioner

string

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

given

string

A portion of the given name of the patient

identifier

string

A patient identifier

language

string

Language code (irrespective of use value)

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

organization

string

The organization that is the custodian of the patient record

phone

string

A value in a phone contact

telecom

string

The value in any kind of telecom details of the patient

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

400

Bad Request - An unexpected error occurred. A parameter value is missing, invalid, or improperly formatted.

401

Unauthorized - User was denied access to the FHIR resource.

403

Forbidden - Access was denied for this FHIR resource with the given credentials.

404

Not Found - The FHIR resource was not found.

500

Internal Server Error - The server encountered an unexpected condition that prevented it from fulfilling the request.

200OK - The request was received and the resource has been transmitted successfully. (See Response area for examples)