- Patient
- Update Patient
Patient
Update Patient
Updates the specified Patient.
/medical/v1/patient/{id}
curl --request PUT \
--url https://api.metriport.com/medical/v1/patient/{id} \
--header 'x-api-key: AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"firstName": "string",
"lastName": "string",
"dob": "string",
"genderAtBirth": "string",
"personalIdentifiers": PersonalIdentifier[],
"address": Address
}'Query Params
The ID of the Facility where the patient is receiving care.
Path Params
The ID of the Patient to update.
Body
The Patient’s first name.
The Patient’s last name.
The Patient’s date of birth (DOB), formatted YYYY-MM-DD.
The Patient’s gender at birth, can be one of M or F.
An array of the Patient’s personal IDs, such as a driver’s license. May be empty.
Response
The ID assigned to this Patient. This ID will be used to uniquely identify this Patient in medical documents.
The Patient’s first name.
The Patient’s last name.
The Patient’s date of birth (DOB), formatted YYYY-MM-DD.
The Patient’s gender at birth, can be one of M or F.
An array of the Patient’s personal IDs, such as a driver’s license. May be empty.
Array of the IDs of the Facilities where the Patient is receiving care.
A map with the Patient link’s status across HIEs. Each HIE is a property, and the status is the value.
import { Metriport, USState } from "@metriport/api";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const patient = await metriportClient.updatePatient(
{
id: "2.16.840.1.113883.3.666.777",
firstName: "Jose",
lastName: "Juarez",
dob: "1951-05-05",
genderAtBirth: "M",
personalIdentifiers: [
{
type: "driversLicense",
state: USState.CA,
value: "51227265",
},
],
address: {
zip: "12345",
city: "San Diego",
state: USState.CA,
country: "USA",
addressLine1: "Guadalajara Sreet",
},
contact: {
phone: "1234567899",
email: "jose@domain.com",
},
},
"2.16.840.1.113883.3.666.5.2004.4.2005"
);
{
"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 PUT \
--url https://api.metriport.com/medical/v1/patient/{id} \
--header 'x-api-key: AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"firstName": "string",
"lastName": "string",
"dob": "string",
"genderAtBirth": "string",
"personalIdentifiers": PersonalIdentifier[],
"address": Address
}'import { Metriport, USState } from "@metriport/api";
const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
const patient = await metriportClient.updatePatient(
{
id: "2.16.840.1.113883.3.666.777",
firstName: "Jose",
lastName: "Juarez",
dob: "1951-05-05",
genderAtBirth: "M",
personalIdentifiers: [
{
type: "driversLicense",
state: USState.CA,
value: "51227265",
},
],
address: {
zip: "12345",
city: "San Diego",
state: USState.CA,
country: "USA",
addressLine1: "Guadalajara Sreet",
},
contact: {
phone: "1234567899",
email: "jose@domain.com",
},
},
"2.16.840.1.113883.3.666.5.2004.4.2005"
);