Path Params
Response
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical
documents.
The ID of the Patient on your internal system to associate to a Patient in Metriport.
A map containing additional external identifiers. If the patient is created or mapped in Metriport through one of
our EHR apps - this property will be populated with the ID from the EHR, and included
within the webhook payloads. Show AdditionalIdentifiers properties
Athena patient ID. If more than one patient in Athena maps to a Metriport patient, they
will all be included.
Canvas patient ID. If more than one patient in Canvas maps to a Metriport patient, they
will all be included.
Elation Patient ID. If more than one patient in Elation maps to a Metriport patient, they
will all be included.
The Patient's first name(s).
The Patient's last name(s).
The Patient's date of birth (DOB), formatted YYYY-MM-DD
as per ISO 8601.
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.
An array of the Patient's personal IDs, such as a driver's license. May be empty. Show PersonalIdentifier properties
The ID type - currently driversLicense
is supported.
The 2 letter state acronym where this ID was issued, for example: CA
.
The address details, for example: #4451
.
The 2 letter state acronym, for example: CA
.
The Patient's 10 digit phone number, formatted 1234567899
.
The Patient's email address.
Array of the IDs of the Facilities where the Patient is receiving care.
import { MetriportMedicalApi } from "@metriport/api-sdk" ;
const metriport = new MetriportMedicalApi ( "YOUR_API_KEY" );
const patient = await metriport . getPatient ( "018a80c4-292a-7486-a1234-76yuhe23yu14" );
{
"id" : "018a80c4-292a-7486-a1234-76yuhe23yu14" ,
"externalId" : "1234567890" ,
"additionalIds" : {
"athenahealth" : [ "43210" ],
"canvas" : [ "1234567890" ],
"elation" : [ "0987654321" ]
},
"facilityIds" : [ "018a80c4-292a-7486-a1234-9uiu76yhe234" ]
"firstName" : "Jose" ,
"lastName" : "Juarez" ,
"dob" : "1951-05-05" ,
"genderAtBirth" : "M" ,
"personalIdentifiers" : [
{
"type" : "driversLicense" ,
"state" : "CA" ,
"value" : "51227265"
}
],
"address" : [
{
"zip" : "12345" ,
"city" : "San Diego" ,
"state" : "CA" ,
"country" : "USA" ,
"addressLine1" : "Guadalajara St"
}
],
"contact" : [
{
"phone" : "1234567899" ,
"email" : "jose@domain.com"
}
],
}