Patients

Create a patient

Creates a new patient record. The clinic is determined by the provided API key.

If a patient with a similar name and date of birth already exists, the existing patient is returned with a 200 status instead of creating a duplicate.

Billing info: If address is provided, billing address is automatically populated from it — no need to send it separately.

post/patients

Request body

firstNamestring required
lastNamestring required
middleNamestring
genderstring required
genderIdentitystring
pronounstring
dateOfBirthstring required

Date of birth in MM/DD/YYYY format

raceEthnicity'White' | 'Black or African American' | 'Asian' | 'Hispanic or Latino' | 'American Indian or Alaska Native' | 'Native Hawaiian or Other Pacific Islander' | 'Other' | 'Prefer not to say'
emailstring email
phoneNumberstring
externalEhrIdstring

Patient ID in the external EHR system

externalEhrstring

Name of the external EHR system

Example request

{
  "firstName": "Alice",
  "lastName": "Johnson",
  "middleName": "Marie",
  "gender": "Female",
  "genderIdentity": "Non-binary",
  "pronoun": "they/them",
  "dateOfBirth": "06/28/1996",
  "email": "patient@test.com",
  "phoneNumber": "+12025551234",
  "address": {
    "address1": "123 Main St",
    "address2": "Apt 4B",
    "city": "New York",
    "state": "NY",
    "zip": "10001"
  },
  "externalEhrId": "ext_abc123",
  "externalEhr": "example-ehr",
  "diagnoses": [
    {
      "code": "F32.1",
      "description": "Major depressive disorder, single episode, moderate"
    }
  ],
  "relatedContacts": [
    {
      "fullName": "Jane Doe",
      "email": "jane@example.com",
      "phones": [
        "+12025551234"
      ],
      "relationship": "Spouse",
      "hipaaConsent": true
    }
  ],
  "insurances": [
    {
      "tradingPartnerName": "Blue Cross Blue Shield",
      "memberId": "XYZ123456789",
      "groupNumber": "GRP001",
      "company": "Anthem",
      "isPrimary": true
    }
  ]
}

Response

Patient already existed — returns the existing patient ID

patientIdstring
messagestring

Example response

{
  "patientId": "abc123",
  "message": "Patient already existed"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.