search-type: Search for Patient instances

This is a search type

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use Authentication Endpoint page to get token

Query Params
string

Number of records to use as the page size for paginated search. The maximum page size for this Resource is 50

date

This is an Optional Date in the format lastUpdated=gtDATE, lastUpdated=eqDATE and _lastUpdated=leDATE in the format yyyy-mm-dd

string

A postalCode specified in an address

string

Whether the patient record is active (true|false)

date

This is the patient's Date of birth - Valid format yyyy-MM-dd

string

A value in an email contact

string

This is the patient's last name - Supports exact matches

string

This is the patient's gender - male, female, or unknown

string

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

string

A portion of the given name of the patient

string

This is a List of Identifiers for a Patient. Valid Identifier Systems are MRN with a system value of https://www.hl7.org/fhir/v2/0203/index.html#v2-0203-MR, SSN with a system value of http://hl7.org/fhir/sid/us-ssn, or PMS to be used for the PMS Id

string

Language code (irrespective of use value)

string

Page to be used for paginated search

string

A value in a phone contact

string

Returns patients with an ethnicity extension matching the specified code. Detailed Extension specification can be found at: http://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity.

string

Returns patients with a race extension matching the specified code. Detailed Extension specification can be found at: http://hl7.org/fhir/us/core/StructureDefinition/us-core-race.

string

If the Patient has been assigned a Referral Source in MMPM, this will be a reference to that ID. Referral Sources can be found by querying the following Value Set: {base url}/{firm_url_prefix}/ema/fhir/v2/ValueSet/referral-source

Headers
string
enum

Optional header. Referral adds Referral Contact and Referral Source information to the Patient payload.

Allowed:
Responses

400

BAD REQUEST - The request was bad, often due to a missing required parameter

401

NOT AUTHORIZED - Authentication error; this token is not allowed access to the API

403

FORBIDDEN

404

NOT FOUND

422

UNPROCESSABLE ENTITY - Request could not be processed; typically a validation error

429

TOO MANY REQUESTS - Request was rate limited (1000 calls/min default); please retry

500

SERVER ERROR - Internal Server Error

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json