API ReferencePatients

Create Patient

Creates a new patient record with the provided details.

Headers

Impilo-API-KeystringRequired

Request

This endpoint expects an object.
firstNamestringRequired
The patient's first name.
lastNamestringRequired
The patient's last name.
addressobjectOptional
The patient's shipping address. Required on all endpoints except PATCH patient.
archivedbooleanOptional
True if the patient is archived, false otherwise.
dateOfBirthstringOptionalformat: "date"

The patient’s date of birth in the format YYYY-MM-DD.

emailstringOptionalformat: "email"
The patient's email.
enrolledbooleanOptional
The enrollment status. False if disenrolled.
externalIdentifierstringOptional
Unique external identifier for the patient, managed by the customer.
phoneNumberstringOptional
The patient's phone number.
sexenumOptional
Allowed values:
siteobjectOptional
The site responsible for this patient.

Response

Created
firstNamestring
The patient's first name.
lastNamestring
The patient's last name.
addressobject or null
The patient's shipping address. Required on all endpoints except PATCH patient.
archivedboolean or null
True if the patient is archived, false otherwise.
dateOfBirthstring or nullformat: "date"

The patient’s date of birth in the format YYYY-MM-DD.

emailstring or nullformat: "email"
The patient's email.
enrolledboolean or null
The enrollment status. False if disenrolled.
externalIdentifierstring or null
Unique external identifier for the patient, managed by the customer.
idlong or null
Unique identifier for the patient, managed by Impilo.
phoneNumberstring or null
The patient's phone number.
sexenum or null
Allowed values:
siteobject or null
The site responsible for this patient.