Skip to content
Upvio Developer Docs

Create a Patient

POST
/businesses/{businessId}/patients

Create a patient. By default, if a patient with the same email already exists, they will be updated (upsert behavior). Set mode to “create” to return an error instead.

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name
required
string
email
required
string
phoneMobile
string
primaryStaffId
string format: uuid
preferredLanguage

The preferred language of the patient

string
Allowed values: en es
customFields

Custom field values keyed by the custom field alias. See listCustomFields for the available fields and their types. Only the fields provided are changed. Set a field to null to remove its value. Empty TEXT values are rejected. An unknown alias or invalid value rejects the whole request and nothing is saved. Custom fields cannot be set when the email matches an archived patient.

object
key
additional properties
One of:
string
metadata
One of:
object
key
additional properties
string
mode

When set to “create”, returns an error if a patient with the same email exists. When set to “upsert” (default), updates the existing patient.

string
default: upsert
Allowed values: create upsert

Responses

Section titled “Responses”

201

Section titled “201”

The created Patient

Media typeapplication/json
object
data
Patient
object
id
required

Unique identifier for the given patient.

string
businessId
required

The ID of the Business this resource belongs to.

string format: uuid
createdAt
required

Time when the resource was created (ISO 8601 format).

string format: date-time
updatedAt
required

Time when the resource was created (ISO 8601 format).

string format: date-time
archivedAt

Time when the resource was archived (ISO 8601 format).

string format: date-time
nullable
archivedReason

Reason for archiving the patient.

string
nullable
email
required

The email address of the patient.

string
name
required

The full legal name of the patient.

string
phoneMobile

The mobile phone number of the patient.

string
nullable
biologicalSex
One of:

The biological sex of the patient

string
nullable
Allowed values: FEMALE MALE OTHER
gender

The gender of the patient

string
nullable
timezone

Timezone string.

string
nullable
preferredLanguage

The preferred language of the patient

string
nullable
Allowed values: en es
dob

The date of birth of the patient (YYYY-MM-DD)

string format: date
nullable
height

The height of the patient in centimeters

number
nullable
weight

The weight of the patient in kilograms

number
nullable
activityLevel

The activity level of the patient

string | null
Allowed values: inactive exercise10Mins exercise20to60Mins exercise1to3Hours exerciseOver3Hours
cholesterol

The total cholesterol level of the patient

number
nullable
cholesterolHdl

The HDL cholesterol level of the patient

number
nullable
cholesterolLdl

The LDL cholesterol level of the patient

number
nullable
chronicMedicationStatus

The chronic medication status of the patient

string | null
Allowed values: none oneOrTwoDiseases threeOrMoreDiseases
diabetesStatus

The diabetes status of the patient

string | null
Allowed values: none preDiabetes diabetes
hypertensionTreatment

The hypertension treatment status of the patient

string | null
Allowed values: notNeeded no yes
race

The race/ethnicity of the patient

string
nullable
smokingStatus

The smoking status of the patient

string | null
Allowed values: never former current
waistCircumference

The waist circumference of the patient in centimeters

number
nullable
neckCircumference

The neck circumference of the patient in centimeters

number
nullable
hipCircumference

The hip circumference of the patient in centimeters

number
nullable
familyDiabetesHistory

The family diabetes history of the patient

string | null
Allowed values: none noneFirstDegree firstDegree
parentalHypertensionHistory

The parental hypertension history of the patient

string | null
Allowed values: none one both
historyOfHighGlucose

Whether the patient has a history of high glucose

boolean
nullable
historyOfHypertension

Whether the patient has a history of hypertension

boolean
nullable
vegetableFruitDiet

Whether the patient consumes vegetables and fruits daily

boolean
nullable
fastingGlucose

The fasting glucose level of the patient

number
nullable
triglyceride

The triglyceride level of the patient

number
nullable
customFields

Custom field values keyed by the custom field alias. See listCustomFields for the available fields. Only fields with a value are included.

object
key
additional properties
One of:
string
metadata
required

Arbitrary string key/value pairs attached to the patient. Up to 10 keys; each key up to 40 characters and each value up to 500 characters. Always present; an empty object when none are set.

object
key
additional properties
string

Example 

{
  "data": {
    "biologicalSex": "FEMALE",
    "timezone": "UTC",
    "preferredLanguage": "en",
    "activityLevel": "inactive",
    "chronicMedicationStatus": "none",
    "diabetesStatus": "none",
    "hypertensionTreatment": "notNeeded",
    "smokingStatus": "never",
    "familyDiabetesHistory": "none",
    "parentalHypertensionHistory": "none"
  }
}

400

Section titled “400”

The patient could not be created.

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: BadRequestError DataValidationError PatientArchivedError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 400,
    "type": "BadRequestError",
    "title": "Unknown custom field \"foo\". Must be one of [memberId, plan]"
  }
}

403

Section titled “403”

The API key is missing or invalid, or the Business cannot be accessed with it.

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: UnauthorizedError BusinessArchivedError BusinessDisabledError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 403,
    "type": "UnauthorizedError",
    "title": "Invalid API token"
  }
}

404

Section titled “404”

The Business does not exist.

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: NotFoundError BusinessNotFoundError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 404,
    "type": "BusinessNotFoundError",
    "title": "Business not found"
  }
}

409

Section titled “409”

A patient with this email already exists (when mode is “create”).

Media typeapplication/json
object
error
object
code
number
type

The specific error that occurred.

string
Allowed values: PatientEmailExistsError
title

Human-readable description of the error.

string

Example 

{
  "error": {
    "code": 409,
    "type": "PatientEmailExistsError",
    "title": "A patient with this email already exists"
  }
}