ECG Vitals Module API (1.0)

Download OpenAPI specification:Download

Documentation for vitals module

Authentication

bearer

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Health

Checks health of the server

Check the health of the server

Responses
200

The Health Check is successful

503

The Health Check is not successful

get/healthcheck
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/healthcheck
Response samples
application/json
{
  • "status": "ok",
  • "info": {
    },
  • "error": { },
  • "details": {
    }
}

Vital Sign

Creates a new vital sign

Permissions - vitalAdmin, ecgApiKey

Request
Security:
bearer
Request Body schema: application/json
name
required
string

Vital sign name

displayName
required
string

Vital sign display name

code
required
string <= 50 characters

Vital sign code

required
Array of objects (CreateVitalUnitDto)

Array of vital sign units

defaultUnitCode
required
string

Vital sign default unit code

Responses
201
post/vital-signs
Request samples
application/json
{
  • "name": "Systolic Blood Pressure",
  • "displayName": "SYS",
  • "code": "sys",
  • "units": [
    ],
  • "defaultUnitCode": "mmHg"
}
Response samples
application/json
{
  • "id": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "code": "sys",
  • "name": "Systolic Blood Pressure",
  • "displayName": "SYS",
  • "media": {
    },
  • "units": [
    ],
  • "defaultUnitCode": "mmHg",
  • "activeInfo": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Retrieves a list of vital signs given name

Permissions - ecgApiKey

Request
Security:
bearer
query Parameters
name
string

Vital sign name

Example: name=Systolic Blood Pressure
code
string

Vital sign code

Example: code=sys
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/vital-signs
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/vital-signs?name=string&code=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Retrieves a vital sign given an id

Permissions - ecgApiKey

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/vital-signs/{vitalSignId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/vital-signs/{vitalSignId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "id": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "code": "sys",
  • "name": "Systolic Blood Pressure",
  • "displayName": "SYS",
  • "media": {
    },
  • "units": [
    ],
  • "defaultUnitCode": "mmHg",
  • "activeInfo": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    }
}

Updates a vital sign

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Request Body schema: application/json
name
string

Vital sign name

displayName
string

Vital sign display name

code
string <= 50 characters

Vital sign code

Array of objects (UpdateVitalUnitDto)

Vital sign units

defaultUnitCode
string

Vital sign default unit code

Responses
200
patch/vital-signs/{vitalSignId}
Request samples
application/json
{
  • "name": "Systolic Blood Pressure",
  • "displayName": "SYS",
  • "code": "sys",
  • "units": [
    ],
  • "defaultUnitCode": "mmHg"
}
Response samples
application/json
{
  • "result": true
}

Deletes a vital sign

Permissions - vitalAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Responses
200
delete/vital-signs/{vitalSignId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/vital-signs/{vitalSignId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Archives a vital sign

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Responses
200
201
post/vital-signs/{vitalSignId}/archive
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-signs/{vitalSignId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Restores a vital sign

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Responses
200
201
post/vital-signs/{vitalSignId}/restore
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-signs/{vitalSignId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Activates a vital sign

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Responses
200
201
post/vital-signs/{vitalSignId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-signs/{vitalSignId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates a vital sign

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Responses
200
201
post/vital-signs/{vitalSignId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-signs/{vitalSignId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Add Translations for a vital sign given an id

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string

Vital sign UUID

Request Body schema: application/json
locale
string
name
required
string
displayName
required
string
required
Array of objects (CreateVitalUnitDto)
Responses
200
post/vital-signs/{vitalSignId}/translations
Request samples
application/json
{
  • "locale": "en-US",
  • "name": "Systolic Blood Pressure",
  • "displayName": "SYS",
  • "units": [
    ]
}
Response samples
application/json
{
  • "value": true
}

Updates Translations for a vital sign given an id

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
vitalSignId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
Array
required
string or number or boolean or object or Array of strings
path
required
string
op
required
string
Enum: "add" "replace" "remove"
Responses
200
patch/vital-signs/{vitalSignId}/translations
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "value": true
}

Vital Sign Assignments

creates a vital assignment for organizations

Create vital sign assignment for a given organization

Request
path Parameters
organizationId
required
string

Organization UUID

Request Body schema: application/json
vitalSignIds
required
Array of strings

Array of assigned vital sign objects

Responses
201
post/organizations/{organizationId}/vital-signs
Request samples
application/json
{
  • "vitalSignIds": [
    ]
}
Response samples
application/json
{
  • "result": true,
  • "vitalSignAssignmentId": "62e72663-5a9c-464d-935e-a3490918a09c"
}

Deletes a vital sign assignment

Permissions - ecgApiKey

Request
Security:
bearer
path Parameters
organizationId
required
string
vitalSignAssignmentId
required
string
Responses
200
delete/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds an assigned vital for an organization

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

Request Body schema: application/json
required
Array of objects (VitalAssignment)

Array of vital assignment objects

Responses
200
patch/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}
Request samples
application/json
{
  • "vitalSigns": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Retrieves a list of vital signs assignments for an organization

Permissions - vitalSettingRead, ecgApiKey

Request
Security:
bearer
path Parameters
organizationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/organizations/{organizationId}/vital-sign-assignments
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-sign-assignments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "assignedVitalSigns": [
    ],
  • "id": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "organizationId": "'24aaae39-cc1c-4ee5-bb71-93c66e43771c',"
}

Updates an assigned vital for an organization

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

Request Body schema: application/json
required
object

Vital Assignment object

Responses
200
patch/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/update
Request samples
application/json
{
  • "vitalSign": {
    }
}
Response samples
application/json
{
  • "result": true
}

Archives an assigned vital for an organization

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/archive
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Restores an assigned vital for an organization

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/restore
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates an assigned vital for an organization

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/deactivate
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Activates an assigned vital for an organization

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/activate
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

creates a vital sign assignment for subscribers

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
vitalSignIds
required
Array of strings

Array of assigned vital sign objects

Responses
201
post/subscribers/{subscriberId}/vital-signs
Request samples
application/json
{
  • "vitalSignIds": [
    ]
}
Response samples
application/json
{
  • "result": true,
  • "vitalSignAssignmentId": "62e72663-5a9c-464d-935e-a3490918a09c"
}

Deletes a vital sign assignment

Permissions - ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string
vitalSignAssignmentId
required
string
Responses
200
delete/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Adds an assigned vital for a subscriber

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string

subscriber UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

Request Body schema: application/json
required
Array of objects (VitalAssignment)

Array of vital assignment objects

Responses
200
patch/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}
Request samples
application/json
{
  • "vitalSigns": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Retrieves vital signs assignments for a Subscriber

Permissions - subscriberPhiRead, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/subscribers/{subscriberId}/vital-sign-assignments
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-sign-assignments' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "assignedVitalSigns": [
    ],
  • "id": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "subscriberId": "'24aaae39-cc1c-4ee5-bb71-93c66e43771c',"
}

Activates an assigned vital sign for a subscriber

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/activate
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates an assigned vital for a subscriber

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/deactivate
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Restores an assigned vital for an subscriber

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/restore
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Archives an assigned vital for an subscriber

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignAssignmentId
required
string

Vital sign assignment UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
patch/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/archive
Request samples
curl -i -X PATCH \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-sign-assignments/{vitalSignAssignmentId}/vital-signs/{vitalSignId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Vital Sign Thresholds

Creates a new organization vital sign threshold

Permissions - vitalSettingAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignId
required
string

Vital Sign UUID

Request Body schema: application/json
required
Array of objects (ThresholdDto)

Array of threshold objects

normalLow
number

The lower limit of the normal range for this vital sign

normalHigh
number

The upper limit of the normal range for this vital sign

acceptedDisclaimers
required
Array of strings

Array of accepted disclaimer ids

Responses
201
post/organizations/{organizationId}/vital-signs/{vitalSignId}/thresholds
Request samples
application/json
{
  • "thresholds": [
    ],
  • "normalLow": 97,
  • "normalHigh": 100.5,
  • "acceptedDisclaimers": [
    ]
}
Response samples
application/json
{
  • "vitalSignId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "organizationId": "24aaae39-cc1c-4ee5-bb71-93c66e43771c",
  • "subscriberId": "952d927f-99e7-4a47-bd85-7ac3607089be",
  • "thresholds": [
    ],
  • "normalLow": 97,
  • "normalHigh": 100.5,
  • "acceptedDisclaimers": [
    ],
  • "auditInfo": {
    }
}

Updates an organization vital sign

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignId
required
string

Vital Sign UUID

Request Body schema: application/json
Array of objects (ThresholdDto)

Array of threshold objects

normalLow
number

The lower limit of the normal range for this vital sign

normalHigh
number

The upper limit of the normal range for this vital sign

acceptedDisclaimers
Array of strings

A list of IDs for the disclaimers that were accepted

Responses
200
patch/organizations/{organizationId}/vital-signs/{vitalSignId}/thresholds
Request samples
application/json
{
  • "thresholds": [
    ],
  • "normalLow": 97,
  • "normalHigh": 100.5,
  • "acceptedDisclaimers": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Deletes an organization vital sign threshold

Permissions - vitalSettingAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

vitalSignId
required
string

Vital Sign UUID

Responses
200
delete/organizations/{organizationId}/vital-signs/{vitalSignId}/thresholds
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/organizations/{organizationId}/vital-signs/{vitalSignId}/thresholds' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

finds all organization vital sign thresholds

Permissions - vitalSettingRead, ecgApiKey

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

query Parameters
vitalSignId
string

Vital Sign UUID

Responses
200
get/organizations/{organizationId}/thresholds
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/thresholds?vitalSignId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Creates vital sign threshold for a subscriber

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignId
required
string

Vital sign UUID

Request Body schema: application/json
required
Array of objects (ThresholdDto)

Array of threshold objects

normalLow
number

The lower limit of the normal range for this vital sign

normalHigh
number

The upper limit of the normal range for this vital sign

acceptedDisclaimers
required
Array of strings

Array of accepted disclaimer ids

Responses
201
post/subscribers/{subscriberId}/vital-signs/{vitalSignId}/thresholds
Request samples
application/json
{
  • "thresholds": [
    ],
  • "normalLow": 97,
  • "normalHigh": 100.5,
  • "acceptedDisclaimers": [
    ]
}
Response samples
application/json
{
  • "vitalSignId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "organizationId": "24aaae39-cc1c-4ee5-bb71-93c66e43771c",
  • "subscriberId": "952d927f-99e7-4a47-bd85-7ac3607089be",
  • "thresholds": [
    ],
  • "normalLow": 97,
  • "normalHigh": 100.5,
  • "acceptedDisclaimers": [
    ],
  • "auditInfo": {
    }
}

Updates vital sign thresholds by subscriber id and vital sign id

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignId
required
string

Vital sign UUID

Request Body schema: application/json
Array of objects (ThresholdDto)

Array of threshold objects

normalLow
number

The lower limit of the normal range for this vital sign

normalHigh
number

The upper limit of the normal range for this vital sign

acceptedDisclaimers
Array of strings

A list of IDs for the disclaimers that were accepted

Responses
200
patch/subscribers/{subscriberId}/vital-signs/{vitalSignId}/thresholds
Request samples
application/json
{
  • "thresholds": [
    ],
  • "normalLow": 97,
  • "normalHigh": 100.5,
  • "acceptedDisclaimers": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Deletes vital sign thresholds by subscriber id and vital sign id

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

vitalSignId
required
string

Vital sign UUID

Responses
200
delete/subscribers/{subscriberId}/vital-signs/{vitalSignId}/thresholds
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-signs/{vitalSignId}/thresholds' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Finds all vital sign thresholds by subscriber id and vital sign id

Permissions - subscriberPhiRead, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

query Parameters
vitalSignId
string

Vital sign UUID

Responses
200
get/subscribers/{subscriberId}/thresholds
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/thresholds?vitalSignId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Reminder Message Type

Finds all reminder message types

Retrieve all reminder message types

Request
Security:
bearer
Responses
200
get/reminder-message-types
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/reminder-message-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Reminder Message

Creates multiple reminder messages

Permissions - setupDataAdmin

Request
Security:
bearer
Request Body schema: application/json
localeKey
required
string

Locale

required
Array of objects (CreateGenericReminderMessageDto)

Array of reminder message objects

Responses
201
post/reminder-messages
Request samples
application/json
{
  • "localeKey": "en-US",
  • "messages": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Finds all default ECG reminder messages

Retrieve all default ECG reminder messages

Request
Security:
bearer
query Parameters
locale
string

locale to retrieve from messages

Example: locale=en-US
Responses
200
get/reminder-messages
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/reminder-messages?locale=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Creates multiple reminder messages for an organization

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
Request Body schema: application/json
localeKey
required
string

Locale

required
Array of objects (CreateGenericReminderMessageDto)

Array of reminder message objects

Responses
201
post/organization/{organizationId}/reminder-messages
Request samples
application/json
{
  • "localeKey": "en-US",
  • "messages": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Finds all reminder messages for an organization with given locale (defaults to en-US)

Permissions - organizationRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
query Parameters
locale
string

locale to retrieve from messages

Example: locale=en-US
Responses
200
get/organization/{organizationId}/reminder-messages
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organization/{organizationId}/reminder-messages?locale=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Finds all available reminder message translations for an organization

Permissions - organizationRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
Responses
200
get/organization/{organizationId}/reminder-messages/available-translations
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organization/{organizationId}/reminder-messages/available-translations' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Finds reminder messages by reminder message id

Find reminder messages by a given reminder Id

Request
Security:
bearer
path Parameters
reminderMessageId
required
string

Reminder message id

Example: e9b3c509-41f8-4812-b60c-505a36ee87af
Responses
200
get/reminder-messages/{reminderMessageId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/reminder-messages/{reminderMessageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "organizationId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "vitalSignId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "messageType": {
    },
  • "localeKey": "en-US",
  • "message": "It is time to take your medicine",
  • "auditInfo": {
    }
}

Updates a reminder message

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
reminderMessageId
required
string

Reminder message id

Example: e9b3c509-41f8-4812-b60c-505a36ee87af
Request Body schema: application/json
vitalSignId
string

Vital sign id

messageTypeId
string

Message type

message
string

Message

localeKey
string

Locale

Responses
200
patch/reminder-messages/{reminderMessageId}
Request samples
application/json
{
  • "vitalSignId": "96321a9c-dade-4fd4-a8b2-d3e99da50b40",
  • "messageTypeId": "reminder",
  • "message": "It is time to take your medicine",
  • "localeKey": "en-US"
}
Response samples
application/json
{
  • "result": true
}

Deletes a reminder message

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
reminderMessageId
required
string

Reminder message id

Example: e9b3c509-41f8-4812-b60c-505a36ee87af
Responses
200
delete/reminder-messages/{reminderMessageId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/reminder-messages/{reminderMessageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Finds reminder messages by reminder message id for an organization

Permissions - organizationRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
reminderMessageId
required
string

Reminder message id

Example: e9b3c509-41f8-4812-b60c-505a36ee87af
Responses
200
get/organization/{organizationId}/reminder-messages/{reminderMessageId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organization/{organizationId}/reminder-messages/{reminderMessageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "organizationId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "vitalSignId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "messageType": {
    },
  • "localeKey": "en-US",
  • "message": "It is time to take your medicine",
  • "auditInfo": {
    }
}

Updates a reminder message for an organization

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
reminderMessageId
required
string

Reminder message id

Example: e9b3c509-41f8-4812-b60c-505a36ee87af
Request Body schema: application/json
vitalSignId
string

Vital sign id

messageTypeId
string

Message type

message
string

Message

localeKey
string

Locale

Responses
200
patch/organization/{organizationId}/reminder-messages/{reminderMessageId}
Request samples
application/json
{
  • "vitalSignId": "96321a9c-dade-4fd4-a8b2-d3e99da50b40",
  • "messageTypeId": "reminder",
  • "message": "It is time to take your medicine",
  • "localeKey": "en-US"
}
Response samples
application/json
{
  • "result": true
}

Deletes a reminder message for an organization

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
reminderMessageId
required
string

Reminder message id

Example: e9b3c509-41f8-4812-b60c-505a36ee87af
Responses
200
delete/organization/{organizationId}/reminder-messages/{reminderMessageId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/organization/{organizationId}/reminder-messages/{reminderMessageId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Reminder Rules

Creates a schedule for a subscriber or creates a preset schedule

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber id

Example: fe508355-3b1b-4e83-84b4-2fdc4abaca8c
Request Body schema: application/json

In the preceding JSON:

  1. If a presetId is provided, you cannot save a schedule.
  2. messageId and vitalSignIds can only be used with reminder type for vitals.
  3. customMessageId can only exist if messageId is undefined.
  4. If you are saving a preset, you must include organization
object

Reminder rule schedule object

startDate
required
string <date-time>

Start date

endDate
string <date-time>

End date

presetId
string

Preset id

messageId
string

Message id

reminderTypeId
required
string

Reminder type id

locale
string

Locale

customReminderMessage
string

Custom reminder message

object

Audio object

savePreset
required
boolean

Set true to save as a preset

object

Schedule preset object

organizationId
string

Organization id

description
string

Description

vitalSignIds
Array of strings

Array of vital sign ids

Responses
201
post/subscribers/{subscriberId}/vital-reminders
Request samples
application/json
{
  • "schedule": {
    },
  • "startDate": "2020-12-14",
  • "endDate": "2021-12-14",
  • "presetId": "fab5ea70-dd02-41a4-b36a-235f6576b793",
  • "messageId": "fab5ea70-dd02-41a4-b36a-235f6576b793",
  • "reminderTypeId": "fab5ea70-dd02-41a4-b36a-235f6576b793",
  • "locale": "en-US",
  • "customReminderMessage": "this is a custom reminder message",
  • "audio": {},
  • "savePreset": true,
  • "preset": {
    },
  • "organizationId": "fab5ea70-dd02-41a4-b36a-235f6576b793",
  • "description": "Morning Blood Pressure Reminder",
  • "vitalSignIds": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Finds all the reminders for the specified subscriber

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber id

Example: fe508355-3b1b-4e83-84b4-2fdc4abaca8c
query Parameters
include
string

For query include=syncs, it returns schedule sync status if it exists

Example: include=syncs
Responses
200
get/subscribers/{subscriberId}/vital-reminders
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-reminders?include=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Finds and return reminder schedule. If preset is selected, preset info is returned

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
reminderId
required
string

Reminder rule schedule id

Example: 93c5b2f1-f4fa-470f-8c29-4ad0cd576e1d
Responses
200
get/vital-reminders/{reminderId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/vital-reminders/{reminderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "49da07ab-403d-430e-8159-d2b0e695827f",
  • "subscriberId": "49da07ab-403d-430e-8159-d2b0e695827f",
  • "reminderTypeId": "5cce2fee-3a6a-408b-9c7c-6996ca0d444c",
  • "locale": "en-US",
  • "message": {
    },
  • "preset": {
    },
  • "customReminderMessage": "This is a custom message",
  • "audio": {},
  • "description": "This is a description",
  • "schedule": {
    },
  • "vitalSignIds": [
    ],
  • "syncs": [
    ],
  • "eventId": "string"
}

Deletes a reminder schedule

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
reminderId
required
string

Reminder rule schedule id

Example: 93c5b2f1-f4fa-470f-8c29-4ad0cd576e1d
Responses
200
delete/vital-reminders/{reminderId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/vital-reminders/{reminderId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Gets a reminder schedule by event id

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber id

Example: fe508355-3b1b-4e83-84b4-2fdc4abaca8c
eventId
required
string

Event id

Example: 6309534af96f9726594abe8d
Responses
200
get/subscribers/{subscriberId}/vital-reminders/event/{eventId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-reminders/event/{eventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "49da07ab-403d-430e-8159-d2b0e695827f",
  • "subscriberId": "49da07ab-403d-430e-8159-d2b0e695827f",
  • "reminderTypeId": "5cce2fee-3a6a-408b-9c7c-6996ca0d444c",
  • "locale": "en-US",
  • "message": {
    },
  • "preset": {
    },
  • "customReminderMessage": "This is a custom message",
  • "audio": {},
  • "description": "This is a description",
  • "schedule": {
    },
  • "vitalSignIds": [
    ],
  • "syncs": [
    ],
  • "eventId": "string"
}

Updates reminder rule schedule with reminder id.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber id

Example: fe508355-3b1b-4e83-84b4-2fdc4abaca8c
reminderId
required
string

Reminder rule schedule id

Example: 93c5b2f1-f4fa-470f-8c29-4ad0cd576e1d
Request Body schema: application/json

In the preceding JSON:

  1. If a presetId is provided, you cannot save a schedule.
  2. messageId and vitalSignIds can only be used with reminder type for vitals.
  3. customMessageId can only exist if messageId is undefined.
  4. If you are saving a preset, you must include organization
object

Schedule

reminderTypeId
string

Reminder type id

locale
string

Locale

presetId
string

Preset id

customReminderMessage
string

Custom reminder message

object

Audio object

messageId
string

Message id

description
string

Reminder schedule description

startDate
string <date-time>

Start date

endDate
string <date-time>

End date

vitalSignIds
Array of strings

Array of vital sign ids

eventId
string

The event id links a reminder schedule to every acknowledgement received from the device

Responses
200
patch/subscribers/{subscriberId}/vital-reminders/{reminderId}
Request samples
application/json
{
  • "schedule": {
    },
  • "reminderTypeId": "vitals-reminder",
  • "locale": "en-US",
  • "presetId": "fc2de2db-e24e-4448-a709-37be9f07fb9b",
  • "customReminderMessage": "This is a custom reminder message",
  • "audio": {},
  • "messageId": "9fa8f6c6-799d-4acd-bd02-6210a15e6577",
  • "description": "This is a reminder shcedule",
  • "startDate": "2020-12-14",
  • "endDate": "2021-12-14",
  • "vitalSignIds": [
    ],
  • "eventId": "string"
}
Response samples
application/json
{
  • "result": true
}

Archives a reminder schedule

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
reminderScheduleId
required
string

Reminder scheudle id

Example: de7b88f0-986f-421c-90f3-b2a5be9ef5ff
Responses
200
201
post/vital-reminders/{reminderScheduleId}/archive
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-reminders/{reminderScheduleId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Restores a reminder schedule

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
reminderScheduleId
required
string

Reminder scheudle id

Example: de7b88f0-986f-421c-90f3-b2a5be9ef5ff
Responses
200
201
post/vital-reminders/{reminderScheduleId}/restore
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-reminders/{reminderScheduleId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Activates a reminder schedule

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
reminderScheduleId
required
string

Reminder scheudle id

Example: de7b88f0-986f-421c-90f3-b2a5be9ef5ff
Responses
200
201
post/vital-reminders/{reminderScheduleId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-reminders/{reminderScheduleId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates a reminder schedule

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
reminderScheduleId
required
string

Reminder scheudle id

Example: de7b88f0-986f-421c-90f3-b2a5be9ef5ff
Responses
200
201
post/vital-reminders/{reminderScheduleId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-reminders/{reminderScheduleId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Reminder Preset

Creates preset reminder rule schedule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
Request Body schema: application/json
required
object

Reminder preset schedule

name
required
string

Reminder preset name

description
string

Reminder preset description

Responses
200
201
post/organizations/{organizationId}/reminder-presets
Request samples
application/json
{
  • "schedule": {
    },
  • "name": "Preset Name",
  • "description": "Preset Description"
}
Response samples
application/json
{
  • "result": true
}

Retrieve all preset reminder rules for an organization

Permissions - organizationRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 39d03a2a-0ce0-4bdf-9581-87b4e77ec836
Responses
200
get/organizations/{organizationId}/reminder-presets
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/reminder-presets' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Updates preset reminder rule schedule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 49da07ab-403d-430e-8159-d2b0e695827f
presetId
required
string

Preset reminder rule id'

Example: 7b837751-2499-4cce-b21b-48de8dc1ffef
Request Body schema: application/json
name
string

Reminder preset name

description
string

Description

object

Preset schedule object

Responses
200
patch/organizations/{organizationId}/reminder-presets/{presetId}
Request samples
application/json
{
  • "name": "Glucose Reminder",
  • "description": "Morning Reminder",
  • "schedule": {
    }
}
Response samples
application/json
{
  • "result": true
}

Deletes a reminder preset

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization id

Example: 49da07ab-403d-430e-8159-d2b0e695827f
presetId
required
string

Preset reminder rule id'

Example: 7b837751-2499-4cce-b21b-48de8dc1ffef
Responses
200
delete/organizations/{organizationId}/reminder-presets/{presetId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/organizations/{organizationId}/reminder-presets/{presetId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Reminder Types

Gets reminder types, if code is provided get by reminder type code

Request
Security:
bearer
query Parameters
code
string

Reminder type code

Enum: "vitals-reminder" "activity-reminder" "generic"
Responses
200
get/reminder-types
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/reminder-types?code=vitals-reminder' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets a reminder type by it's id

Request
Security:
bearer
path Parameters
reminderTypeId
required
string

Reminder type id

Example: 6eb6e4ca-04db-47ef-9bff-1f021a95f8af
Responses
200
get/reminder-types/{reminderTypeId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/reminder-types/{reminderTypeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "6eb6e4ca-04db-47ef-9bff-1f021a95f8af",
  • "title": "Vitals Reminder",
  • "code": "vitals-reminder",
  • "description": "Allows sending a reminder to take vitals."
}

Schedule Sync

Lists Schedule Sync status

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
reminderId
required
string
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
isSynced
boolean

Filter by synced or unsynced schedules

Example: isSynced=true
Responses
200
get/vital-reminders/{reminderId}/sync-status
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/vital-reminders/{reminderId}/sync-status?order_by=ASC&skip=0&take=25&isSynced=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Syncs a single schedule by reminderId and deviceId

Permissions - vitalAdmin

Request
Security:
bearer
path Parameters
reminderId
required
string
deviceId
required
string
Responses
200
post/vital-reminders/{reminderId}/device/{deviceId}/sync
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vital-reminders/{reminderId}/device/{deviceId}/sync' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "isSynced": true,
  • "lastSyncedAt": "2020-12-16T20:15:09.351Z",
  • "deviceId": "315ff1ec-5a1f-49f7-9c47-41ab4ee02493",
  • "deviceType": "ecg.addison.EXAMPLE.device",
  • "scheduleId": "41045351-fe5b-455a-bca8-0a055d6d7ff8",
  • "auditInfo": {
    }
}

Syncs multiple schedules by subscriberId

Permissions - vitalAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
post/subscribers/{subscriberId}/vital-reminders/sync-all
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vital-reminders/sync-all' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Locales

Retrieves preferred locales

Retrieve preferred locales

Responses
200
get/locales/preferred-locales
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/locales/preferred-locales
Response samples
application/json
null

Audit Trail

Finds audit trail records.

Find audit trail records

Request
Security:
bearer
query Parameters
take
number
Default: 25
skip
number
Default: 0
entity
string

Entity name in kabob case

Enum: "activity-alert" "alert" "alert-contact" "alert-delivery-activity" "disclaimer" "disclaimer-type" "observation-error" "phone-log" "raw-log" "reminder-message" "schedule" "schedule-preset" "vital-sign" "vital-sign-threshold" "vital-sign-assignment" "vital-reading" "alert-note" "subscriber-medication" "medication-activity" "medication-schedule"
action
string

Action filter

Enum: "CREATE" "UPDATE" "DELETE"
organizationId
string

Organization UUID

to
string
Example: to=2022-11-11T06:04:50.715Z
from
string
Example: from=2022-11-11T06:04:50.715Z
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
orderBy
string
Enum: "ASC" "DESC"
Responses
200
get/audit-trails
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/audit-trails?take=25&skip=0&entity=activity-alert&action=CREATE&organizationId=string&to=string&from=string&dateRangeType=custom&orderBy=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Person-Ref

get personRef for subscriberId

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string
Responses
200
get/person-ref/{subscriberId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/person-ref/{subscriberId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "f7352d3f-bb6b-40b4-8c55-62a179fb5045",
  • "organizationId": "f7352d3f-bb6b-40b4-8c55-62a179fb5045",
  • "firstName": "John",
  • "lastName": "Doe",
  • "salutation": "Mr",
  • "active": true,
  • "sub": "bec0c69b-8ed1-4970-950d-018bd85d31bc"
}

create personRef

Permissions - ecgApiKey

Request
Security:
bearer
Request Body schema: application/json
id
required
string
organizationId
string
firstName
required
string
lastName
required
string
salutation
string
active
required
boolean
sub
string
Responses
201
post/person-ref
Request samples
application/json
{
  • "id": "fbad63cb-2a05-4904-b5e1-9e1eb02fbd53",
  • "organizationId": "fbad63cb-2a05-4904-b5e1-9e1eb02fbd53",
  • "firstName": "John",
  • "lastName": "Doe",
  • "salutation": "Mr",
  • "active": true,
  • "sub": "bec0c69b-8ed1-4970-950d-018bd85d31bc"
}
Response samples
application/json
{
  • "id": "f7352d3f-bb6b-40b4-8c55-62a179fb5045",
  • "organizationId": "f7352d3f-bb6b-40b4-8c55-62a179fb5045",
  • "firstName": "John",
  • "lastName": "Doe",
  • "salutation": "Mr",
  • "active": true,
  • "sub": "bec0c69b-8ed1-4970-950d-018bd85d31bc"
}

delete personRef

Permissions - ecgApiKey

Request
Security:
bearer
path Parameters
personId
required
string
Responses
200
201
delete/person-ref/{personId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/person-ref/{personId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "f7352d3f-bb6b-40b4-8c55-62a179fb5045",
  • "organizationId": "f7352d3f-bb6b-40b4-8c55-62a179fb5045",
  • "firstName": "John",
  • "lastName": "Doe",
  • "salutation": "Mr",
  • "active": true,
  • "sub": "bec0c69b-8ed1-4970-950d-018bd85d31bc"
}

Disclaimers

creates a disclaimer

Permissions - setupDataAdmin

Request
Security:
bearer
Request Body schema: application/json
locale
required
string
disclaimerType
required
string
disclaimer
required
string
required
Array of objects (DisclaimerTranslationDto)
Responses
201
post/disclaimers
Request samples
application/json
{
  • "locale": "en-US",
  • "disclaimerType": "a6579733-ff9f-4b36-9b93-98a99260cde7",
  • "disclaimer": "hello",
  • "translations": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Finds all disclaimers by type

Permissions - ecgApiKey

Request
Security:
bearer
query Parameters
include
string

Disclaimer include translations

Example: include=translations
locale
string

Locale filter

Example: locale=en-US
type
string

Disclaimer type id

Example: type=5bd8f303-f6bd-4d59-b7da-98fd3e5f64fd
Responses
200
get/disclaimers
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/disclaimers?include=string&locale=string&type=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Finds a disclaimer by id

Find a given disclaimer

Request
Security:
bearer
path Parameters
disclaimerId
required
string

Disclaimer UUID

Responses
200
get/disclaimers/{disclaimerId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/disclaimers/{disclaimerId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "c1987379-44d3-4038-9499-ebdcbdd1dcb0",
  • "locale": "en-US",
  • "disclaimerType": "Threshold Settings Disclaimer",
  • "disclaimer": "threshold-settings",
  • "translations": [
    ],
  • "createdAt": "2020-12-16T20:15:09.351Z",
  • "createdBy": "c1987379-44d3-4038-9499-ebdcbdd1dcb0"
}

Updates a disclaimer

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerId
required
string

Disclaimer UUID

Request Body schema: application/json
disclaimerText
required
string
locale
required
string
disclaimerType
required
string
parentDisclaimerId
required
string
Array of objects (DisclaimerTranslationDto)
Responses
200
patch/disclaimers/{disclaimerId}
Request samples
application/json
{
  • "disclaimerText": "This is an example disclaimer.",
  • "locale": "en-US",
  • "disclaimerType": "a5f397e6-1b54-424b-b55b-5c308ae3ba7e",
  • "parentDisclaimerId": "9bea34e7-055e-4e22-ad70-e9cacb0c5223",
  • "translations": [
    ]
}
Response samples
application/json
{
  • "result": true
}

Deletes a disclaimer

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerId
required
string

Disclaimer UUID

Responses
200
delete/disclaimers/{disclaimerId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/disclaimers/{disclaimerId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Activates a disclaimer

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerId
required
string

Disclaimer UUID

Responses
200
201
post/disclaimers/{disclaimerId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/disclaimers/{disclaimerId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates a disclaimer

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerId
required
string

Disclaimer UUID

Responses
200
201
post/disclaimers/{disclaimerId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/disclaimers/{disclaimerId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Disclaimer Types

Creates a disclaimer type

Permissions - setupDataAdmin

Request
Security:
bearer
Request Body schema: application/json
name
required
string
code
required
string
Responses
201
post/disclaimer-types
Request samples
application/json
{
  • "name": "Threshold Settings Disclaimer",
  • "code": "threshold-settings"
}
Response samples
application/json
{
  • "name": "Threshold Settings Disclaimer",
  • "code": "threshold-settings"
}

Finds all disclaimer-types by name or code

Permissions - setupDataAdmin, ecgApiKey

Request
Security:
bearer
query Parameters
name
string

Name filter

Example: name=Org Reminder Message Settings
code
string

Code filter

Example: code=Vitalsorg-reminder-messages-updates
Responses
200
get/disclaimer-types
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/disclaimer-types?name=string&code=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Finds a disclaimer-type by id

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerType
required
string

Disclaimer type UUID

Responses
200
get/disclaimer-types/{disclaimerType}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/disclaimer-types/{disclaimerType}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "5f58ad8a-dbb5-4607-93cf-96e8c7f490d9",
  • "name": "Threshold Settings Disclaimer",
  • "code": "threshold-settings"
}

Updates a disclaimer-type

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerType
required
string

Disclaimer type UUID

Request Body schema: application/json
name
required
string
code
required
string
Responses
200
patch/disclaimer-types/{disclaimerType}
Request samples
application/json
{
  • "name": "Threshold Settings Disclaimer",
  • "code": "threshold-settings"
}
Response samples
application/json
{
  • "result": true
}

Deletes a disclaimer type

Permissions - setupDataAdmin

Request
Security:
bearer
path Parameters
disclaimerType
required
string

Disclaimer type UUID

Responses
200
delete/disclaimer-types/{disclaimerType}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/disclaimer-types/{disclaimerType}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Organization Onboarding

Checks onboarding status of an organization

Checks the onboarding status of a given organization

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Responses
200
get/organizations/{organizationId}/on-boarding
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/on-boarding' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "vitalSignAssignments": {
    },
  • "vitalThresholds": {
    },
  • "reminderMessages": {
    },
  • "alertDeliveryRules": {
    }
}

overwrites onboarding status of an organization

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Example: 69b497e3-ba6a-4a36-bd31-21800d385693
Request Body schema: application/json
step
required
string
Enum: "vitalSignAssignments" "vitalThresholds" "alertDeliveryRules" "reminderMessages"
Responses
201
post/organizations/{organizationId}/on-boarding/complete
Request samples
application/json
{
  • "step": "vitalSignAssignments"
}
Response samples
application/json
{
  • "result": true
}

Manual Observations

Creates a manual observation and returns the execution id to check status of observation creation workflow.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
required
Array of objects (ObservationsDto)
timestamp
required
string <date-time>

The timestamp in which this observation was taken

generateAudioResponse
boolean

Wether audio and speech marks should be created for this observation. If true URLs for the resources will be returned

performThresholdDetection
boolean

Wether a preliminary threshold check should be done before saving the observation to the system. If true, a threshold node will be returned along side the vital reading.

Responses
202
post/subscribers/{subscriberId}/vitals-observations
Request samples
application/json
{
  • "observations": [
    ],
  • "timestamp": "2019-08-24T14:15:22Z",
  • "generateAudioResponse": true,
  • "performThresholdDetection": true
}
Response samples
application/json
{
  • "executionId": "1accecab-5da6-48bf-982d-4f71ca10d8c4",
  • "media": {
    },
  • "items": [
    ],
  • "totalRecords": 0
}

Gets the status of a vital reading by its processing id

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
executionId
required
string

Id of a vital observation process

Responses
200
get/manual-observations/executions/{executionId}/status
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/manual-observations/executions/{executionId}/status' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "status": "SUCCEEDED",
  • "vitalReadingIds": [
    ],
  • "errors": [
    ]
}

Subscriber Observations

Fetches Subscriber Vital readings

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
vitalSignId
string
Example: vitalSignId=88e38dd0-3670-4f89-92a9-8f636f795e4b
organizationId
string
Example: organizationId=5ceced6e-70b5-41f0-9592-6da5922e347d
thresholdSeverity
number
Example: thresholdSeverity=1
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
to
string
Example: to=2022-09-23T20:00:28.775Z
from
string
Example: from=2021-09-23T20:00:28.775Z
Responses
200
get/subscribers/{subscriberId}/vitals-observations
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vitals-observations?order_by=ASC&skip=0&take=25&vitalSignId=string&organizationId=string&thresholdSeverity=0&dateRangeType=custom&to=string&from=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "subscriber": {
    },
  • "observations": {
    }
}

Observation Errors

Creates an observation error

Permissions - vitalSettingAdmin, ecgApiKey

Request
Security:
bearer
Request Body schema: application/json
rawLogId
required
string
errorCode
string
errorMessage
string
stackTrace
string
Responses
201
post/observation-errors
Request samples
application/json
{
  • "rawLogId": "0305b470-aa4f-4661-8180-c58fa6a2c6a1",
  • "errorCode": "string",
  • "errorMessage": "string",
  • "stackTrace": "string"
}
Response samples
application/json
{
  • "result": true
}

Observation Report/Statistics

Total Observations for a specific time-frame

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.606Z
to
string
Example: to=2022-11-11T06:04:50.606Z
observationType
required
string
Enum: "vital-reading" "phone-log"
subscriberId
string

Subscriber UUID

organizationId
string

Organization UUID

Responses
200
get/insights/vital-observations/statistics
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vital-observations/statistics?dateRangeType=custom&from=string&to=string&observationType=vital-reading&subscriberId=string&organizationId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "fromDate": "2022-11-11T06:04:50.613Z",
  • "toDate": "2022-11-11T06:04:50.613Z",
  • "data": {
    }
}

Observation report for a specific time-frame

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.606Z
to
string
Example: to=2022-11-11T06:04:50.606Z
vitalSignId
required
string

Vital sign UUID

subscriberId
string

Subscriber UUID

organizationId
string

Organization UUID

Responses
200
get/insights/vital-observations/statistics/chart
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vital-observations/statistics/chart?dateRangeType=custom&from=string&to=string&vitalSignId=string&subscriberId=string&organizationId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "title": "string",
  • "XAxis": {
    },
  • "YAxis": {
    },
  • "metadata": {
    },
  • "SeriesData": [
    ],
  • "summary": "string",
  • "dateRange": {
    }
}

Vital Readings

update the reading with the audio transcriptions.

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string
vitalReadingId
required
string
Request Body schema: application/json
audioURL
required
string
ssmlURL
required
string
locale
required
string
Responses
201
post/subscribers/{subscriberId}/vital-readings/{vitalReadingId}/audio-transcriptions
Request samples
application/json
{
  • "audioURL": "audio.url",
  • "ssmlURL": "ssml.url",
  • "locale": "en-US"
}
Response samples
application/json
{
  • "metadata": {
    },
  • "id": "d5a5e2f0-300c-4820-a1b6-32c6d20a6a9e",
  • "rawRecordId": "58b652af-22d7-4cb7-aa16-24858b56694a",
  • "organizationId": "bbfdd353-2770-411c-9c2e-00529014fd5b",
  • "subscriberId": "927defd9-7666-455f-a5dc-b77746148ab1",
  • "vitalSign": "cd0fb3a1-484d-47c2-9522-aabcf35d648a",
  • "delta": 4,
  • "normalHigh": 99,
  • "normalLow": 95,
  • "thresholdSeverity": 1,
  • "thresholdDirection": "high",
  • "thresholdLimit": 100,
  • "unit": "bpm",
  • "reading": 100,
  • "recordedAt": "2022-08-22T19:16:40.869Z",
  • "media": {
    }
}

Creates a vital reading

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
Request Body schema: application/json
thresholdSeverity
string
Enum: 1 2 3 "null"
thresholdDirection
string
Enum: "high" "low" "null"
rawRecordId
string
organizationId
string
subscriberId
string
vitalSign
required
string
delta
required
number
normalHigh
number
normalLow
number
thresholdLimit
number
reading
required
number
unit
string
recordedAt
required
string
Responses
201
post/subscribers/{subscriberId}/vital-readings
Request samples
application/json
{
  • "thresholdSeverity": 1,
  • "thresholdDirection": "high",
  • "rawRecordId": "dc9a92c1-d887-4c70-a7a3-3b7dfea73e99",
  • "organizationId": "dc9a92c1-d887-4c70-a7a3-3b7dfea73e99",
  • "subscriberId": "dc9a92c1-d887-4c70-a7a3-3b7dfea73e99",
  • "vitalSign": "dc9a92c1-d887-4c70-a7a3-3b7dfea73e99",
  • "delta": 5,
  • "normalHigh": 100,
  • "normalLow": 50,
  • "thresholdLimit": 105,
  • "reading": 75,
  • "unit": "bpm",
  • "recordedAt": "2022-08-05T19:20:02.879Z"
}
Response samples
application/json
{
  • "metadata": {
    },
  • "id": "d5a5e2f0-300c-4820-a1b6-32c6d20a6a9e",
  • "rawRecordId": "58b652af-22d7-4cb7-aa16-24858b56694a",
  • "organizationId": "bbfdd353-2770-411c-9c2e-00529014fd5b",
  • "subscriberId": "927defd9-7666-455f-a5dc-b77746148ab1",
  • "vitalSign": "cd0fb3a1-484d-47c2-9522-aabcf35d648a",
  • "delta": 4,
  • "normalHigh": 99,
  • "normalLow": 95,
  • "thresholdSeverity": 1,
  • "thresholdDirection": "high",
  • "thresholdLimit": 100,
  • "unit": "bpm",
  • "reading": 100,
  • "recordedAt": "2022-08-22T19:16:40.869Z",
  • "media": {
    }
}

Fetches Vital readings by organization id

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
organizationId
string
Example: organizationId=cfb1192f-7b44-4440-a814-f781d591a408
subscriberIds
Array of strings
Example: subscriberIds=['34f31895-d3bd-492f-ae5b-449c2e3fdb80']
vitalSignIds
Array of strings
Example: vitalSignIds=['46d5ac1d-e5a0-4c22-a0ee-270320086ebf']
readingLowerBound
string
Example: readingLowerBound=90
readingUpperBound
string
Example: readingUpperBound=110
unit
string
Example: unit=unit
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
Example: dateRangeType=custom
to
string
Example: to=2022-08-22T19:16:40.869Z
from
string
Example: from=2022-08-22T19:16:40.869Z
search
string
Example: search=string
format
string

For format = FHIR, will return vital reading in FHIR Format.

Value: "FHIR"
Example: format=FHIR
Responses
200
get/vital-readings
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/vital-readings?order_by=ASC&skip=0&take=25&organizationId=string&subscriberIds=string&vitalSignIds=string&readingLowerBound=string&readingUpperBound=string&unit=string&dateRangeType=custom&to=string&from=string&search=string&format=FHIR' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "items": [
    ],
  • "currentPageNumber": 0,
  • "recordsPerPage": 0,
  • "totalRecords": 0,
  • "totalPages": 0
}

Fetches Vital readings grouped

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
organizationId
string
Example: organizationId=cfb1192f-7b44-4440-a814-f781d591a408
subscriberIds
Array of strings
Example: subscriberIds=['34f31895-d3bd-492f-ae5b-449c2e3fdb80']
vitalSignIds
Array of strings
Example: vitalSignIds=['46d5ac1d-e5a0-4c22-a0ee-270320086ebf']
readingLowerBound
string
Example: readingLowerBound=90
readingUpperBound
string
Example: readingUpperBound=110
unit
string
Example: unit=unit
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
Example: dateRangeType=custom
to
string
Example: to=2022-08-22T19:16:40.869Z
from
string
Example: from=2022-08-22T19:16:40.869Z
search
string
Example: search=string
format
string

For format = FHIR, will return vital reading in FHIR Format.

Value: "FHIR"
Example: format=FHIR
Responses
200
get/vital-readings-grouped
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/vital-readings-grouped?order_by=ASC&skip=0&take=25&organizationId=string&subscriberIds=string&vitalSignIds=string&readingLowerBound=string&readingUpperBound=string&unit=string&dateRangeType=custom&to=string&from=string&search=string&format=FHIR' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "items": [
    ],
  • "currentPageNumber": 0,
  • "recordsPerPage": 0,
  • "totalRecords": 0,
  • "totalPages": 0
}

Observation Summary Report

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
query Parameters
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.606Z
to
string
Example: to=2022-11-11T06:04:50.606Z
vitalSignId
string

Vital sign UUID

Responses
200
get/subscribers/{subscriberId}/insights/vitals-reading-summary
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/insights/vitals-reading-summary?dateRangeType=custom&from=string&to=string&vitalSignId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "fromDate": "2022-11-11T06:04:50.614Z",
  • "toDate": "2022-11-11T06:04:50.614Z",
  • "observationCount": 0
}

Vitals Health Report

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
query Parameters
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.606Z
to
string
Example: to=2022-11-11T06:04:50.606Z
vitalSignId
string

Vital sign UUID

organizationId
string

Organization UUID

Responses
200
get/subscribers/{subscriberId}/vitals-health-report
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/vitals-health-report?dateRangeType=custom&from=string&to=string&vitalSignId=string&organizationId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "data": [
    ]
}

Alert Delivery Activities

creates a new alert delivery activity

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Example: be2118fa-5723-4b92-b85c-67474491e1f1
Request Body schema: application/json
lastDeliveredTime
required
string <date-time>

Last delivered time

deliverRuleId
required
string

Delivery rule id

alertCount
required
number

Alert count

alertIds
string

Alert ids

Responses
201
post/organizations/{organizationId}/alert-delivery-activity
Request samples
application/json
{
  • "lastDeliveredTime": "2020-12-16T20:15:09.351Z",
  • "deliverRuleId": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "alertCount": 1,
  • "alertIds": "https://aws.s3.com"
}
Response samples
application/json
{
  • "id": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "lastDeliveredTime": "2020-12-16T20:15:09.351Z",
  • "deliverRuleId": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "alertCount": 1,
  • "alertIds": "https://aws.s3.com",
  • "organizationId": "b6f842c2-8119-11eb-99b1-00155d6fd13d"
}

finds all alert delivery activities by organizationId

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Example: be2118fa-5723-4b92-b85c-67474491e1f1
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
Responses
200
get/organizations/{organizationId}/alert-delivery-activity
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-activity?order_by=ASC&skip=0&take=25' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

finds latest alert delivery activity by organizationId

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Example: be2118fa-5723-4b92-b85c-67474491e1f1
Responses
200
get/organizations/{organizationId}/alert-delivery-activity/latest
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-activity/latest' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "lastDeliveredTime": "2020-12-16T20:15:09.351Z",
  • "deliverRuleId": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "alertCount": 1,
  • "alertIds": "https://aws.s3.com",
  • "organizationId": "b6f842c2-8119-11eb-99b1-00155d6fd13d"
}

finds latest alert delivery activity by deliverRuleId

Permissions - subscriberPhiRead, ecgApiKey

Request
Security:
bearer
path Parameters
deliveryRuleId
required
string

Delivery rule UUID

Example: be2118fa-5723-4b92-b85c-67474491e1f1
Responses
200
get/deliver-rule/{deliveryRuleId}/alert-delivery-activity/latest
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/deliver-rule/{deliveryRuleId}/alert-delivery-activity/latest' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "lastDeliveredTime": "2020-12-16T20:15:09.351Z",
  • "deliverRuleId": "b6f842c2-8119-11eb-99b1-00155d6fd13d",
  • "alertCount": 1,
  • "alertIds": "https://aws.s3.com",
  • "organizationId": "b6f842c2-8119-11eb-99b1-00155d6fd13d"
}

Alert Delivery Rules

Creates a new alert delivery rule

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Request Body schema: application/json
name
required
string

Alert delivery rule name

description
required
string

Alert delivery rule description

required
object

Criteria object

required
object

Alert schedule

required
object

Alert delivery object

Responses
201
post/organizations/{organizationId}/alert-delivery-rules
Request samples
application/json
{
  • "name": "Severity 3 Alerts - every 10mins",
  • "description": "This allows us to get all Level 3 alerts, every 10mins",
  • "criteria": {
    },
  • "schedule": {
    },
  • "delivery": {
    }
}
Response samples
application/json
{
  • "id": "8700707e-3c35-4aef-997f-36345d2b3ae1",
  • "organizationId": "8700707e-3c35-4aef-997f-36345d2b3ae1",
  • "name": "Severity 3 Alerts - every 10mins",
  • "description": "This allows us to get all Level 3 alerts, every 10mins",
  • "criteria": {
    },
  • "schedule": {
    },
  • "delivery": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Fetches alert delivery rules for an organization

Permissions - organizationRead, ecgApiKey

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

query Parameters
skip
number
Default: 0
take
number
Default: 25
frequency
string

Filter by specific frequency

Enum: "weekly" "daily" "hourly" "minutely" "real-time"
alertCategory
string

Filter by alert category Id

Example: alertCategory=98023a52-d9c6-11eb-b8bc-0242ac130003
severity
number

Filter by severity

Example: severity=1 | 2 | 3
Responses
200
get/organizations/{organizationId}/alert-delivery-rules
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-rules?skip=0&take=25&frequency=weekly&alertCategory=string&severity=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Fetches an alert delivery rule for an organization by id

Permissions - organizationRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

alertDeliveryRuleId
required
string

Alert Delivery Rule UUID

Responses
200
get/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "8700707e-3c35-4aef-997f-36345d2b3ae1",
  • "organizationId": "8700707e-3c35-4aef-997f-36345d2b3ae1",
  • "name": "Severity 3 Alerts - every 10mins",
  • "description": "This allows us to get all Level 3 alerts, every 10mins",
  • "criteria": {
    },
  • "schedule": {
    },
  • "delivery": {
    },
  • "auditInfo": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Updates an alert delivery rule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

alertDeliveryRuleId
required
string

Alert Delivery Rule UUID

Request Body schema: application/json
Array
required
string or number or boolean or object or Array of strings
path
required
string
op
required
string
Enum: "add" "replace" "remove"
Responses
200
patch/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "result": true
}

Fetches all alert delivery rules

Permissions - organizationRead, ecgApiKey

Request
Security:
bearer
query Parameters
skip
number
Default: 0
take
number
Default: 25
frequency
string

Filter by specific frequency

Enum: "weekly" "daily" "hourly" "minutely" "real-time"
Responses
200
get/alert-delivery-rules
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/alert-delivery-rules?skip=0&take=25&frequency=weekly' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Archives an alert delivery rule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

alertDeliveryRuleId
required
string

Alert Delivery Rule UUID

Responses
200
201
post/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/archive
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Restores an alert delivery rule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

alertDeliveryRuleId
required
string

Alert Delivery Rule UUID

Responses
200
201
post/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/restore
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

activates an alert delivery rule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

alertDeliveryRuleId
required
string

Alert Delivery Rule UUID

Responses
200
201
post/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

deactivates an alert delivery rule.

Permissions - organizationAdmin

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

alertDeliveryRuleId
required
string

Alert Delivery Rule UUID

Responses
200
201
post/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/organizations/{organizationId}/alert-delivery-rules/{alertDeliveryRuleId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Alerts

Adds the Alert information.

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
Request Body schema: application/json
organizationId
string

Organization id

rawLogId
required
string

Raw log id

subscriberId
required
string

Subscriber id

categoryId
required
string

Category Id

object

Vital Rrading alert object

required
object

Misc Alert objcet

Responses
200
post/alerts
Request samples
application/json
{
  • "organizationId": "d3d303be-0bcb-49b9-aa44-43529321de76",
  • "rawLogId": "d3d303be-0bcb-49b9-aa44-43529321de76",
  • "subscriberId": "d3d303be-0bcb-49b9-aa44-43529321de76",
  • "categoryId": "d3d303be-0bcb-49b9-aa44-43529321de76",
  • "vitalReading": {
    },
  • "miscAlert": {
    }
}
Response samples
application/json
VitalReadingAlertDisplayModel
VitalReadingAlertDisplayModel
MiscAlertDisplayModel
{
  • "id": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "organizationId": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "subscriberId": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "alertCategory": {
    },
  • "addressed": false,
  • "addressedBy": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "addressedByPersonRef": {
    },
  • "addressedAt": "2022-06-01T16:30:28.964Z",
  • "auditInfo": {
    },
  • "vitalReading": {
    },
  • "alertMetadata": { }
}

Adds the Alert Addressed information.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
alertId
required
string
Responses
200
post/vitals-alerts/{alertId}/address
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/vitals-alerts/{alertId}/address' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "organizationId": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "subscriberId": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "alertCategory": {
    },
  • "addressed": false,
  • "addressedBy": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "addressedByPersonRef": {
    },
  • "addressedAt": "2022-06-01T16:30:28.964Z",
  • "auditInfo": {
    },
  • "vitalReading": {
    },
  • "alertMetadata": { }
}

Gets the Alert information.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
alertId
required
string
query Parameters
include
string

For include = true, will return observation information.

Value: "true"
Responses
200
get/insights/vitals-alerts/{alertId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vitals-alerts/{alertId}?include=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "organizationId": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "subscriberId": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "alertCategory": {
    },
  • "addressed": false,
  • "addressedBy": "75baa19d-f6d2-40c7-922c-b237c786ee24",
  • "addressedByPersonRef": {
    },
  • "addressedAt": "2022-06-01T16:30:28.964Z",
  • "auditInfo": {
    },
  • "vitalReading": {
    },
  • "alertMetadata": { }
}

Lists all the available alerts.

Permissions - subscriberPhiRead, ecgApiKey

Request
Security:
bearer
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
organizationId
string
subscriberIds
Array of strings
addressed
boolean
alertCategories
Array of strings
alertTypes
Array of strings
Items Enum: "misc-alert" "vital-reading-alert"
vitalSignIds
Array of strings
severities
Array of numbers
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
to
string
Example: to=2022-11-11T06:04:50.570Z
from
string
Example: from=2022-11-11T06:04:50.570Z
Responses
200
get/insights/vitals-alerts
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vitals-alerts?order_by=ASC&skip=0&take=25&organizationId=string&subscriberIds=string&addressed=true&alertCategories=string&alertTypes=misc-alert&vitalSignIds=string&severities=0&dateRangeType=custom&to=string&from=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Alert Reports

Total Alerts Grouped By Category for a specific time-frame

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
subscriberId
string
organizationId
string
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.573Z
to
string
Example: to=2022-11-11T06:04:50.573Z
alertCategoryCode
required
Array of strings
Responses
200
get/insights/vitals-metrics/alert-categories/statistics
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vitals-metrics/alert-categories/statistics?subscriberId=string&organizationId=string&dateRangeType=custom&from=string&to=string&alertCategoryCode=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "fromDate": "2022-06-01T16:30:28.964Z",
  • "toDate": "2022-06-01T16:30:28.964Z",
  • "alertData": [
    ]
}

Total Alert(addressed) Metrics for a specific time-frame

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
subscriberId
string
organizationId
string
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.573Z
to
string
Example: to=2022-11-11T06:04:50.573Z
Responses
200
get/insights/vitals-metrics/addressable-alerts-metrics
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vitals-metrics/addressable-alerts-metrics?subscriberId=string&organizationId=string&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "fromDate": "2022-11-11T06:04:50.705Z",
  • "toDate": "2022-11-11T06:04:50.705Z",
  • "alertData": {
    }
}

Charts for Subscriber Vital Readings over Time showing normal range and Reading as 3-series

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
organizationId
string
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.573Z
to
string
Example: to=2022-11-11T06:04:50.573Z
subscriberId
required
string
vitalSignId
required
string
Responses
200
get/insights/vitals-metrics/vital-readings/chart
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vitals-metrics/vital-readings/chart?organizationId=string&dateRangeType=custom&from=string&to=string&subscriberId=string&vitalSignId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "title": "string",
  • "XAxis": {
    },
  • "YAxis": {
    },
  • "metadata": {
    },
  • "SeriesData": [
    ],
  • "summary": "string",
  • "dateRange": {
    }
}

Total Alerts Grouped By Severity for a specific time-frame

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
subscriberId
string
organizationId
string
vitalSignId
string
mode
required
string
Enum: "count" "chart"
severity
string
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.573Z
to
string
Example: to=2022-11-11T06:04:50.573Z
Responses
200
get/insights/vitals-metrics/vital-readings/statistics
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/insights/vitals-metrics/vital-readings/statistics?subscriberId=string&organizationId=string&vitalSignId=string&mode=count&severity=string&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
AlertMetricsDisplayModel
AlertMetricsDisplayModel
AlertReportDisplayModel
{
  • "fromDate": "2022-06-01T16:30:28.964Z",
  • "toDate": "2022-06-01T16:30:28.964Z",
  • "alertData": [
    ]
}

Top Subscribers By Alerts/Severity

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
severity
string
take
number
Example: take=5
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.573Z
to
string
Example: to=2022-11-11T06:04:50.573Z
Responses
200
get/organizations/{organizationId}/insights/subscriber-severity-report
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/insights/subscriber-severity-report?severity=string&take=0&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "criteria": {
    },
  • "subscribers": {
    }
}

Export-Reports

This API servers the purpose of generating CSV/PDF Reports based on the "mode" selected for Vital Alerts or Vital Observations.

Permissions - subscriberPhiRead

Request
Security:
bearer
query Parameters
organizationId
string
subscriberId
string
mode
required
string
Enum: "csv" "pdf"
reportType
required
string
Enum: "vitals-alert" "vitals-observation"
dateRangeType
required
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:51.572Z
to
string
Example: to=2022-11-11T06:04:51.572Z
Responses
200
get/api/insights/reporting
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/insights/reporting?organizationId=string&subscriberId=string&mode=csv&reportType=vitals-alert&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "url": "string"
}

Subscriber Devices

Creates a subscriber device

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
Request Body schema: application/json
subscriberId
required
string

Subscriber id

organizationId
required
string

Organization id

deviceId
required
string

device Id

deviceSerialNumber
required
string

Device serial number

deviceTypeId
string

Device type id

Responses
201
post/subscriber-devices
Request samples
application/json
{
  • "subscriberId": "0ce5c9c0-a894-4a57-90be-7811a33f9605",
  • "organizationId": "5b655ccd-57b3-40bd-bcb9-07f368364182",
  • "deviceId": "bb211d77-c52a-4986-9e4e-cad02c7c2a78",
  • "deviceSerialNumber": "AN[Z,S]1234",
  • "deviceTypeId": "30fa08aa-01d6-4403-b910-398441a7a12f"
}
Response samples
application/json
{
  • "id": "8ce869e0-0831-45ca-ab82-92876e98f43a",
  • "subscriberId": "fc3ed76f-efe4-4ef5-9ff9-5b2925065538",
  • "organizationId": "6da81d16-1707-4b0a-bdee-045df8e4e805",
  • "deviceId": "c4afe209-4334-483f-9314-79a78fe7efba",
  • "deviceSerialNumber": "AN*****",
  • "deviceTypeId": "3f48c73c-29c1-456e-80f2-05920568a001",
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Fetches Subscriber devices by organization

Permissions - organizationRead

Request
Security:
bearer
path Parameters
organizationId
required
string

Organization UUID

Example: 69b497e3-ba6a-4a36-bd31-21800d385693
query Parameters
take
required
number
Example: take=25
skip
number
orderBy
string
Enum: "ASC" "DESC"
Responses
200
get/organizations/{organizationId}/subscriber-devices
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/organizations/{organizationId}/subscriber-devices?take=0&skip=0&orderBy=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Fetches a devices by subscriber

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
query Parameters
take
required
number
Example: take=25
skip
number
orderBy
string
Enum: "ASC" "DESC"
Responses
200
get/subscribers/{subscriberId}/subscriber-devices
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/subscriber-devices?take=0&skip=0&orderBy=ASC' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Fetches a device by device serial number

Permissions - ecgApiKey

Request
Security:
bearer
path Parameters
deviceSerialNumber
required
string

Subscriber device serial number

Example: AN[Z,S]1234
Responses
200
get/subscriber-devices/{deviceSerialNumber}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscriber-devices/{deviceSerialNumber}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "8ce869e0-0831-45ca-ab82-92876e98f43a",
  • "subscriberId": "fc3ed76f-efe4-4ef5-9ff9-5b2925065538",
  • "organizationId": "6da81d16-1707-4b0a-bdee-045df8e4e805",
  • "deviceId": "c4afe209-4334-483f-9314-79a78fe7efba",
  • "deviceSerialNumber": "AN*****",
  • "deviceTypeId": "3f48c73c-29c1-456e-80f2-05920568a001",
  • "auditInfo": {
    },
  • "activeInfo": {
    }
}

Updates a subscriber device

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberDeviceId
required
string

Subscriber device id

Example: 1b86f961-7490-4072-90ec-912d0128595c
Request Body schema: application/json
deviceId
required
string

Device id

deviceSerialNumber
string

Device serial number

deviceTypeId
string

Device type id

Responses
200
patch/subscriber-devices/{subscriberDeviceId}
Request samples
application/json
{
  • "deviceId": "450fa29f-102a-4b3f-ad1f-032d2e2f08ad",
  • "deviceSerialNumber": "AN*****",
  • "deviceTypeId": "681c1f74-5982-45eb-ac20-a46a1bf771ba"
}
Response samples
application/json
{
  • "result": true
}

Deletes a subscriber device

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberDeviceId
required
string

Subscriber device id

Example: 1b86f961-7490-4072-90ec-912d0128595c
Responses
200
delete/subscriber-devices/{subscriberDeviceId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/subscriber-devices/{subscriberDeviceId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Activates a subscriber device

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberDeviceId
required
string

Subscriber device id

Example: 1b86f961-7490-4072-90ec-912d0128595c
Responses
200
201
post/subscriber-devices/{subscriberDeviceId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/subscriber-devices/{subscriberDeviceId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Deactivates a subscriber device

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberDeviceId
required
string

Subscriber device id

Example: 1b86f961-7490-4072-90ec-912d0128595c
Responses
200
201
post/subscriber-devices/{subscriberDeviceId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/subscriber-devices/{subscriberDeviceId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": true
}

Subscriber Onboarding

checks onboarding status of a subscriber

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
Responses
200
get/subscribers/{subscriberId}/on-boarding
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/subscribers/{subscriberId}/on-boarding' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "vitalSignAssignments": {
    },
  • "vitalThresholds": {
    },
  • "reminderSchedules": {
    }
}

overwrites onboarding status of a subscriber

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

Subscriber UUID

Example: be5e0244-638d-4956-a5b9-cee9c2e5fc9e
Request Body schema: application/json
step
required
string
Enum: "vitalSignAssignments" "reminderSchedules" "vitalThresholds"
Responses
201
post/subscribers/{subscriberId}/on-boarding/complete
Request samples
application/json
{
  • "step": "vitalSignAssignments"
}
Response samples
application/json
{
  • "result": true
}

Alert Categories

Adds the Alert Category.

Permissions - setupDataAdmin, ecgApiKey

Request
Security:
bearer
Request Body schema: application/json
name
required
string
code
required
string
description
string
rrmsCode
string
parentCategoryId
string
Responses
200
post/api/alert-categories
Request samples
application/json
{
  • "name": "category-name",
  • "code": "ALT_CAT_CODE",
  • "description": "description",
  • "rrmsCode": "rrms-code",
  • "parentCategoryId": "f2eafd04-2bd6-4f4a-b8c5-fb1111906015"
}
Response samples
application/json
{
  • "parentCategory": {
    },
  • "childCategories": {
    },
  • "id": "fbad63cb-2a05-4904-b5e1-9e1eb02fbd53",
  • "name": "name",
  • "code": "code",
  • "description": "description",
  • "rrmsCode": "rrmsCode",
  • "activeInfo": {
    }
}

Lists all Alert Categories

Permissions - setupDataRead, ecgApiKey

Request
Security:
bearer
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
include
string

For query include=parent, it returns parent alert category if it exists.

Enum: "parent" "children"
sort_by
string

Default value : name

Example: sort_by=name
code
string

Default value : code

Example: code=code
rrms_code
string

Default value : rrms_code

Example: rrms_code=rrms_code
Responses
200
get/api/alert-categories
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/alert-categories?order_by=ASC&skip=0&take=25&include=parent&sort_by=string&code=string&rrms_code=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Gets the Alert category by Id.

Permissions - setupDataRead, ecgApiKey

Request
Security:
bearer
path Parameters
alertCategoryId
required
string
query Parameters
include
string

For query include=parent, it returns parent alert category if it exists.

Enum: "parent" "children"
Responses
200
get/api/alert-categories/{alertCategoryId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/alert-categories/{alertCategoryId}?include=parent' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "parentCategory": {
    },
  • "childCategories": {
    },
  • "id": "fbad63cb-2a05-4904-b5e1-9e1eb02fbd53",
  • "name": "name",
  • "code": "code",
  • "description": "description",
  • "rrmsCode": "rrmsCode",
  • "activeInfo": {
    }
}

Patches the Alert Category information by updating the items they were provided.

Permissions - setupDataAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
alertCategoryId
required
string
Request Body schema: application/json
Array
required
string or number or boolean or object or Array of strings
path
required
string
op
required
string
Enum: "add" "replace" "remove"
Responses
200
patch/api/alert-categories/{alertCategoryId}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "parentCategory": {
    },
  • "childCategories": {
    },
  • "id": "fbad63cb-2a05-4904-b5e1-9e1eb02fbd53",
  • "name": "name",
  • "code": "code",
  • "description": "description",
  • "rrmsCode": "rrmsCode",
  • "activeInfo": {
    }
}

Activates the Alert Category information.

Permissions - setupDataRead, ecgApiKey

Request
Security:
bearer
path Parameters
alertCategoryId
required
string
Responses
200
post/api/alert-categories/{alertCategoryId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/alert-categories/{alertCategoryId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Deactivates the Alert Category information.

Permissions - setupDataAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
alertCategoryId
required
string
Responses
200
post/api/alert-categories/{alertCategoryId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/alert-categories/{alertCategoryId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "value": true
}

Alert Notes

Create an Alert Note

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
alertId
required
string
Request Body schema: application/json
note
required
string

Note

Responses
200
post/api/alerts/{alertId}/notes
Request samples
application/json
{
  • "note": "This is an alert note"
}
Response samples
application/json
{
  • "alert": {
    },
  • "id": "30eed248-3574-45b6-8271-c8b2a8360643",
  • "notes": "name",
  • "auditInfo": {
    }
}

List all Alert Notes

Permissions - subscriberPhiRead, ecgApiKey

Request
Security:
bearer
path Parameters
alertId
required
string
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
include
string

For query include=true it returns alert info

Value: "true"
sort_by
string

Default value: createdAt

Example: sort_by=createdAt
searchTerm
string

Search By: notes

Responses
200
get/api/alerts/{alertId}/notes
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/alerts/{alertId}/notes?order_by=ASC&skip=0&take=25&include=true&sort_by=string&searchTerm=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Deletes an Alert Note

Permissions - subscriberPhiAdmin, ecgApiKey

Request
Security:
bearer
path Parameters
alertId
required
string
noteId
required
string
Responses
200
delete/api/alerts/{alertId}/notes/{noteId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/api/alerts/{alertId}/notes/{noteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
true

Seed Data

List the Dosage Time Interval Types

Permissions - medicationRead

Request
Security:
bearer
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Responses
200
get/api/seed-data/dosage-time-interval-types
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/api/seed-data/dosage-time-interval-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

List the Medication Route Types

Permissions - medicationRead

Request
Security:
bearer
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Responses
200
get/api/seed-data/route-types
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/api/seed-data/route-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

List the Medication Action Types

Permissions - medicationRead

Request
Security:
bearer
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Responses
200
get/api/seed-data/action-types
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/api/seed-data/action-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

List the Medication Amount Types

Permissions - medicationRead

Request
Security:
bearer
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Responses
200
get/api/seed-data/amount-types
Request samples
curl -i -X GET \
  https://vitals.ecg-api.com/api/seed-data/amount-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Medications

Adds the Custom Medication Information within the system.

Permissions - medicationAdmin

Request
Security:
bearer
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
organizationId
required
string
genericName
required
string
brandName
required
string
dosageForm
string
Enum: "tsp" "tbsp" "mL" "oz" "cc" "patch" "suspension" "solution" "a-thin-layer" "a-generous-layer" "cream" "gel" "ring" "pill" "tablet" "capsule" "chewable-tablet" "unit" "spray" "puff" "drop" "suppository"
strength
string
brandNameBase
string
labelerName
string
ndcDrugCode
string
description
string
Responses
201
post/api/medications
Request samples
application/json
{
  • "organizationId": "0c154335-b9cd-4916-8320-5f40e0d85ab9",
  • "genericName": "ACETAMINOPHEN",
  • "brandName": "Tylenol Extra Strength Caplet",
  • "dosageForm": "tablet",
  • "strength": "500 mg/1",
  • "brandNameBase": "Tylenol Extra Strength",
  • "labelerName": "Jones Healthcare Group - Packaging Services, Inc",
  • "ndcDrugCode": "some.ndc.drug.code",
  • "description": "description for the medication"
}
Response samples
application/json
{
  • "id": "f6b5c8ff-0a97-45eb-b0f8-6688ad2bc640",
  • "organizationId": "1b73413a-450b-4d40-8017-3568b8da54d6",
  • "source": "NDC",
  • "description": "string",
  • "genericName": "string",
  • "labelerName": "string",
  • "brandName": "string",
  • "brandNameBase": "string",
  • "dosageForm": "string",
  • "strength": "string",
  • "ndcDrugCode": "string",
  • "audioURLs": {
    },
  • "auditInfo": {
    }
}

Lists all the available Medications information.

Permissions - medicationRead

Request
Security:
bearer
query Parameters
skip
number

Default Value: 0

take
number

Default Value: 10 and Max Value: 1000

order_by
string

Default Value: ASC

Enum: "ASC" "DESC"
Example: order_by=ASC
sort_by
string
Enum: "productNdc" "genericName" "labelerName" "brandName" "brandNameBase" "dosageForm"
searchTerm
string
Enum: "productNdc" "genericName" "labelerName" "brandName" "brandNameBase" "dosageForm"
searchTermValue
string
source
string
Enum: "NDC" "CUSTOM"
organizationId
string
Example: organizationId=ee2de59e-2bc2-4b6e-a418-b712a4ef9134
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/medications
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/medications?skip=0&take=0&order_by=ASC&sort_by=productNdc&searchTerm=productNdc&searchTermValue=string&source=NDC&organizationId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Gets Sentences for Medications.

Permissions - medicationRead

Request
Security:
bearer
query Parameters
amount
required
string
Example: amount=1
amountType
required
string
Enum: "tsp" "tbsp" "mL" "oz" "cc" "patch" "suspension" "solution" "a-thin-layer" "a-generous-layer" "cream" "gel" "ring" "pill" "tablet" "capsule" "chewable-tablet" "unit" "spray" "puff" "drop" "suppository"
Example: amountType=tablet
actionType
required
string
Enum: "take" "place" "chew" "inject" "inhale" "spray" "put" "apply" "insert"
Example: actionType=take
route
required
string
Enum: "by-mouth" "by-mouth-with-food" "by-mouth-on-an-empty-stomach" "on-your-skin" "under-your-tongue" "between-the-gums-and-teeth" "under-the-skin" "intravenously" "intramuscularly" "intrathecally" "by-nose" "into-the-nose" "in-your-ear" "to-the-outer-ear" "in-your-eye" "in-your-eyes" "to-the-affected-area" "in-your-rectum" "in-your-vagina" "on-outer-vagina"
Example: route=by-mouth-with-food
medicationName
required
string
Example: medicationName=Tylenol
medicationFor
required
string
Example: medicationFor=Blood Pressure
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Responses
200
get/api/medications-sentences
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/medications-sentences?amount=string&amountType=tsp&actionType=take&route=by-mouth&medicationName=string&medicationFor=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "simpleDescription": "string",
  • "moderateDescription": "string",
  • "fullDescription": "string",
  • "choiceDescription": "string"
}

Gets Text to Speech in form of AudioStream for a given message.

Permissions - medicationRead

Request
Security:
bearer
query Parameters
message
required
string
Example: message=Hi! I will read any text you type here.
locale
string

Default Value: en-US.

Enum: "en-US" "en-IN" "es-MX" "tr-TR" "ru-RU" "ro-RO" "pt-PT" "pl-PL" "nl-NL" "it-IT" "is-IS" "fr-FR" "es-ES" "de-DE" "ko-KR" "en-GB-WLS" "hi-IN" "arb" "cy-GB" "cmn-CN" "da-DK" "en-AU" "pt-BR" "nb-NO" "sv-SE" "ja-JP" "es-US" "fr-CA" "en-GB"
Example: locale=en-US
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/speech
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/speech?message=string&locale=en-US' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "type": "Buffer",
  • "data": [
    ]
}

Gets the medications information based on query filters using NDC API.

Permissions - medicationRead

Request
Security:
bearer
query Parameters
skip
number

Default Value: 0

take
number

Default Value: 10 and Max Value: 1000

searchTerm
string
Enum: "product_ndc" "generic_name" "labeler_name" "brand_name" "brand_name_base" "product_type" "dosage_form"
Example: searchTerm=dosage_form
searchTermValue
string
Example: searchTermValue=LOTION
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/ndc-codes
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/ndc-codes?skip=0&take=0&searchTerm=product_ndc&searchTermValue=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Adds the medication information based on product-ndc using NDC API.

Permissions - medicationAdmin

Request
Security:
bearer
path Parameters
productNdc
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
description
string
Responses
201
post/api/ndc-codes/{productNdc}
Request samples
application/json
{
  • "description": "string"
}
Response samples
application/json
{
  • "id": "f6b5c8ff-0a97-45eb-b0f8-6688ad2bc640",
  • "organizationId": "1b73413a-450b-4d40-8017-3568b8da54d6",
  • "source": "NDC",
  • "description": "string",
  • "genericName": "string",
  • "labelerName": "string",
  • "brandName": "string",
  • "brandNameBase": "string",
  • "dosageForm": "string",
  • "strength": "string",
  • "ndcDrugCode": "string",
  • "audioURLs": {
    },
  • "auditInfo": {
    },
  • "productNdc": "string",
  • "route": [
    ],
  • "activeIngredients": [
    ],
  • "ndcPayload": { }
}

Gets the Medication information.

Permissions - medicationRead

Request
Security:
bearer
path Parameters
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/medications/{medicationId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/medications/{medicationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "id": "f6b5c8ff-0a97-45eb-b0f8-6688ad2bc640",
  • "organizationId": "1b73413a-450b-4d40-8017-3568b8da54d6",
  • "source": "NDC",
  • "description": "string",
  • "genericName": "string",
  • "labelerName": "string",
  • "brandName": "string",
  • "brandNameBase": "string",
  • "dosageForm": "string",
  • "strength": "string",
  • "ndcDrugCode": "string",
  • "audioURLs": {
    },
  • "auditInfo": {
    },
  • "productNdc": "string",
  • "route": [
    ],
  • "activeIngredients": [
    ],
  • "ndcPayload": { }
}

Updates the Medication information using NDC API.

Permissions - medicationAdmin

Request
Security:
bearer
path Parameters
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
description
string
Responses
200
patch/api/medications/{medicationId}
Request samples
application/json
{
  • "description": "string"
}
Response samples
application/json
{
  • "id": "f6b5c8ff-0a97-45eb-b0f8-6688ad2bc640",
  • "organizationId": "1b73413a-450b-4d40-8017-3568b8da54d6",
  • "source": "NDC",
  • "description": "string",
  • "genericName": "string",
  • "labelerName": "string",
  • "brandName": "string",
  • "brandNameBase": "string",
  • "dosageForm": "string",
  • "strength": "string",
  • "ndcDrugCode": "string",
  • "audioURLs": {
    },
  • "auditInfo": {
    },
  • "productNdc": "string",
  • "route": [
    ],
  • "activeIngredients": [
    ],
  • "ndcPayload": { }
}

Gets pre-signed polly file url for medication.

Permissions - medicationRead

Request
Security:
bearer
path Parameters
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/medications/{medicationId}/polly-url
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/medications/{medicationId}/polly-url' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "url": "string"
}

Subscriber Medications

Adds the Medication Information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
organizationId
string
medicationMasterId
required
string
medicationFor
required
string
effectiveFrom
required
string <date-time>
effectiveTo
string <date-time>
route
required
string
Enum: "by-mouth" "by-mouth-with-food" "by-mouth-on-an-empty-stomach" "on-your-skin" "under-your-tongue" "between-the-gums-and-teeth" "under-the-skin" "intravenously" "intramuscularly" "intrathecally" "by-nose" "into-the-nose" "in-your-ear" "to-the-outer-ear" "in-your-eye" "in-your-eyes" "to-the-affected-area" "in-your-rectum" "in-your-vagina" "on-outer-vagina"
actionType
required
string
Enum: "take" "place" "chew" "inject" "inhale" "spray" "put" "apply" "insert"
Responses
201
post/api/subscribers/{subscriberId}/medications
Request samples
application/json
{
  • "organizationId": "16eb6faa-a704-4130-8cc6-6cf3c122542d",
  • "medicationMasterId": "daf1b206-7ca4-4674-8f73-329103a28f46",
  • "medicationFor": "Blood Pressure",
  • "effectiveFrom": "2022-08-22T17:00:31.270Z",
  • "effectiveTo": "2022-08-22T17:00:31.270Z",
  • "route": "by-month",
  • "actionType": "take"
}
Response samples
application/json
{
  • "id": "dfd10d4e-3d43-45ee-bb8d-b888a877d205",
  • "subscriber": {
    },
  • "organizationId": "a32a7a5f-47db-4539-952e-bced14ccf416",
  • "medicationFor": "string",
  • "color": "string",
  • "route": "by-mouth",
  • "actionType": "take",
  • "effectiveFrom": "2022-11-11T06:04:51.064Z",
  • "effectiveTo": "2022-11-11T06:04:51.064Z",
  • "medicationMaster": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Lists all the available Medications information for a given Subscriber.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
include
Array of strings
Items Enum: "medicationMaster" "subscriber"
includeArchived
string
Enum: "true" "false"
includeActive
string
Enum: "true" "false"
dateRangeType
string

Returns records that lies between effectiveFrom and effectiveTo

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string

effectiveFrom

Example: from=2022-11-11T06:04:51.062Z
to
string

effectiveTo

Example: to=2022-11-11T06:04:51.062Z
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medications
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications?order_by=ASC&skip=0&take=25&include=medicationMaster&includeArchived=true&includeActive=true&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Gets the Medication information for a given Subscriber.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
query Parameters
include
Array of strings
Items Enum: "medicationMaster" "subscriber"
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medications/{medicationId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}?include=medicationMaster' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "id": "dfd10d4e-3d43-45ee-bb8d-b888a877d205",
  • "subscriber": {
    },
  • "organizationId": "a32a7a5f-47db-4539-952e-bced14ccf416",
  • "medicationFor": "string",
  • "color": "string",
  • "route": "by-mouth",
  • "actionType": "take",
  • "effectiveFrom": "2022-11-11T06:04:51.064Z",
  • "effectiveTo": "2022-11-11T06:04:51.064Z",
  • "medicationMaster": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Deletes the Medication information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
delete/api/subscribers/{subscriberId}/medications/{medicationId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Patches the Medications information for a given Subscriber by updating the items they were provided.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
Array of objects (JsonPatchDocumentDto)
Responses
200
patch/api/subscribers/{subscriberId}/medications/{medicationId}
Request samples
application/json
null
Response samples
application/json
{
  • "id": "dfd10d4e-3d43-45ee-bb8d-b888a877d205",
  • "subscriber": {
    },
  • "organizationId": "a32a7a5f-47db-4539-952e-bced14ccf416",
  • "medicationFor": "string",
  • "color": "string",
  • "route": "by-mouth",
  • "actionType": "take",
  • "effectiveFrom": "2022-11-11T06:04:51.064Z",
  • "effectiveTo": "2022-11-11T06:04:51.064Z",
  • "medicationMaster": {
    },
  • "activeInfo": {
    },
  • "archiveInfo": {
    }
}

Archives the Medication information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/archive
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Restores the Medication information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/restore
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Activates the Medication information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Deactivates the Medication information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Medication Activities

Adds the Activity Notes.

Add Activity Notes

Request
Security:
bearer
path Parameters
subscriberId
required
string
activityId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
note
required
string
Responses
200
post/api/subscribers/{subscriberId}/medication-activities/{activityId}/notes
Request samples
application/json
{
  • "note": "string"
}
Response samples
application/json
{
  • "id": "de2ee5d6-8305-44c2-b688-4f334fb06239",
  • "notes": "string",
  • "auditInfo": {
    },
  • "medicationActivity": {
    }
}

Deletes Activity Note

Delete a given Activity Note.

Request
Security:
bearer
path Parameters
subscriberId
required
string
activityId
required
string
noteId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
delete/api/subscribers/{subscriberId}/medication-activities/{activityId}/notes/{noteId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medication-activities/{activityId}/notes/{noteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Adds the Medication Activity Information for a given Subscriber.

Adds the medication-activity information for a given subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
required
Array of objects (MedicationActivityDto)
Responses
201
post/api/subscribers/{subscriberId}/medication-activities
Request samples
application/json
{
  • "activities": [
    ]
}
Response samples
application/json
null

Lists all the available Medication Activities information for a given Subscriber.

Lists the Medication Activities information for a given Subscriber Returns Paginated Response of MedicationActivityDisplayModel

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
status
string
Enum: "missed" "snooze" "taken" "skip" "already-taken"
dateRangeType
string

Based on alertSentAt

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:51.069Z
to
string
Example: to=2022-11-11T06:04:51.069Z
include
Array of strings
Items Enum: "MedicationSchedule" "activityNotes"
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medication-activities
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medication-activities?order_by=ASC&skip=0&take=25&status=missed&dateRangeType=custom&from=string&to=string&include=MedicationSchedule' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Gets the Medication Activity information for a given Subscriber.

Retrieves Medication Activity information for a given Subscriber

Request
Security:
bearer
path Parameters
subscriberId
required
string
activityId
required
string
query Parameters
include
Array of strings
Items Enum: "MedicationSchedule" "activityNotes"
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medication-activities/{activityId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medication-activities/{activityId}?include=MedicationSchedule' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "id": "4066b2c1-8100-4b66-a13b-64ef03faf4a4",
  • "subscriberId": "03646088-6ac0-46b4-87ff-2a55fd38cf11",
  • "status": "missed",
  • "alertSentAt": "2022-11-11T06:04:51.066Z",
  • "activityAt": "2022-11-11T06:04:51.066Z",
  • "media": [
    ],
  • "review": {
    },
  • "medicationSchedule": {
    },
  • "activityNotes": [
    ]
}

Updates the Medication Activity information for a given Subscriber.

Updates the Medication Activity information for a given Subscriber.

Request
Security:
bearer
path Parameters
subscriberId
required
string
activityId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
Array of objects (JsonPatchDocumentDto)
Responses
200
patch/api/subscribers/{subscriberId}/medication-activities/{activityId}
Request samples
application/json
null
Response samples
application/json
{
  • "id": "4066b2c1-8100-4b66-a13b-64ef03faf4a4",
  • "subscriberId": "03646088-6ac0-46b4-87ff-2a55fd38cf11",
  • "status": "missed",
  • "alertSentAt": "2022-11-11T06:04:51.066Z",
  • "activityAt": "2022-11-11T06:04:51.066Z",
  • "media": [
    ],
  • "review": {
    },
  • "medicationSchedule": {
    },
  • "activityNotes": [
    ]
}

Reviews the Medication Activity information for a given Subscriber.

Reviews the Medication Activity information for a given Subscriber.

Request
Security:
bearer
path Parameters
subscriberId
required
string
activityId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medication-activities/{activityId}/review
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medication-activities/{activityId}/review' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "id": "4066b2c1-8100-4b66-a13b-64ef03faf4a4",
  • "subscriberId": "03646088-6ac0-46b4-87ff-2a55fd38cf11",
  • "status": "missed",
  • "alertSentAt": "2022-11-11T06:04:51.066Z",
  • "activityAt": "2022-11-11T06:04:51.066Z",
  • "media": [
    ],
  • "review": {
    },
  • "medicationSchedule": {
    },
  • "activityNotes": [
    ]
}

Pre-signed url to Upload Video for the Medication Activity.

Pre-Signed URL to Upload Video for the Medication Activity.

Request
Security:
bearer
path Parameters
subscriberId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Request Body schema: application/json
activities
required
Array of strings
Responses
200
post/api/subscribers/{subscriberId}/medication-activities/videos
Request samples
application/json
{
  • "activities": [
    ]
}
Response samples
application/json
{
  • "value": "string"
}

Gets pre-signed Video url for the Medication Activity.

Gets pre-signed Video URL for the Medication Activity.

Request
Security:
bearer
path Parameters
subscriberId
required
string
activityId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medication-activities/{activityId}/videos
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medication-activities/{activityId}/videos' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": "string"
}

Counts all the available Medication Activities for a given organization based on status and date range.

counts the Medication Activities for a given organization based on status and date-time range

Request
Security:
bearer
path Parameters
organizationId
required
string
query Parameters
status
required
string
Enum: "missed" "snooze" "taken" "skip" "already-taken"
dateRangeType
string

Based on alertSentAt

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:51.082Z
to
string
Example: to=2022-11-11T06:04:51.082Z
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/organizations/{organizationId}/medication-activities/count
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/organizations/{organizationId}/medication-activities/count?status=missed&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "medicationActivityStatus": "missed",
  • "total": 1
}

Medication Schedules

Adds the subscriber medication schedule

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
medicationId
required
string
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Request Body schema: application/json
reminderTime
required
string
daysOfTheWeek
Array of strings
dosageTimeInterval
string
Enum: "evening" "once-a-day" "twice-a-day" "see-instructions" "at-bedtime" "before-bedtime" "before-each-meal"
amount
required
number
amountType
required
string
Enum: "tsp" "tbsp" "mL" "oz" "cc" "patch" "suspension" "solution" "a-thin-layer" "a-generous-layer" "cream" "gel" "ring" "pill" "tablet" "capsule" "chewable-tablet" "unit" "spray" "puff" "drop" "suppository"
simpleDescription
required
string
moderateDescription
required
string
fullDescription
required
string
choiceDescription
required
string
Responses
201
post/api/subscribers/{subscriberId}/medications/{medicationId}/schedules
Request samples
application/json
{
  • "reminderTime": "6:4",
  • "daysOfTheWeek": [
    ],
  • "dosageTimeInterval": "evening",
  • "amount": 1,
  • "amountType": "tablet",
  • "simpleDescription": "1 tablet of Metformin",
  • "moderateDescription": "Please take 1 tablet of Metformin",
  • "fullDescription": "Please take 1 tablet of Metformin by mouth with food for diabetes",
  • "choiceDescription": "Are you planning to take 1 tablet of Metformin by mouth with food for diabetes ?"
}
Response samples
application/json
{
  • "id": "05eb62e7-4cbf-45fc-8b12-fe3748459375",
  • "subscriberMedication": {
    },
  • "reminderTime": "6:4",
  • "daysOfTheWeek": [
    ],
  • "dosageTimeInterval": "once-a-day",
  • "reminderInfo": [
    ],
  • "amount": 1,
  • "amountType": "tablet",
  • "activeInfo": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "medicationActivities": [
    ]
}

Patches the Medications Schedule for given scheduleId by updating the items they were provided.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Request Body schema: application/json
Array of objects (JsonPatchDocumentDto)
Responses
200
patch/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}
Request samples
application/json
null
Response samples
application/json
{
  • "id": "05eb62e7-4cbf-45fc-8b12-fe3748459375",
  • "subscriberMedication": {
    },
  • "reminderTime": "6:4",
  • "daysOfTheWeek": [
    ],
  • "dosageTimeInterval": "once-a-day",
  • "reminderInfo": [
    ],
  • "amount": 1,
  • "amountType": "tablet",
  • "activeInfo": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "medicationActivities": [
    ]
}

Gets the Medication Schedule information for a given Subscriber.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

query Parameters
include
Array of strings
Items Enum: "subscriberMedication" "medicationActivity" "medicationMaster" "activityNotes"
status
string
Enum: "missed" "snooze" "taken" "skip" "already-taken"
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}?include=subscriberMedication&status=missed' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "id": "05eb62e7-4cbf-45fc-8b12-fe3748459375",
  • "subscriberMedication": {
    },
  • "reminderTime": "6:4",
  • "daysOfTheWeek": [
    ],
  • "dosageTimeInterval": "once-a-day",
  • "reminderInfo": [
    ],
  • "amount": 1,
  • "amountType": "tablet",
  • "activeInfo": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "medicationActivities": [
    ]
}

Deletes the Medication Schedule for a given Medication ScheduleId.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
delete/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}
Request samples
curl -i -X DELETE \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Activates the Medication Schedule information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/activate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/activate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Deactivates the Medication Schedule information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/deactivate
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/deactivate' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Archives the Medication Schedule information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/archive
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/archive' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Restores the Medication Schedule information for a given Subscriber.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/restore
Request samples
curl -i -X POST \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/restore' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "value": true
}

Gets pre-signed polly file url for medication schedule.

Permissions - medicationRead

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Responses
200
get/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/polly-url
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/polly-url' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
{
  • "locale": "en-US",
  • "simple": {
    },
  • "moderate": {
    },
  • "full": {
    },
  • "choice": {
    }
}

Lists all Medication Schedules for a given Subscriber.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
order_by
string
Default: "ASC"
Enum: "ASC" "DESC"
skip
number
Default: 0
take
number
Default: 25
include
Array of strings
Items Enum: "subscriberMedication" "medicationActivity" "medicationMaster" "activityNotes"
includeArchived
string
Enum: "true" "false"
includeActive
string
Enum: "true" "false"
status
string
Enum: "missed" "snooze" "taken" "skip" "already-taken"
date
string <date-time>

This field filters based on the subscriber medications "effective-from" date and "effective-to" date.

Example: date=2022-11-11T06:04:51.056Z
subscriberMedicationId
string
Example: subscriberMedicationId=1af9be1f-73b0-4b5a-beb3-3f3e5a47847f
dateRangeType
string

This field filters the Medication Activities information within the schedule based on the "activity-at" of the medication-activity.

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string

This field filters the Medication Activities information within the schedule based on the "activity-at" of the medication-activity.

Example: from=2022-11-11T06:04:51.056Z
to
string

This field filters the Medication Activities information within the schedule based on the "activity-at" of the medication-activity.

Example: to=2022-11-11T06:04:51.056Z
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/medication-schedules
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/medication-schedules?order_by=ASC&skip=0&take=25&include=subscriberMedication&includeArchived=true&includeActive=true&status=missed&date=2019-08-24T14%3A15%3A22Z&subscriberMedicationId=string&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Adds the translation for Medication Schedule based on locale.

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string

The Id of the Subscriber

medicationId
required
string

The Id of the Subscriber Medication

scheduleId
required
string

The Id of the Medication Schedule

header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE" "en-MX"
Request Body schema: application/json
simpleDescription
required
string
moderateDescription
required
string
fullDescription
required
string
choiceDescription
required
string
Responses
200
post/api/subscribers/{subscriberId}/medications/{medicationId}/schedules/{scheduleId}/translations
Request samples
application/json
{
  • "simpleDescription": "1 tablet of Metformin",
  • "moderateDescription": "Please take 1 tablet of Metformin",
  • "fullDescription": "Please take 1 tablet of Metformin by mouth with food for diabetes",
  • "choiceDescription": "Are you planning to take 1 tablet of Metformin by mouth with food for diabetes ?"
}
Response samples
application/json
{
  • "id": "05eb62e7-4cbf-45fc-8b12-fe3748459375",
  • "subscriberMedication": {
    },
  • "reminderTime": "6:4",
  • "daysOfTheWeek": [
    ],
  • "dosageTimeInterval": "once-a-day",
  • "reminderInfo": [
    ],
  • "amount": 1,
  • "amountType": "tablet",
  • "activeInfo": {
    },
  • "auditInfo": {
    },
  • "archiveInfo": {
    },
  • "medicationActivities": [
    ]
}

Addison Subscribers

Lists the Addison Timeline information for a given Subscriber.

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
status
string
Enum: "missed" "snooze" "taken" "skip" "already-taken"
dateRangeType
string

Based on activityAt of Medication Activity

Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
from
string
Example: from=2022-11-11T06:04:50.494Z
to
string
Example: to=2022-11-11T06:04:50.495Z
header Parameters
accept-language
required
string

Default Value: en-US.

Enum: "en-US" "de-DE"
Responses
200
get/api/subscribers/{subscriberId}/addison-timeline
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/subscribers/{subscriberId}/addison-timeline?status=missed&dateRangeType=custom&from=string&to=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'accept-language: en-US'
Response samples
application/json
null

Instant Messages

At the moment only the 'pro-health' messaging channel is available

Permissions - subscriberPhiAdmin

Request
Security:
bearer
path Parameters
subscriberId
required
string
Request Body schema: application/json
organizationId
string
required
Array of proHealthDeliveryChannel (object) or smsDeliveryChannel (object) or addisonDeliveryChannel (object)
locale
required
string
Enum: "en-US" "de-DE"
message
required
string
description
string
Responses
201
post/api/{subscriberId}/instant-messages
Request samples
application/json
{
  • "organizationId": "9e7535fb-c986-4660-a609-cdc1037aeb72",
  • "deliveryChannels": [
    ],
  • "locale": "en-US",
  • "message": "string",
  • "description": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "result": true,
  • "data": {
    }
}

Gets instant messages by subscriberId

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
subscriberId
required
string
query Parameters
dateRangeType
string
Enum: "custom" "this-year" "last-year" "today" "this-week" "last-week" "this-month" "last-month" "this-quarter" "last-quarter"
fromDate
string <date-time>
toDate
string <date-time>
searchTerm
string

Searches the messages sent

organizationId
string
channel
string
Enum: "pro-health" "sms" "addison"
skip
number >= 0
Default: 0

How many pages to skip; Defaults to 0

take
number >= 0
Default: 10

The number of items to return; Defaults to 10

Responses
200
get/api/{subscriberId}/instant-messages
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/{subscriberId}/instant-messages?dateRangeType=custom&fromDate=2019-08-24T14%3A15%3A22Z&toDate=2019-08-24T14%3A15%3A22Z&searchTerm=string&organizationId=string&channel=pro-health&skip=0&take=10' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
null

Get instant messages by event Id

Permissions - subscriberPhiRead

Request
Security:
bearer
path Parameters
eventId
required
string
Responses
200
get/api/instant-messages/events/{eventId}
Request samples
curl -i -X GET \
  'https://vitals.ecg-api.com/api/instant-messages/events/{eventId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "id": "string",
  • "data": {
    }
}