The purpose of this document is to provide reference information to assist software developers.

(1)

Vivify API

Webhooks

This document provides steps for using Vivify Health APIs with third party systems. For more information about using our services, contact us at [email protected].

Getting Started

The purpose of this document is to provide reference information to assist software developers.

You can use webhooks to be notified as data becomes available. A GET request is sent to the URL you provide whenever a certain event happens. The GET request will contain query string parameters defined below.

Event Description Query Parameters

Create Patient Notification when a patient ID is created.

PatientId

Pathway Complete Notification when a pathway is completed.

PatientId, PatientSurveyId, SurveyType, CompletedDate

Patient Added Notification when a patient is added to the Care Team Portal.

PatientAddedEvent

Patient Response Added

Notification when a patient pathway response is added.

PatientResponseAddedEvent

Patient Biometric Added

Notification when a patient’s biometric data is added.

PatientBiometricAddedEvent

For Reference ID Tables, see page 17.

(2)

Patient Added Event

This section includes an example for the webhook that subscribes to the PatientAddedEvent.

"IsPlatform": true,

"PatientId": 367,

"PatientMasterId": 356,

"LastName": "Smith",

"FirstName": "Mayra",

"Middle_Name": null,

"Gender": "Female",

"DOB": "1967-10-31T00:00:00Z",

"Address1": "123 Main",

"Address2": "",

"State": "TX",

"City": "Dallas",

"ZipCode": "75024",

"Email": "",

"Phone1": "12145551234",

"Phone2": "",

"TimeZoneId": 5,

"Race": "",

"Religion": "",

"EmpiIdent": "",

"AccountIdent": "",

"VisitIdent": "",

"PatientIdent": null,

"HL7DeptIdent": "",

"HL7Custom1": "",

"HL7Custom2": "",

"MRNIdent": "5551234",

"HospitalId": 1,

"HospitalName": "Vivify General",

"HospitalFacilityId": "VHG",

"HospitalSiteId": "ERI",

"Language": "English",

"PopulationGroup": "",

"ServiceLevelKitNum": "",

"CreatedDtUTC": "2018-12-06T21:04:59.047Z",

"LatestActivatedDate": null,

"ConsultNumber": null }

(3)

Patient Response Added Event

This section includes examples for the webhooks that subscribe to the PatientResponseAddedEvent.

In this section

• Blood Pressure

• Blood Sugar

• Multi Select

• Single Select

• Single Select Alert

• Steps

• Weight

• Yes No

• Yes No Alert

Blood Pressure

}{

"PatientResponse": {

"PatientResponseId": 5976,

"PatientId": 106,

"SurveyQuestionTypeId": 2,

"SurveyQuestionType": "BloodPressure",

"PatientResponseInputMethodId": 1,

"PatientResponseInputMethod": "Manual",

"ObservationDateTime_UTC": "2018-12-06T14:55:29.716Z",

"ObservationDate": "2018-12-06T06:00:00Z",

"CreatedDateTime_UTC": "2018-12-06T20:55:28.63Z",

"HighestAlertSeverityLevel": 3,

"PatientSurveyQuestionId": 20977,

"ParentPatientSurveyQuestionId": 0,

"PatientSurveyId": 1465,

"Survey": "Q1Wks on MW",

"IsBiometricsType": true,

"Question": "Prompt for Blood Pressure reading",

"PatientResponseValues": [{

"PatientResponseValueId": 8975,

"SurveyParameterTypeId": 1,

"SurveyParameterType": "Systolic",

"PatientSurveyOptionId": 0,

"SortOrder": 0,

"Value": "112",

"AlertSeverityLevelId": 3,

"AlertSeverityLevel": "None",

"SkipReason": null },

{

"SurveyParameterType": "Diastolic",

"SortOrder": 0,

"Value": "76",

(4)

"SkipReason": null }],

"PatientAlerts": []

} }

Blood Sugar

{

"PatientId": 106,

"SurveyQuestionType": "BloodSugar",

"Question": "Prompt for Glucometer reading",

"SurveyParameterType": "BloodSugar",

"SortOrder": 0,

"Value": "86",

{

"SurveyParameterType": "UnitType",

"SortOrder": 0,

"Value": "mg/dL",

"SkipReason": null

(5)

}, {

"SurveyParameterType": "ReadingType",

"SortOrder": 0,

"Value": "Random",

"PatientAlerts": []

} }

Multi Select

