Vitals

Vitals are basic physiological measurements that indicate the state of a patient's essential bodily functions.

The vitals model

Properties

Name
id
Type
string
Description
Unique identifier for the vitals.
Name
object
Type
string
Description
Always 'vitals'.
Name
patient
Type
string
Description
Patient this vitals is for.
Name
height
Type
number
Description
Patient's height in inches.
Name
weight
Type
number
Description
Patient's weight in lbs.
Name
blood_pressure
Type
object
Description
Blood pressure for the patient.
Name
temperature
Type
number
Description
Patient's temperature in Fahrenheit.
Name
pulse
Type
number
Description
Patient's pulse in bpm.
Name
respiratory_rate
Type
number
Description
Patient's respiratory rate in rpm.
Name
oxygen_saturation
Type
number
Description
Patient's oxygen saturation percentage.
Name
pain
Type
number
Description
Patient's pain level on a 1 - 10 scale (10 being highest).
Name
created_by
Type
string
Description
Creator of the vitals.
Name
created_at
Type
date-time
Description
Timestamp (in ISO 8601 format) of when the vitals was created.
Name
last_updated_at
Type
date-time
Description
Timestamp (in ISO 8601 format) of when the vitals was last updated.

Response

{
    "id": "vtls_2UxtAULYUrX7GVsTKePy",
    "object": "vitals",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "height": 72,
    "weight": 180,
    "blood_pressure": {
        "systolic": 120,
        "diastolic": 80
    },
    "temperature": 98.6,
    "pulse": 72,
    "respiratory_rate": 16,
    "oxygen_saturation": 98,
    "pain": 3,

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-07-07T00:52:02.504Z",
    "last_updated_at": "2024-07-07T00:52:02.504Z"
}

POST/v2/vitals

Create an vitals

Creates a new vitals.

Required attributes

Name
patient
Type
string
Description
Patient this vitals is for.

Optional attributes

Name
height
Type
number
Description
Patient's height in inches.
Name
weight
Type
number
Description
Patient's weight in lbs.
Name
temperature
Type
number
Description
Patient's temperature in Fahrenheit.
Name
pulse
Type
number
Description
Patient's pulse in bpm.
Name
respiratory_rate
Type
number
Description
Patient's respiratory rate in rpm.
Name
oxygen_saturation
Type
number
Description
Patient's oxygen saturation percentage.
Name
pain
Type
number
Description
Patient's pain level on a 1 - 10 scale (10 being highest).

Response

{
    "id": "vtls_2UxtAULYUrX7GVsTKePy",
    "object": "vitals",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "height": 72,
    "weight": 180,
    "blood_pressure": {
        "systolic": 120,
        "diastolic": 80
    },
    "temperature": 98.6,
    "pulse": 72,
    "respiratory_rate": 16,
    "oxygen_saturation": 98,
    "pain": 3,

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-07-07T00:52:02.504Z",
    "last_updated_at": "2024-07-07T00:52:02.504Z"
}

GET/v2/vitals/:id

Retrieve an vitals

Retrieves the specified vitals.

Response

{
   "id": "vtls_2UxtAULYUrX7GVsTKePy",
   "object": "vitals",
   "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

   "height": 72,
   "weight": 180,
   "blood_pressure": {
       "systolic": 120,
       "diastolic": 80
   },
   "temperature": 98.6,
   "pulse": 72,
   "respiratory_rate": 16,
   "oxygen_saturation": 98,
   "pain": 3,

   "created_by": "user_xeDpGyt67wTor93qKtS7",
   "created_at": "2024-07-07T00:52:02.504Z",
   "last_updated_at": "2024-07-07T00:52:02.504Z"
}

POST/v2/vitals/:id

Update an vitals

Updates the specified vitals object by setting the values of the parameters passed. Any other parameters not provided will not be modified.

Required attributes

Optional attributes

Name
height
Type
number
Description
Patient's height in inches.
Name
weight
Type
number
Description
Patient's weight in lbs.
Name
temperature
Type
number
Description
Patient's temperature in Fahrenheit.
Name
pulse
Type
number
Description
Patient's pulse in bpm.
Name
respiratory_rate
Type
number
Description
Patient's respiratory rate in rpm.
Name
oxygen_saturation
Type
number
Description
Patient's oxygen saturation percentage.
Name
pain
Type
number
Description
Patient's pain level on a 1 - 10 scale (10 being highest).

Response

{
    "id": "vtls_2UxtAULYUrX7GVsTKePy",
    "object": "vitals",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

    "height": 72,
    "weight": 180,
    "blood_pressure": {
        "systolic": 120,
        "diastolic": 80
    },
    "temperature": 98.6,
    "pulse": 72,
    "respiratory_rate": 16,
    "oxygen_saturation": 98,
    "pain": 3,

    "created_by": "user_xeDpGyt67wTor93qKtS7",
    "created_at": "2024-07-07T00:52:02.504Z",
    "last_updated_at": "2024-07-07T00:52:02.504Z"
}

GET/v2/vitals

List all vitals

Returns a list of all vitals.

Optional query parameters

Name
patient
Type
string
Description
Patient ID to filter by.

Request

GET

/v2/vitals

curl https://{{base_subdomain}}.avonhealth.com/v2/vitals?patient=user_Z1zXZKvqrpwxbznuW6lJ \
  -H "Authorization: Bearer {{token}}" \
  -H "x-jwt: {{jwt}}"

Response

{
  "object": "list",
  "data": [
    {
        "id": "vtls_2UxtAULYUrX7GVsTKePy",
        "object": "vitals",
        "patient": "user_Z1zXZKvqrpwxbznuW6lJ",

        "height": 72,
        "weight": 180,
        "blood_pressure": {
            "systolic": 120,
            "diastolic": 80
        },
        "temperature": 98.6,
        "pulse": 72,
        "respiratory_rate": 16,
        "oxygen_saturation": 98,
        "pain": 3,

        "created_by": "user_xeDpGyt67wTor93qKtS7",
        "created_at": "2024-07-07T00:52:02.504Z",
        "last_updated_at": "2024-07-07T00:52:02.504Z"
    },
  ]
}

DELETE/v2/vitals/:id

Delete an vitals

Deletes the specified vitals.

Required attributes

Optional attributes

Response

{
    "id": "vtls_2UxtAULYUrX7GVsTKePy",
    "object": "vitals",
    "delete": true
}