CAcairhealth

POST /api/patient

Changed on

Creates a patient. id, first_name, and last_name are required; all other fields are optional.

Request

  • Base URL
    https://forecaster.cairhealth.com
  • URL
    https://forecaster.cairhealth.com/api/patient
  • Auth
    HTTP bearer

Request body

idstring required

External patient id

first_namestring required

Patient's first name

last_namestring required

Patient's last name

namestring nullable

Patient's full name

gender'male' | 'female' | 'other' | 'unknown' nullable

Patient gender

dobstring nullable

Date of birth, yyyy-MM-dd

emailstring nullable

Patient email address

phone_numberstring nullable

Patient phone number

preferredContactMethodstring[] nullable

Preferred contact methods. Each value is one of text, email, or call. On update, an empty array clears the preference; omitting the field leaves it unchanged.

Response

Patient created successfully

successboolean
messagestring

Changes