This example shows that the patient responded to a question during their pathway that allowed them to select several options (multi select). The question was "My chest pain was associated with the following symptoms." The patient responded "Radiates to the jaw, back and or down left arm" which produced a high-level alert.

{

"PatientId": 106,

"SurveyQuestionType": "MultiSelection",

"IsBiometricsType": false,

"Question": "My chest pain was associated with the following symptoms.",

"SurveyParameterType": "Survey",

"SortOrder": 0,

"Value": "Radiates to the jaw, back and or down left arm",

"AlertSeverityLevel": "High",

(6)

{

"SortOrder": 0,

"Value": "Broke out into a sweat",

"PatientAlerts": [{

"PatientToken": null,

"Url": null,

"IconUrl": "",

"PatientChartEntries": [],

"PatientAlertId": 43051,

"AlertTypeId": 12,

"AlertType": "Survey",

"PatientId": 106,

"AlertStatusId": 1,

"AlertStatus": "New",

"Message": "My chest pain was associated with the following symptoms. : Radiates to the jaw, back and or down left arm, Broke out into a sweat.",

"AlertStatusSetDateTime_UTC": null }]

} }

Single Select

This example shows that the patient responded to a question that had several options, and the patient had the option to choose only one (single select). The question was "What has your activity level been over the past 24 hours?" The patient's response was "I can do all usual activities" which produced no alerts.

{

"PatientId": 106,

"SurveyQuestionType": "SingleSelection",

(7)

"Survey": "Patient's Start Date - Date of the Month",

"Question": "What has your activity level been over the past 24 hours?",

"SortOrder": 0,

"Value": "I can do all usual activities",

"PatientAlerts": []

} }

Single Select Alert

This example shows that the patient responded to a question that had several options, and the patient had the option to choose only one (single select). The question was "How has your memory been in the last 2 weeks?" The patient's response was "worse than normal" which produced a high-level alert.

