Create Patient

POST

Creates a new patient record with the provided details.

For more information see the Patient Model.

Request

This endpoint expects an object.
firstNamestringRequired

The patient’s first name.

lastNamestringRequired

The patient’s last name.

addressobjectRequired

The patient’s shipping address. Required on all endpoints except PATCH patient.

idlongOptional

Unique identifier for the patient, managed by Impilo.

externalIdentifierstringOptional

Unique external identifier for the patient, managed by the customer.

dateOfBirthstringOptional

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

emailstringOptional

The patient’s email.

phoneNumberstringOptional

The patient’s phone number.

archivedbooleanOptional

True if the patient is archived, false otherwise.

siteobjectOptional

The site responsible for this patient.

enrolledbooleanOptional

The enrollment status. False if disenrolled.

sexenumOptional
Allowed values: otherfemalemaleunknown

Response

This endpoint returns an object.
firstNamestring

The patient’s first name.

lastNamestring

The patient’s last name.

addressobject

The patient’s shipping address. Required on all endpoints except PATCH patient.

idlongOptional

Unique identifier for the patient, managed by Impilo.

externalIdentifierstringOptional

Unique external identifier for the patient, managed by the customer.

dateOfBirthstringOptional

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

emailstringOptional

The patient’s email.

phoneNumberstringOptional

The patient’s phone number.

archivedbooleanOptional

True if the patient is archived, false otherwise.

siteobjectOptional

The site responsible for this patient.

enrolledbooleanOptional

The enrollment status. False if disenrolled.

sexenumOptional
Allowed values: otherfemalemaleunknown
Built with