Getting Started
API Reference
FHIR
- FHIR Overview
- Data Types
- Resources
- Extensions
List Patients at Facility
Lists all Patients receiving care at the specified Facility.
The ID of the Facility where the patient is receiving care.
Query Params
The ID of the Facility where the patient is receiving care.
Response
All Patients receiving care at the specified Facility, or all Patients if no Facility is specified.
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical documents.
An external Patient ID to associate to a Patient in Metriport.
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.
The ID type - currently driversLicense is supported.
The 2 letter state acronym where this ID was issued, for example: CA.
The ID number.
The address.
The address details, for example: #4451.
The city.
The 2 letter state acronym, for example: CA.
5 digit zip code.
Always "USA".
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.
{
"patients": [
{
"id": "018a80c4-292a-7486-a1234-76yuhe23yu14",
"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"
}
],
"externalId": "123456789",
},
{
"id": "018a80c4-292a-7486-a1234-5ert32uij123",
"externalId": "123456789",
"facilityIds": ["018a80c4-292a-7486-a1234-9uiu76yhe234"],
"firstName": "Josita",
"lastName": "Juarez,Diaz",
"dob": "1949-06-09",
"genderAtBirth": "F",
"address": [
{
"zip": "12345",
"city": "San Diego",
"state": "CA",
"country": "USA",
"addressLine1": "Guadalajara St"
},
]
}
]
}