{

"PatientId": 106,

"SurveyQuestionType": "SingleSelection",

"Question": "How has your memory been in the last 2 weeks?",

"SortOrder": 0,

"Value": "Worse than normal",

(8)

"PatientAlerts": [{

"Url": null,

"IconUrl": "",

"AlertTypeId": 12,

"PatientId": 106,

"AlertStatusId": 1,

"Message": "How has your memory been in the last 2 weeks? : Worse than normal.",

} }

Steps

{

"PatientId": 106,

"SurveyQuestionType": "Steps",

"ObservationDateTime_UTC": "2018-12-06T04:59:00Z",

"Survey": "Patient Start Day- Day of the Month by weekday",

"Question": "Prompt for Pedometer reading",

"SurveyParameterType": "Steps",

"SortOrder": 0,

"Value": "45123",

(9)

"PatientAlerts": []

}

Weight

This example shows that the patient responded manually to the prompt to enter their weight during their monitoring program. The patient entered a value of 105.6 lbs that produced a high alert because they lost 5.6 pounds within a day.

{

"PatientId": 106,

"SurveyQuestionType": "Weight",

"Question": "Prompt for Weight Scale reading",

"SurveyParameterType": "Weight",

"SortOrder": 0,

"Value": "105.6",

{

"SortOrder": 0,

"Value": "lbs",

(10)

"PatientAlerts": [{

"Url": null,

"IconUrl": "",

"AlertTypeId": 9,

"AlertType": "WeightScaleBiometric",

"PatientId": 106,

"AlertStatusId": 1,

"Message": "Weight 105.6 lbs (Max weight = 36.52 lbs, 5.4 lbs (4.86%) weight loss within a day).",

}

Yes No

This example shows that the patient responded to the prompt to answer a question with a Yes/No answer. The question was "Do you find it more difficult to take care of yourself, such as bathing, cooking, and cleaning?" The patient answered "No" which did not produce an alert.

{

"PatientId": 106,

"SurveyQuestionType": "YesNo",

"Survey": "Last X day of Month",

"Question": "Do you find it more difficult to take care of yourself such as bathing, cooking, and cleaning your house?",

"SortOrder": 0,

"Value": "No",

(11)

"PatientAlerts": []

} }

Yes No Alert

This example shows that the patient answered a question during their pathway that had Yes and No as response options. The question was "Have you had any difficulty with daily activities since yesterday,"

and the response was "Yes" which produced a high alert.

{

"PatientId": 106,

"SurveyQuestionType": "YesNo",

"Question": "Have you had any difficulty with daily activities since yesterday?",

"SortOrder": 0,

"Value": "Yes",

"PatientAlerts": [{

"Url": null,

"IconUrl": "",

"AlertTypeId": 12,

"PatientId": 106,

"AlertStatusId": 1,

(12)

"Message": "Have you had any difficulty with daily activities since yesterday? : Yes.",

} }

Patient Biometric Added Event

In this section

• Pathway Response

• Blood Pressure

• Blood Sugar

• Oxygen

• Pulse

• Temperature

• Weight

Pathway Response

{

"PatientId": 3654,

"SurveyQuestionType": 6,

"CreatedBy_Id": 11,

"DeletedDateTime_UTC": null,

"DeletedBy_Id": null,

"IsPatientSurveyCompleted": false,

"PatientId": 3654,

"SkipBiometricReasonId": null,

"Value": null,

"CreatedBy_Id": 11,

"DeletedDateTime_UTC": null,

"DeletedBy_Id": null,

"PatientSurveyOption": null,

"SkipBiometricReason": null,

"SurveyParameterType": null }],

"PatientSurveyQuestion": null,

(13)

"PatientAlerts": [{

"AlertTypeId": 12,

"AlertSeverityName": null,

"AlertStatusId": 1,

"PatientId": 3654,

"Message": "How has your memory been in the last 2 weeks? : Worse than normal.",

"CreatedBy_Id": 11,

"AlertStatusSetBy_Id": null,

"AlertStatusSetByName": "",

"AlertStatusSetDateTime_UTC": null,

"CreatedDate": "2018-11-28T06:00:00Z",

"Url": null,

"IconUrl": "",

"Category": null,

"PatientResponse": null,

"Interventions": [],

"PatientChartEntries": []

}],

"Tags": null }

}

Blood Pressure

{

"PatientId": 3523,

"PatientSurveyQuestionId": null,

"PatientAlertId": null,

"AlertMessage": null,

"AlertStatusId": null,

"AlertStatus": null,

"SurveyQuestionType": "BloodPressure",

"PatientResponseInputMethod": "DirectEntry",

"SurveyParameterType": "Systolic",

"Value": "122",

{

"SurveyParameterType": "Diastolic",

"Value": "87",

"SkipReason": null

(14)

}]

Blood Sugar

{

"PatientId": 3523,

"SurveyQuestionType": "BloodSugar",

"SurveyParameterType": "BloodSugar",

"Value": "109",

{

"SurveyParameterType": "ReadingType",

"Value": "Random",

{

"Value": "mg/dL",

"SkipReason": null }]

}

Oxygen

{

"PatientId": 3523,

"SurveyQuestionType": "Oxygen",

(15)

"SurveyParameterType": "Oxygen",

"Value": "98",

}

Pulse

{

"PatientId": 3523,

"SurveyQuestionType": "Pulse",

"SurveyParameterType": "Pulse",

"Value": "78",

}

Temperature

This example shows that the patient's temperature was added on the Direct Entry page in the Care Team Portal. The temperature value entered was 97.7 F, which did not produce an alert.

{

"PatientId": 3523,

"SurveyQuestionType": "Temperature",

(16)

"SurveyParameterType": "TempFahrenheit",

"Value": "97.7",

}

Weight

This example shows that the patient's weight was entered on the Direct Entry page in Care Team Portal. The weight was entered as 163 pounds, which is a gain of 11 pounds in 4 days, which produced a medium alert.

{

"PatientId": 3654,

"AlertMessage": "Weight 163 lbs (11 lbs (7.24%) weight gain within 4 day(s)).",

"AlertStatusId": 1,

"SurveyQuestionType": "Weight",

"SurveyParameterType": "Weight",

"Value": "163",

"AlertSeverityLevel": "Medium",

{

"Value": "lbs",

}

(17)

Reference ID Tables

SurveyQuestionTypeId

SurveyQuestionTypeId contains the question types for patient responses.

Survey Question

Type ID Name

1 BloodSugar

2 BloodPressure

3 PulseOx

4 Weight

5 Number

6 SingleSelection

7 MultiSelection

8 HealthTip

9 Video

10 Yes/No

11 Temperature

13 Spirometer

14 Pulse

15 Oxygen

16 Steps

SurveyParameterTypeId

SurveyParameterTypeId contains the Pathway response types for patient biometrics.

Survey Parameter

Type ID

Name Survey Parameter

Type ID

Name

1 Systolic 10 Health Tip

2 Diastolic 11 TempFahrenheit

3 Blood Sugar 13 PEF

4 Weight 14 TempCelsius

5 Pulse 15 FEVOne

6 Oxygen 16 FEVRatio

7 ReadingType 17 ReadingDeviceModel

8 Survey 18 UnitType

9 Video 19 Steps

PatientResponseInputMethodId

PatientResponseInputMethodId contains the ways the patient can enter their biometric data.

Patient Response Input Method ID Name

1 Manual

2 Bluetooth

3 Direct Entry

CreatedDateTime_UTC

Created Date Time is the timestamp of when the patient response was written to the database. If you are using this API to sync data to your application, it is best to use created date time, so you don't miss responses synced after your sync call.

ObservationDateTime_UTC

Observation Date Time is the timestamp of when the patient provided the response.

Often, the observation time and created time will be within a few minutes of each other, but not always.

For example, the patient can enter their responses on the kit and due to network coverage, it could be hours later before the kit syncs with the server. In this situation, the observation times would be hours earlier than the created times. If you are using this API for reports, then observation time works best.

The purpose of this document is to provide reference information to assist software developers.

Vivify API

Webhooks

This document provides steps for using Vivify Health APIs with third party systems. For more information about using our services, contact us at [email protected].

Getting Started

The purpose of this document is to provide reference information to assist software developers.

You can use webhooks to be notified as data becomes available. A GET request is sent to the URL you provide whenever a certain event happens. The GET request will contain query string parameters defined below.

Event Description Query Parameters

Create Patient Notification when a patient ID is created.

PatientId

Pathway Complete Notification when a pathway is completed.

PatientId, PatientSurveyId, SurveyType, CompletedDate

Patient Added Notification when a patient is added to the Care Team Portal.

PatientAddedEvent

Patient Response Added

Notification when a patient pathway response is added.

PatientResponseAddedEvent

Patient Biometric Added

Notification when a patient’s biometric data is added.

PatientBiometricAddedEvent

For Reference ID Tables, see page 17.

Patient Added Event

This section includes an example for the webhook that subscribes to the PatientAddedEvent.

Patient Response Added Event

This section includes examples for the webhooks that subscribe to the PatientResponseAddedEvent.

In this section

Blood Pressure

Blood Sugar

Multi Select

Single Select

Single Select Alert

This example shows that the patient responded to a question that had several options, and the patient had the option to choose only one (single select). The question was "How has your memory been in the last 2 weeks?" The patient's response was "worse than normal" which produced a high-level alert.

Steps

}

Weight

This example shows that the patient responded manually to the prompt to enter their weight during their monitoring program. The patient entered a value of 105.6 lbs that produced a high alert because they lost 5.6 pounds within a day.

}

