Skip to main content
GET
Get Patient by External ID

Query Params

string
The exact external identifier you're trying to find. For Athena external identifiers, it must include the practice prefix (e.g. a-12345.E-6789).
string
If not included, Metriport will search along the custom external identifier submitted at patient create as externalId. If included, it must be athenahealth, elation, or canvas, and will filter along the respective EHR patient identifiers of Metriport patients.

Response

string
required
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical documents.
string
The ID of the Patient on your internal system to associate to a Patient in Metriport.
object
required
Patient status flags.
AdditionalIdentifiers
A map containing additional external identifiers. EHR IDs are populated when the patient is created or mapped through one of our EHR apps. The healthix ID can also be set by customers on patient create/update, and is included in webhook payloads when present.
string[]
required
The Patient's first name(s).
string[]
required
The Patient's last name(s).
string
required
The Patient's date of birth (DOB), formatted YYYY-MM-DD as per ISO 8601.
string
required
The Patient's gender at birth, can be one of M or F or O or U. Use O (other) when the patient's gender is known but it is not M or F, i.e intersex or hermaphroditic. Use U (unknown) when the patient's gender is not known.
PersonalIdentifier[]
An array of the Patient's personal IDs, such as a driver's license. May be empty.
Address[]
required
Contact[]
string[]
required
Array of the IDs of the Facilities where the Patient is receiving care.