Skip to main content
POST
/
user
/
patient
/
create
Patient Create
curl --request POST \
  --url https://api.decodahealth.com/user/patient/create \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "externalId": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "address": "<string>",
  "addressLineTwo": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "addressValid": true,
  "meta": {},
  "primaryLocationId": "<string>",
  "id": "<string>",
  "firebaseUid": "<string>",
  "dateOfBirth": "2023-12-25",
  "type": "PATIENT",
  "gender": "<string>",
  "patientSource": "SELF_SCHEDULING",
  "onSchedulingBlacklist": false,
  "surchargeDisabled": false,
  "creditBalance": 0,
  "preferredProviderId": "<string>"
}
'
{
  "id": "<string>",
  "type": "PROVIDER",
  "createdDate": "2023-11-07T05:31:56Z",
  "firstName": "<string>",
  "lastName": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "locationId": "<string>",
  "externalId": "<string>",
  "address": "<string>",
  "addressLineTwo": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zipCode": "<string>",
  "country": "<string>",
  "addressValid": true,
  "meta": {},
  "isArchived": true,
  "primaryLocationId": "<string>",
  "gender": "<string>",
  "dateOfBirth": "2023-12-25",
  "patientMedications": [
    "<string>"
  ],
  "onSchedulingBlacklist": true,
  "surchargeDisabled": true,
  "tags": [
    {
      "id": "<string>",
      "name": "<string>",
      "isActive": true,
      "createdDate": "2023-11-07T05:31:56Z",
      "emoji": "<string>",
      "color": "<string>",
      "updatedDate": "2023-11-07T05:31:56Z"
    }
  ],
  "creditBalance": 123,
  "preferredProviderId": "<string>"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
firstName
string | null

The user's first name.

lastName
string | null

The user's last name.

externalId
string | null

An identifier in your system that corresponds to this patient.

email
string | null

The user's email address.

phoneNumber
string | null

The user's phone number.

address
string | null

The user's primary address.

addressLineTwo
string | null

Additional address information.

city
string | null

The city of the user's address.

state
string | null

The state of the user's address.

zipCode
string | null

The postal code of the user's address.

country
string | null

The country of the user's address.

addressValid
boolean | null

Whether the user's address is valid.

meta
Meta · object

Any additional metadata about the user relevant to your system.

primaryLocationId
string | null

The primary location of the patient.

id
string | null

The unique identifier for the user.

firebaseUid
string | null

The user's Firebase UID if available.

dateOfBirth
string<date> | null

The date of birth of the patient.

type
string
default:PATIENT
gender
string | null

The gender of the patient.

patientSource
enum<string> | null

The source of the patient.

Available options:
SELF_SCHEDULING,
CALL,
TEXT,
MANUALLY_CREATED,
UPLOADED_FROM_FILE,
FORM,
SEED_DATA,
DEMO,
EXTERNAL_INTEGRATION,
OTHER
onSchedulingBlacklist
boolean | null
default:false

Whether the patient is on the scheduling blacklist.

surchargeDisabled
boolean | null
default:false

Whether surcharges are disabled for this patient.

creditBalance
integer | null
default:0

Patient's credit balance in cents.

preferredProviderId
string | null

The preferred provider ID for this patient.

Response

Successful Response

id
string
required

The unique identifier for the user.

type
enum<string>
required

The type of user.

Available options:
PROVIDER,
PATIENT,
ASSISTANT
createdDate
string<date-time>
required

The date and time when the user was created.

firstName
string | null

The user's first name.

lastName
string | null

The user's last name.

phoneNumber
string | null

The user's phone number.

email
string | null

The user's email address.

locationId
string | null

The location of the user.

externalId
string | null

The user's external identifier if available.

address
string | null

The user's primary address.

addressLineTwo
string | null

Additional address information.

city
string | null

The city of the user's address.

state
string | null

The state of the user's address.

zipCode
string | null

The postal code of the user's address.

country
string | null

The country of the user's address.

addressValid
boolean | null

Whether the user's address is valid.

meta
Meta · object

Any additional metadata about the user relevant to your system.

isArchived
boolean | null

Whether the user is archived.

primaryLocationId
string | null

The primary location of the user.

gender
string | null

The gender of the patient.

dateOfBirth
string<date> | null

The date of birth of the patient.

patientMedications
string[] | null

List of patient's self-reported medications.

onSchedulingBlacklist
boolean | null

Whether the patient is on the scheduling blacklist.

surchargeDisabled
boolean | null

Whether surcharges are disabled for this patient.

tags
PatientTagSummary · object[] | null

List of patient tags

creditBalance
integer | null

Patient's credit balance in cents.

preferredProviderId
string | null

The preferred provider ID for this patient.