- Patient
- Get Patient
Patient
Get Patient
Gets a Patient.
GET
/medical/v1/patient/{id}
x-api-key*
curl --request GET \
--url https://api.metriport.com/medical/v1/patient/{id} \
--header 'x-api-key: AUTH_VALUE'
Path Params
idRequired
string
The ID of the Patient.
Response
idRequired
string
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical documents.
firstNameRequired
string
The Patient’s first name.
lastNameRequired
string
The Patient’s last name.
dobRequired
string
The Patient’s date of birth (DOB), formatted YYYY-MM-DD
.
genderAtBirthRequired
string
The Patient’s gender at birth, can be one of M
or F
.
personalIdentifiersRequired
PersonalIdentifier[]
An array of the Patient’s personal IDs, such as a driver’s license. May be empty.
addressRequired
Address
contact
Contact
facilityIdsRequired
string[]
Array of the IDs of the Facilities where the Patient is receiving care.
linksRequired
LinkStatusAcrossHIEs
A map with the Patient link’s status across HIEs. Each HIE is a property, and the status is the value.
import { Metriport } from "@metriport/api";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const patient = await metriportClient.getPatient("2.16.840.1.113883.3.666.777");
{
"id": "2.16.840.1.113883.3.666.777",
"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"
},
"facilityIds": [
"2.16.840.1.113883.3.666.5.2004.4.2005"
],
"links": [
"COMMONWELL": "needs-review"
]
}
curl --request GET \
--url https://api.metriport.com/medical/v1/patient/{id} \
--header 'x-api-key: AUTH_VALUE'
import { Metriport } from "@metriport/api";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const patient = await metriportClient.getPatient("2.16.840.1.113883.3.666.777");