Yes No

This example shows that the patient responded to the prompt to answer a question with a Yes/No answer. The question was "Do you find it more difficult to take care of yourself, such as bathing, cooking, and cleaning?" The patient answered "No" which did not produce an alert.

Yes No Alert

This example shows that the patient answered a question during their pathway that had Yes and No as response options. The question was "Have you had any difficulty with daily activities since yesterday,"

and the response was "Yes" which produced a high alert.

Patient Biometric Added Event

In this section

Pathway Response

Blood Pressure

Blood Sugar

Oxygen

}

Pulse

}

Temperature

This example shows that the patient's temperature was added on the Direct Entry page in the Care Team Portal. The temperature value entered was 97.7 F, which did not produce an alert.

Weight

This example shows that the patient's weight was entered on the Direct Entry page in Care Team Portal. The weight was entered as 163 pounds, which is a gain of 11 pounds in 4 days, which produced a medium alert.

Reference ID Tables

1 BloodSugar

2 BloodPressure

3 PulseOx

4 Weight

5 Number

6 SingleSelection

7 MultiSelection

8 HealthTip

9 Video

10 Yes/No

11 Temperature

13 Spirometer

14 Pulse

15 Oxygen

16 Steps

CreatedDateTime_UTC

Created Date Time is the timestamp of when the patient response was written to the database. If you are using this API to sync data to your application, it is best to use created date time, so you don't miss responses synced after your sync call.

ObservationDateTime_UTC

Observation Date Time is the timestamp of when the patient provided the response.

Often, the observation time and created time will be within a few minutes of each other, but not always.

The date range format is: YYYY-MM-DDThh:mm:ss.sTZD.

PersonalCaregiverProviderId or Provider

Must be a valid provider. If providers don't exist in your portal yet, use null.

Phone1 or Phone2