API docs by Redocly

Synergy API (0.0.0)

Download OpenAPI specification:Download

_addresses_listAddresss

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_addresses_createAddress

Request Body schema: application/json
required
id
required
string
line1
required
string
line2
required
string
city
required
string
district
required
string
state
required
string
postalCode
required
string
country
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
updatedBy
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "city": "string",
  • "district": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "city": "string",
  • "district": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

_addresses_getAddress

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "city": "string",
  • "district": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

_addresses_updateAddress

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
line1
required
string
line2
required
string
city
required
string
district
required
string
state
required
string
postalCode
required
string
country
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
updatedBy
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "city": "string",
  • "district": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "line1": "string",
  • "line2": "string",
  • "city": "string",
  • "district": "string",
  • "state": "string",
  • "postalCode": "string",
  • "country": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

_addresses_deleteAddress

path Parameters
id
required
string

Responses

_analytics_accountOverviewReport

header Parameters
authorization
required
string
Request Body schema: application/json
required
Array of objects (AccountOverviewFilter)
columns
Array of strings (AccountOverviewQueryColumnsEnum)
Items Enum: "accountName" "patientName" "dateOfBirth" "ehrMrn" "diagnosis" "vendor" "deviceType" "modelName" "serialNumber" "patientStatus" "patientStatusReason" "followingPractitioner" "referringProvider"
orderBy
Array of objects
dateRange
required
Array of strings
clinicIds
required
Array of strings
limit
integer <int32>
offset
integer <int32>
fetchAll
boolean

Responses

Request samples

Content type
application/json
{
  • "filters": [
    ],
  • "columns": [
    ],
  • "orderBy": [
    ],
  • "dateRange": [
    ],
  • "clinicIds": [
    ],
  • "limit": 0,
  • "offset": 0,
  • "fetchAll": true
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

_appointments_listAppointments

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_appointments_createAppointment

Request Body schema: application/json
required
id
required
string
salesforceRemoteId
required
string
appointmentName
required
string
appointmentNotes
string
completedDate
string <date>
cptCode
Array of strings
customFrequency
integer <int32>
encounterDate
string <date>
endDate
string <date>
frequency
string
frequencyNumber
number <float>
includeEriTracking
required
boolean
isMonthly
required
boolean
scheduledDate
string <date>
status
string
transmissionEligibleDate
string <date>
type
string
object (Device)
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
createdBy
string
updatedBy
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "salesforceRemoteId": "string",
  • "appointmentName": "string",
  • "appointmentNotes": "string",
  • "completedDate": "2019-08-24",
  • "cptCode": [
    ],
  • "customFrequency": 0,
  • "encounterDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "frequency": "string",
  • "frequencyNumber": 0.1,
  • "includeEriTracking": true,
  • "isMonthly": true,
  • "scheduledDate": "2019-08-24",
  • "status": "string",
  • "transmissionEligibleDate": "2019-08-24",
  • "type": "string",
  • "device": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "salesforceRemoteId": "string",
  • "appointmentName": "string",
  • "appointmentNotes": "string",
  • "completedDate": "2019-08-24",
  • "cptCode": [
    ],
  • "customFrequency": 0,
  • "encounterDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "frequency": "string",
  • "frequencyNumber": 0.1,
  • "includeEriTracking": true,
  • "isMonthly": true,
  • "scheduledDate": "2019-08-24",
  • "status": "string",
  • "transmissionEligibleDate": "2019-08-24",
  • "type": "string",
  • "device": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string"
}

_appointments_getAppointment

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "salesforceRemoteId": "string",
  • "appointmentName": "string",
  • "appointmentNotes": "string",
  • "completedDate": "2019-08-24",
  • "cptCode": [
    ],
  • "customFrequency": 0,
  • "encounterDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "frequency": "string",
  • "frequencyNumber": 0.1,
  • "includeEriTracking": true,
  • "isMonthly": true,
  • "scheduledDate": "2019-08-24",
  • "status": "string",
  • "transmissionEligibleDate": "2019-08-24",
  • "type": "string",
  • "device": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string"
}

_appointments_updateAppointment

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
salesforceRemoteId
required
string
appointmentName
required
string
appointmentNotes
string
completedDate
string <date>
cptCode
Array of strings
customFrequency
integer <int32>
encounterDate
string <date>
endDate
string <date>
frequency
string
frequencyNumber
number <float>
includeEriTracking
required
boolean
isMonthly
required
boolean
scheduledDate
string <date>
status
string
transmissionEligibleDate
string <date>
type
string
object (Device)
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
createdBy
string
updatedBy
required
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "salesforceRemoteId": "string",
  • "appointmentName": "string",
  • "appointmentNotes": "string",
  • "completedDate": "2019-08-24",
  • "cptCode": [
    ],
  • "customFrequency": 0,
  • "encounterDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "frequency": "string",
  • "frequencyNumber": 0.1,
  • "includeEriTracking": true,
  • "isMonthly": true,
  • "scheduledDate": "2019-08-24",
  • "status": "string",
  • "transmissionEligibleDate": "2019-08-24",
  • "type": "string",
  • "device": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "salesforceRemoteId": "string",
  • "appointmentName": "string",
  • "appointmentNotes": "string",
  • "completedDate": "2019-08-24",
  • "cptCode": [
    ],
  • "customFrequency": 0,
  • "encounterDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "frequency": "string",
  • "frequencyNumber": 0.1,
  • "includeEriTracking": true,
  • "isMonthly": true,
  • "scheduledDate": "2019-08-24",
  • "status": "string",
  • "transmissionEligibleDate": "2019-08-24",
  • "type": "string",
  • "device": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string"
}

_appointments_deleteAppointment

path Parameters
id
required
string

Responses

_billing_codes_listBillingCodes

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_billing_codes_createBillingCode

Request Body schema: application/json
required
id
required
string
code
required
string
codeType
required
string
Enum: "Diagnosis" "Professional"
required
object (Billing)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "codeType": "Diagnosis",
  • "billing": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "codeType": "Diagnosis",
  • "billing": {
    }
}

_billing_codes_getBillingCode

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "codeType": "Diagnosis",
  • "billing": {
    }
}

_billing_codes_updateBillingCode

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
code
required
string
codeType
required
string
Enum: "Diagnosis" "Professional"
required
object (Billing)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "codeType": "Diagnosis",
  • "billing": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "codeType": "Diagnosis",
  • "billing": {
    }
}

_billing_codes_deleteBillingCode

path Parameters
id
required
string

Responses

_billing_listBillings

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_billing_createBilling

Request Body schema: application/json
required
id
required
string
createdAt
required
string
updatedAt
required
string
updatedBy
required
string
version
required
integer <int32>
object (TransmissionReport)
isBillable
required
boolean
isAppDeterminedBillable
required
boolean
billingDate
string
technicalCode
required
string
appDeterminedReason
required
string
required
Array of objects (BillingCode)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "version": 0,
  • "transmissionReport": {
    },
  • "isBillable": true,
  • "isAppDeterminedBillable": true,
  • "billingDate": "string",
  • "technicalCode": "string",
  • "appDeterminedReason": "string",
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "version": 0,
  • "transmissionReport": {
    },
  • "isBillable": true,
  • "isAppDeterminedBillable": true,
  • "billingDate": "string",
  • "technicalCode": "string",
  • "appDeterminedReason": "string",
  • "codes": [
    ]
}

_billing_getBilling

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "version": 0,
  • "transmissionReport": {
    },
  • "isBillable": true,
  • "isAppDeterminedBillable": true,
  • "billingDate": "string",
  • "technicalCode": "string",
  • "appDeterminedReason": "string",
  • "codes": [
    ]
}

_billing_updateBilling

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
createdAt
required
string
updatedAt
required
string
updatedBy
required
string
version
required
integer <int32>
object (TransmissionReport)
isBillable
required
boolean
isAppDeterminedBillable
required
boolean
billingDate
string
technicalCode
required
string
appDeterminedReason
required
string
required
Array of objects (BillingCode)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "version": 0,
  • "transmissionReport": {
    },
  • "isBillable": true,
  • "isAppDeterminedBillable": true,
  • "billingDate": "string",
  • "technicalCode": "string",
  • "appDeterminedReason": "string",
  • "codes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "updatedBy": "string",
  • "version": 0,
  • "transmissionReport": {
    },
  • "isBillable": true,
  • "isAppDeterminedBillable": true,
  • "billingDate": "string",
  • "technicalCode": "string",
  • "appDeterminedReason": "string",
  • "codes": [
    ]
}

_billing_deleteBilling

path Parameters
id
required
string

Responses

_device_listDevices

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_device_createDevice

Request Body schema: application/json
required
id
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
createdBy
required
string
updatedBy
required
string
vendor
required
string
Enum: "medtronic" "boston_scientific" "abbott" "biotronik"
modelNumber
required
string
serialNumber
required
string
modelName
required
string
type
required
string
patientId
string
object (Patient)
lastTransmissionAt
string
nextTransmissionAt
string
isComboBillingTracked
required
boolean
isEriTracked
required
boolean
isHeartFailureTracked
required
boolean
frequencyIntervalDays
required
integer <int32>
implantDate
string
Array of objects (Transmission)
required
Array of objects (Appointment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "vendor": "medtronic",
  • "modelNumber": "string",
  • "serialNumber": "string",
  • "modelName": "string",
  • "type": "string",
  • "patientId": "string",
  • "patient": {
    },
  • "lastTransmissionAt": "string",
  • "nextTransmissionAt": "string",
  • "isComboBillingTracked": true,
  • "isEriTracked": true,
  • "isHeartFailureTracked": true,
  • "frequencyIntervalDays": 0,
  • "implantDate": "string",
  • "transmission": [
    ],
  • "appointments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "vendor": "medtronic",
  • "modelNumber": "string",
  • "serialNumber": "string",
  • "modelName": "string",
  • "type": "string",
  • "patientId": "string",
  • "patient": {
    },
  • "lastTransmissionAt": "string",
  • "nextTransmissionAt": "string",
  • "isComboBillingTracked": true,
  • "isEriTracked": true,
  • "isHeartFailureTracked": true,
  • "frequencyIntervalDays": 0,
  • "implantDate": "string",
  • "transmission": [
    ],
  • "appointments": [
    ]
}

_device_getDevice

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "vendor": "medtronic",
  • "modelNumber": "string",
  • "serialNumber": "string",
  • "modelName": "string",
  • "type": "string",
  • "patientId": "string",
  • "patient": {
    },
  • "lastTransmissionAt": "string",
  • "nextTransmissionAt": "string",
  • "isComboBillingTracked": true,
  • "isEriTracked": true,
  • "isHeartFailureTracked": true,
  • "frequencyIntervalDays": 0,
  • "implantDate": "string",
  • "transmission": [
    ],
  • "appointments": [
    ]
}

_device_updateDevice

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
createdBy
required
string
updatedBy
required
string
vendor
required
string
Enum: "medtronic" "boston_scientific" "abbott" "biotronik"
modelNumber
required
string
serialNumber
required
string
modelName
required
string
type
required
string
patientId
string
object (Patient)
lastTransmissionAt
string
nextTransmissionAt
string
isComboBillingTracked
required
boolean
isEriTracked
required
boolean
isHeartFailureTracked
required
boolean
frequencyIntervalDays
required
integer <int32>
implantDate
string
Array of objects (Transmission)
required
Array of objects (Appointment)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "vendor": "medtronic",
  • "modelNumber": "string",
  • "serialNumber": "string",
  • "modelName": "string",
  • "type": "string",
  • "patientId": "string",
  • "patient": {
    },
  • "lastTransmissionAt": "string",
  • "nextTransmissionAt": "string",
  • "isComboBillingTracked": true,
  • "isEriTracked": true,
  • "isHeartFailureTracked": true,
  • "frequencyIntervalDays": 0,
  • "implantDate": "string",
  • "transmission": [
    ],
  • "appointments": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "vendor": "medtronic",
  • "modelNumber": "string",
  • "serialNumber": "string",
  • "modelName": "string",
  • "type": "string",
  • "patientId": "string",
  • "patient": {
    },
  • "lastTransmissionAt": "string",
  • "nextTransmissionAt": "string",
  • "isComboBillingTracked": true,
  • "isEriTracked": true,
  • "isHeartFailureTracked": true,
  • "frequencyIntervalDays": 0,
  • "implantDate": "string",
  • "transmission": [
    ],
  • "appointments": [
    ]
}

_device_deleteDevice

path Parameters
id
required
string

Responses

_feature_flags_listFeatureFlags

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_feature_flags_createFeatureFlag

Request Body schema: application/json
required
id
required
string
displayName
required
string
displaySummary
required
string
shortCode
required
string
setting
required
integer <int32> [ 0 .. 4 ]
extendedSetting
string
createdAt
required
string
updatedAt
required
string
required
object (User)
required
object (User)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "displaySummary": "string",
  • "shortCode": "string",
  • "setting": 4,
  • "extendedSetting": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": {
    },
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "displaySummary": "string",
  • "shortCode": "string",
  • "setting": 4,
  • "extendedSetting": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": {
    },
  • "updatedBy": {
    }
}

_feature_flags_getFeatureFlag

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "displaySummary": "string",
  • "shortCode": "string",
  • "setting": 4,
  • "extendedSetting": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": {
    },
  • "updatedBy": {
    }
}

_feature_flags_updateFeatureFlag

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
displayName
required
string
displaySummary
required
string
shortCode
required
string
setting
required
integer <int32> [ 0 .. 4 ]
extendedSetting
string
createdAt
required
string
updatedAt
required
string
required
object (User)
required
object (User)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "displaySummary": "string",
  • "shortCode": "string",
  • "setting": 4,
  • "extendedSetting": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": {
    },
  • "updatedBy": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "displayName": "string",
  • "displaySummary": "string",
  • "shortCode": "string",
  • "setting": 4,
  • "extendedSetting": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "createdBy": {
    },
  • "updatedBy": {
    }
}

_feature_flags_deleteFeatureFlag

path Parameters
id
required
string

Responses

_uploaded_files_listUploadedFiles

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_uploaded_files_createUploadedFile

Request Body schema: application/json
required
id
required
string
key
required
string
originalName
required
string
bucketName
string
expiredAt
string
createdAt
required
string
updatedAt
required
string
deletedAt
string
required
object (Organization)
required
object (Patient)
required
object (User)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "originalName": "string",
  • "bucketName": "string",
  • "expiredAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "deletedAt": "string",
  • "clinic": {
    },
  • "patient": {
    },
  • "uploadedBy": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "originalName": "string",
  • "bucketName": "string",
  • "expiredAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "deletedAt": "string",
  • "clinic": {
    },
  • "patient": {
    },
  • "uploadedBy": {
    }
}

_uploaded_files_getUploadedFile

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "originalName": "string",
  • "bucketName": "string",
  • "expiredAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "deletedAt": "string",
  • "clinic": {
    },
  • "patient": {
    },
  • "uploadedBy": {
    }
}

_uploaded_files_updateUploadedFile

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
key
required
string
originalName
required
string
bucketName
string
expiredAt
string
createdAt
required
string
updatedAt
required
string
deletedAt
string
required
object (Organization)
required
object (Patient)
required
object (User)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "originalName": "string",
  • "bucketName": "string",
  • "expiredAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "deletedAt": "string",
  • "clinic": {
    },
  • "patient": {
    },
  • "uploadedBy": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "key": "string",
  • "originalName": "string",
  • "bucketName": "string",
  • "expiredAt": "string",
  • "createdAt": "string",
  • "updatedAt": "string",
  • "deletedAt": "string",
  • "clinic": {
    },
  • "patient": {
    },
  • "uploadedBy": {
    }
}

_uploaded_files_deleteUploadedUploadedFile

path Parameters
id
required
string

Responses

_organization_listOrganizations

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_organization_createOrganization

Request Body schema: application/json
required
id
required
string
mrn1
required
string
mrn2
required
string
ehrIntegration
required
boolean
name
required
string
phoneNumber
required
string
faxNumber
required
string
hasEmrAccess
required
boolean
emrName
string
goLiveOn
string <date-time>
onboardingOn
string <date-time>
internalHuddleOn
string <date-time>
kickoffHuddleOn
string <date-time>
createdAt
required
string <date-time>
updatedAt​
required
string <date-time>
createdBy
required
string
updatedBy
required
string
parentId
string
parent
object (Organization) Recursive
children
required
Array of objects (Organization)
required
object (Address)
required
Array of objects (Patient)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "ehrIntegration": true,
  • "name": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "hasEmrAccess": true,
  • "emrName": "string",
  • "goLiveOn": "2019-08-24T14:15:22Z",
  • "onboardingOn": "2019-08-24T14:15:22Z",
  • "internalHuddleOn": "2019-08-24T14:15:22Z",
  • "kickoffHuddleOn": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt​": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "parentId": "string",
  • "parent": { },
  • "children": [
    ],
  • "address": {
    },
  • "patients": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "ehrIntegration": true,
  • "name": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "hasEmrAccess": true,
  • "emrName": "string",
  • "goLiveOn": "2019-08-24T14:15:22Z",
  • "onboardingOn": "2019-08-24T14:15:22Z",
  • "internalHuddleOn": "2019-08-24T14:15:22Z",
  • "kickoffHuddleOn": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt​": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "parentId": "string",
  • "parent": { },
  • "children": [
    ],
  • "address": {
    },
  • "patients": [
    ]
}

_organization_getOrganization

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "ehrIntegration": true,
  • "name": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "hasEmrAccess": true,
  • "emrName": "string",
  • "goLiveOn": "2019-08-24T14:15:22Z",
  • "onboardingOn": "2019-08-24T14:15:22Z",
  • "internalHuddleOn": "2019-08-24T14:15:22Z",
  • "kickoffHuddleOn": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt​": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "parentId": "string",
  • "parent": { },
  • "children": [
    ],
  • "address": {
    },
  • "patients": [
    ]
}

_organization_updateOrganization

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
mrn1
required
string
mrn2
required
string
ehrIntegration
required
boolean
name
required
string
phoneNumber
required
string
faxNumber
required
string
hasEmrAccess
required
boolean
emrName
string
goLiveOn
string <date-time>
onboardingOn
string <date-time>
internalHuddleOn
string <date-time>
kickoffHuddleOn
string <date-time>
createdAt
required
string <date-time>
updatedAt​
required
string <date-time>
createdBy
required
string
updatedBy
required
string
parentId
string
parent
object (Organization) Recursive
children
required
Array of objects (Organization)
required
object (Address)
required
Array of objects (Patient)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "ehrIntegration": true,
  • "name": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "hasEmrAccess": true,
  • "emrName": "string",
  • "goLiveOn": "2019-08-24T14:15:22Z",
  • "onboardingOn": "2019-08-24T14:15:22Z",
  • "internalHuddleOn": "2019-08-24T14:15:22Z",
  • "kickoffHuddleOn": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt​": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "parentId": "string",
  • "parent": { },
  • "children": [
    ],
  • "address": {
    },
  • "patients": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "ehrIntegration": true,
  • "name": "string",
  • "phoneNumber": "string",
  • "faxNumber": "string",
  • "hasEmrAccess": true,
  • "emrName": "string",
  • "goLiveOn": "2019-08-24T14:15:22Z",
  • "onboardingOn": "2019-08-24T14:15:22Z",
  • "internalHuddleOn": "2019-08-24T14:15:22Z",
  • "kickoffHuddleOn": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt​": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "parentId": "string",
  • "parent": { },
  • "children": [
    ],
  • "address": {
    },
  • "patients": [
    ]
}

_organization_deleteOrganization

path Parameters
id
required
string

Responses

_organization_findAllPatients

Retrieves all patients for a specific Organization with pagination and sorting.

path Parameters
organizationId
required
string
query Parameters
required
object (PatientOffsetPaginationParams)
sortBy
required
string
sortDirection
required
string (SortDirection)
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
{
  • "patients": [
    ],
  • "errorMsg": "string",
  • "error": "string",
  • "currentOffset": 0,
  • "total": 0,
  • "totalNotDownloadedCount": 0
}

_organization_createPatient

Creates a new patient for a specified Organization.

path Parameters
organizationId
required
string
Request Body schema: application/json
required
mrn1
string
status
required
string
mrn2
string
ssn
string
familyName
required
string
givenName
required
string
birthDate
required
string
sex
string (PatientSex)
Enum: "Male" "Female"
email
string
phoneNumber
string
fileIds
Array of strings
emergencyName
string
emergencyPhone
string
patientNotes
string
homePhone
string
referralSource
string

Responses

Request samples

Content type
application/json
{
  • "mrn1": "string",
  • "status": "string",
  • "mrn2": "string",
  • "ssn": "string",
  • "familyName": "string",
  • "givenName": "string",
  • "birthDate": "string",
  • "sex": "Male",
  • "email": "string",
  • "phoneNumber": "string",
  • "fileIds": [
    ],
  • "emergencyName": "string",
  • "emergencyPhone": "string",
  • "patientNotes": "string",
  • "homePhone": "string",
  • "referralSource": "string"
}

Response samples

Content type
application/json
{
  • "patient": {
    }
}

_organization_updateVendorIntegrationStatus

Updates the status of a vendor integration for an Organization.

path Parameters
organizationId
required
string
vendorIntegrationId
required
string
Request Body schema: application/json
required
status
string (VendorIntegrationStatus)
Enum: "configured" "pending" "disabled"

Responses

Request samples

Content type
application/json
{
  • "status": "configured"
}

Response samples

Content type
application/json
{
  • "integration": {
    }
}

_patients_listPatients

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_patients_createPatient

Request Body schema: application/json
required
id
required
string
rhythmId
required
string
salesforceRemoteId
required
string
mrn1
required
string
mrn2
required
string
givenName
required
string
familyName
required
string
birthDate
required
string
sex
string (PatientSex)
Enum: "Male" "Female"
email
required
string
patientStatus
string
phoneNumber
required
string
ssn
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
required
object (Address)
required
Array of objects (Device)
required
Array of objects (PatientNote)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "rhythmId": "string",
  • "salesforceRemoteId": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "birthDate": "string",
  • "sex": "Male",
  • "email": "string",
  • "patientStatus": "string",
  • "phoneNumber": "string",
  • "ssn": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "devices": [
    ],
  • "patientNotes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "rhythmId": "string",
  • "salesforceRemoteId": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "birthDate": "string",
  • "sex": "Male",
  • "email": "string",
  • "patientStatus": "string",
  • "phoneNumber": "string",
  • "ssn": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "devices": [
    ],
  • "patientNotes": [
    ]
}

_patients_createCandidatePatient

Creates a candidate patient.

Request Body schema: application/json
required
candidatePatientSFId
required
string
clinicName
required
string
firstName
required
string
lastName
required
string
birthDate
required
string
source
required
string
crmPatient
required
boolean
rpmPatient
required
boolean
priority
string
diagnosisCodes
Array of strings
insuranceVerification
string
proofOfConsent
string
referringPhysician
string

Responses

Request samples

Content type
application/json
{
  • "candidatePatientSFId": "string",
  • "clinicName": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "birthDate": "string",
  • "source": "string",
  • "crmPatient": true,
  • "rpmPatient": true,
  • "priority": "string",
  • "diagnosisCodes": [
    ],
  • "insuranceVerification": "string",
  • "proofOfConsent": "string",
  • "referringPhysician": "string"
}

Response samples

Content type
application/json
{
  • "patient": {
    }
}

_patients_findDeviceClinicLevelPreference

Retrieves device clinic frequency based on patient ID.

path Parameters
patientId
required
string

Responses

Response samples

Content type
application/json
{
  • "deviceFrequency": "string"
}

_patients_findOneKareoPatient

Fetches a single patient based on the mrn1 identifier.

query Parameters
required
object (FindKareoPatientQueryParams)

Responses

Response samples

Content type
application/json
{
  • "patient": {
    }
}

_patients_matchTransmission

Matches a transmission to a patient based on given parameters.

Request Body schema: application/json
required
familyName
required
string
givenName
required
string
dob
string
vendorCode
string
deviceModelNumber
required
string
deviceSerialNumber
required
string
transmissionId
required
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "familyName": "string",
  • "givenName": "string",
  • "dob": "string",
  • "vendorCode": "string",
  • "deviceModelNumber": "string",
  • "deviceSerialNumber": "string",
  • "transmissionId": 0
}

Response samples

Content type
application/json
{
  • "patientId": "string"
}

_patients_totalMonitored

Fetches total monitored patients data for a given date range.

query Parameters
required
object (GetTotalPatientsMonitoredParams)

Responses

Response samples

Content type
application/json
{
  • "startFrom": "string",
  • "endAt": "string",
  • "patientsData": [
    ]
}

_patients_getPatient

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "rhythmId": "string",
  • "salesforceRemoteId": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "birthDate": "string",
  • "sex": "Male",
  • "email": "string",
  • "patientStatus": "string",
  • "phoneNumber": "string",
  • "ssn": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "devices": [
    ],
  • "patientNotes": [
    ]
}

_patients_updatePatient

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
rhythmId
required
string
salesforceRemoteId
required
string
mrn1
required
string
mrn2
required
string
givenName
required
string
familyName
required
string
birthDate
required
string
sex
string (PatientSex)
Enum: "Male" "Female"
email
required
string
patientStatus
string
phoneNumber
required
string
ssn
required
string
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
required
object (Address)
required
Array of objects (Device)
required
Array of objects (PatientNote)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "rhythmId": "string",
  • "salesforceRemoteId": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "birthDate": "string",
  • "sex": "Male",
  • "email": "string",
  • "patientStatus": "string",
  • "phoneNumber": "string",
  • "ssn": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "devices": [
    ],
  • "patientNotes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "rhythmId": "string",
  • "salesforceRemoteId": "string",
  • "mrn1": "string",
  • "mrn2": "string",
  • "givenName": "string",
  • "familyName": "string",
  • "birthDate": "string",
  • "sex": "Male",
  • "email": "string",
  • "patientStatus": "string",
  • "phoneNumber": "string",
  • "ssn": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "address": {
    },
  • "devices": [
    ],
  • "patientNotes": [
    ]
}

_patients_deletePatient

path Parameters
id
required
string

Responses

_patients_findAllAuthorizedPractitioners

Fetches all authorized practitioners for a specific patient.

path Parameters
patientId
required
string

Responses

Response samples

Content type
application/json
{
  • "practitioners": [
    ]
}

_patients_updateStatus

Updates the status of a patient based on their Salesforce remote ID.

path Parameters
salesforceRemoteId
required
string
Request Body schema: application/json
required
status
string

Responses

Request samples

Content type
application/json
{
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "patient": {
    },
  • "message": "string"
}

_transmission_reports_listTransmissionReports

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_transmission_reports_createTransmissionReport

Request Body schema: application/json
required
id
required
integer <int32>
object (Patient)
color
required
string
Enum: "GRAY" "RED" "GREEN" "YELLOW"
required
Array of objects (TransmissionReportNote)
required
Array of objects (TransmissionReportImage)
required
Array of objects (TransmissionReportAlert)
required
Array of objects (TransmissionReportSignature)
overrides
required
string
signatureStatus
required
string
Enum: "NOT_SIGNED" "SIGNED" "REJECTED"
transmissionType
required
string
Enum: "REMOTE" "IN_PERSON"
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
flagHeartFailure
required
boolean
updatedBy
required
string
version
required
integer <int32>
oac
string
referringPhysician
required
string
diagnosisOption
required
string
object (User)
object (Transmission)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "patient": {
    },
  • "color": "GRAY",
  • "notes": [
    ],
  • "images": [
    ],
  • "alerts": [
    ],
  • "signatures": [
    ],
  • "overrides": "string",
  • "signatureStatus": "NOT_SIGNED",
  • "transmissionType": "REMOTE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "flagHeartFailure": true,
  • "updatedBy": "string",
  • "version": 0,
  • "oac": "string",
  • "referringPhysician": "string",
  • "diagnosisOption": "string",
  • "practitioner": {
    },
  • "transmission": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "patient": {
    },
  • "color": "GRAY",
  • "notes": [
    ],
  • "images": [
    ],
  • "alerts": [
    ],
  • "signatures": [
    ],
  • "overrides": "string",
  • "signatureStatus": "NOT_SIGNED",
  • "transmissionType": "REMOTE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "flagHeartFailure": true,
  • "updatedBy": "string",
  • "version": 0,
  • "oac": "string",
  • "referringPhysician": "string",
  • "diagnosisOption": "string",
  • "practitioner": {
    },
  • "transmission": {
    }
}

_transmission_reports_count

Counts the transmissions based on the filters applied.

query Parameters
required
object (TransmissionReportCountParamsDto)

Responses

Response samples

Content type
application/json
{
  • "counts": {
    },
  • "clinicIds": [
    ]
}

_transmission_reports_findAllICDCode

Fetch all ICD diagnosis codes.

Responses

Response samples

Content type
application/json
{
  • "icdDiagnosisCodes": [
    ]
}

_transmission_reports_submitManualAndInclinicReports

Saves manual or in-clinic transmission reports.

Request Body schema: application/json
required
patientId
required
string
reportType
required
string (TransmissionReportType)
Enum: "MANUAL" "INCLINIC"
files
Array of strings
deviceId
required
string

Responses

Request samples

Content type
application/json
{
  • "patientId": "string",
  • "reportType": "MANUAL",
  • "files": [
    ],
  • "deviceId": "string"
}

Response samples

Content type
application/json
{
  • "fileStatus": "string"
}

_transmission_reports_searchUnsignedReports

Searches for unsigned transmission reports based on filters.

Request Body schema: application/json
required
color
string (TransmissionReportColors)
Enum: "RED" "YELLOW" "GREEN" "GRAY"
query
string

Responses

Request samples

Content type
application/json
{
  • "color": "RED",
  • "query": "string"
}

Response samples

Content type
application/json
{
  • "transmissionReports": [
    ]
}

_transmission_reports_signAllToLambda

Sends 'sign all' data to the appropriate SQS queue based on configuration.

Request Body schema: application/json
required
signAll
required
string

Responses

Request samples

Content type
application/json
{
  • "signAll": "string"
}

Response samples

Content type
application/json
"string"

_transmission_reports_getTransmissionReport

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "patient": {
    },
  • "color": "GRAY",
  • "notes": [
    ],
  • "images": [
    ],
  • "alerts": [
    ],
  • "signatures": [
    ],
  • "overrides": "string",
  • "signatureStatus": "NOT_SIGNED",
  • "transmissionType": "REMOTE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "flagHeartFailure": true,
  • "updatedBy": "string",
  • "version": 0,
  • "oac": "string",
  • "referringPhysician": "string",
  • "diagnosisOption": "string",
  • "practitioner": {
    },
  • "transmission": {
    }
}

_transmission_reports_updateTransmissionReport

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
integer <int32>
object (Patient)
color
required
string
Enum: "GRAY" "RED" "GREEN" "YELLOW"
required
Array of objects (TransmissionReportNote)
required
Array of objects (TransmissionReportImage)
required
Array of objects (TransmissionReportAlert)
required
Array of objects (TransmissionReportSignature)
overrides
required
string
signatureStatus
required
string
Enum: "NOT_SIGNED" "SIGNED" "REJECTED"
transmissionType
required
string
Enum: "REMOTE" "IN_PERSON"
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
flagHeartFailure
required
boolean
updatedBy
required
string
version
required
integer <int32>
oac
string
referringPhysician
required
string
diagnosisOption
required
string
object (User)
object (Transmission)

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "patient": {
    },
  • "color": "GRAY",
  • "notes": [
    ],
  • "images": [
    ],
  • "alerts": [
    ],
  • "signatures": [
    ],
  • "overrides": "string",
  • "signatureStatus": "NOT_SIGNED",
  • "transmissionType": "REMOTE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "flagHeartFailure": true,
  • "updatedBy": "string",
  • "version": 0,
  • "oac": "string",
  • "referringPhysician": "string",
  • "diagnosisOption": "string",
  • "practitioner": {
    },
  • "transmission": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "patient": {
    },
  • "color": "GRAY",
  • "notes": [
    ],
  • "images": [
    ],
  • "alerts": [
    ],
  • "signatures": [
    ],
  • "overrides": "string",
  • "signatureStatus": "NOT_SIGNED",
  • "transmissionType": "REMOTE",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "flagHeartFailure": true,
  • "updatedBy": "string",
  • "version": 0,
  • "oac": "string",
  • "referringPhysician": "string",
  • "diagnosisOption": "string",
  • "practitioner": {
    },
  • "transmission": {
    }
}

_transmission_reports_deleteTransmissionReport

path Parameters
id
required
string

Responses

_transmission_reports_addInClinicPdfToTempBucket

Uploads an in-clinic PDF to a temporary bucket for the patient.

path Parameters
patientId
required
string
fileName
required
string

Responses

Response samples

Content type
application/json
{
  • "status": [
    ]
}

_transmission_reports_dismissAll

Dismisses all specified transmission reports for the give comma-separated list of IDs.

path Parameters
tranmissionReportIds
required
string

Responses

Response samples

Content type
application/json
{
  • "dismissedIds": "string"
}

_transmission_reports_fetchIsBillableForReports

Fetches billable data for transmission reports based on IDs.

path Parameters
transmissionReportIds
required
string

Responses

Response samples

Content type
application/json
{
  • "isBillableData": [
    ]
}

_transmission_reports_VendorDbPatientDeviceType

Retrieves the device type for a patient by transmission report ID.

path Parameters
transmissionReportId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "deviceType": "string",
  • "ILR": true
}

_transmission_reports_VendorDbPatientILRDeviceType

Retrieves the ILR device type for a patient by transmission report ID.

path Parameters
transmissionReportId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "deviceType": "string",
  • "ILR": true
}

_transmission_reports_VendorDbPatientLambdaILRDeviceType

Retrieves the ILR device type for a patient based on transmission report ID and user ID.

path Parameters
transmissionReportId
required
integer <int32>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "deviceType": "string",
  • "ILR": true
}

_transmission_reports_addAlertImage

Adds an image to a specific alert for the given transmission report

path Parameters
transmissionReportId
required
integer <int32>
alertId
required
string
Request Body schema: application/json
required
fileId
required
string

Responses

Request samples

Content type
application/json
{
  • "fileId": "string"
}

Response samples

Content type
application/json
{
  • "image": {
    }
}

_transmission_reports_deleteAlertImage

Deletes an image from a specific alert for the given transmission report.

path Parameters
transmissionReportId
required
integer <int32>
alertId
required
string
imageId
required
string

Responses

Response samples

Content type
application/json
{
  • "deleted": true
}

_transmission_reports_getAttachments

Retrieves all attachments for a given transmission report.

path Parameters
transmissionReportId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total": 0
}

_transmission_reports_addAttachments

Adds attachments to a transmission report.

path Parameters
transmissionReportId
required
integer <int32>
Request Body schema: application/json
required
required
object (AddAttachmentsDto)
files
required
Array of strings <byte> [ items <byte > ]

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "files": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

_transmission_reports_addDiagnosisCodeToBilling

Adds a diagnosis code to the billing for the specified transmission report.

path Parameters
transmissionReportId
required
integer <int32>
billingId
required
string
Request Body schema: application/json
required
object (LabelAndValue)

Responses

Request samples

Content type
application/json
{
  • "diagnosisCode": {
    }
}

Response samples

Content type
application/json
{
  • "billing": {
    }
}

_transmission_reports_createCounters

Creates counters for a specified transmission report.

path Parameters
transmissionReportId
required
integer <int32>
Request Body schema: application/json
required
required
object (CountersObject)

Responses

Request samples

Content type
application/json
{
  • "countersobject": {
    }
}

Response samples

Content type
application/json
{
  • "counters": {
    }
}

_transmission_reports_dismiss

Dismisses a specific transmission report by its ID.

path Parameters
transmissionReportId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "dismissedIds": "string"
}

_transmission_reports_transmissionOverride

Applies vendor data overrides to a specified transmission report.

path Parameters
transmissionReportId
required
integer <int32>
Request Body schema: application/json
required
object (DeviceOverrides)
object (DeviceMeasurementOverrides)
object (DeviceLeadsOverrides)
deviceLeadId
integer or null <int32>
egmImage
string or null
egmImageStatus
string or null

Responses

Request samples

Content type
application/json
{
  • "device": {
    },
  • "deviceMeasurement": {
    },
  • "deviceLeads": {
    },
  • "deviceLeadId": 0,
  • "egmImage": "string",
  • "egmImageStatus": "string"
}

Response samples

Content type
application/json
{
  • "transmissionReport": {
    }
}

_transmission_reports_sign

Signs a transmission report for the specified transmission report ID.

path Parameters
transmissionReportId
required
integer <int32>
Request Body schema: application/json
required
signDate
string

Responses

Request samples

Content type
application/json
{
  • "signDate": "string"
}

Response samples

Content type
application/json
{
  • "signature": {
    }
}

_transmission_reports_signAllDismisSignFromLambda

Dismisses and signs a transmission report for the specified transmission report ID and user.

path Parameters
transmissionReportId
required
integer <int32>
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "signature": {
    }
}

_transmission_reports_unDismiss

Undismisses a specific transmission report by its ID.

path Parameters
transmissionReportId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "dismissedIds": "string"
}

_transmission_reports_updateCounters

Updates counters for a specified transmission report.

path Parameters
transmissionReportId
required
integer <int32>
countersId
required
string
Request Body schema: application/json
required
object (CountersObject)

Responses

Request samples

Content type
application/json
{
  • "countersobject": {
    }
}

Response samples

Content type
application/json
{
  • "counters": {
    }
}

_transmission_reports_addRhythmVendorPdfToBucket

Uploads a PDF to the bucket for a given transmission report.

path Parameters
transmissionReportId
required
integer <int32>
Request Body schema: application/json
required
required
object (RhythmVendorPdfToBucketParams)
file
required
string <byte>

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "file": "string"
}

Response samples

Content type
application/json
{
  • "status": "string",
  • "notes": "string"
}

_transmission_reports_vendorTransmissionReportUrl

Retrieves a vendor transmission report URL for the specified transmission report.

path Parameters
transmissionReportId
required
integer <int32>
query Parameters
required
object (VendorTransmissionReportUrlParamsDto)

Responses

Response samples

Content type
application/json
{
  • "vendorTransmissionReportUrl": "string"
}

_transmission_reports_vendorTransmissionsReports

Fetches vendor transmission report pdfs from the vendor s3 bucket

path Parameters
transmissionReportId
required
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "vendorTransmissionReports": [
    ]
}

_transmission_reports_storePDFDownloadInfo

Stores PDF download information for a specified transmission report.

path Parameters
transmissionReportId
required
integer <int32>
downloadDate
required
string

Responses

Response samples

Content type
application/json
{
  • "storedInfo": {
    }
}

_transmission_reports_addRhythymPDFUploadDataToDb

Saves PDF upload data to the database for a transmission report.

path Parameters
transmissionReportId
required
integer <int32>
status
required
string
uploadResult
required
string
uploadKey
required
string
fileName
required
string

Responses

Response samples

Content type
application/json
{
  • "dbUpdate": true
}

_transmission_listTransmission

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_transmission_createTransmission

Request Body schema: application/json
required
transmissionId
required
integer <int32>
transmissionDate
required
string <date-time>
transmissionFilePath
string
transmissionStatus
string
createdAt
string <date-time>
updatedAt
string <date-time>
deviceId
string
object (Device)

Responses

Request samples

Content type
application/json
{
  • "transmissionId": 0,
  • "transmissionDate": "2019-08-24T14:15:22Z",
  • "transmissionFilePath": "string",
  • "transmissionStatus": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deviceId": "string",
  • "device": {
    }
}

Response samples

Content type
application/json
{
  • "transmissionId": 0,
  • "transmissionDate": "2019-08-24T14:15:22Z",
  • "transmissionFilePath": "string",
  • "transmissionStatus": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deviceId": "string",
  • "device": {
    }
}

_transmission_getTransmission

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "transmissionId": 0,
  • "transmissionDate": "2019-08-24T14:15:22Z",
  • "transmissionFilePath": "string",
  • "transmissionStatus": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deviceId": "string",
  • "device": {
    }
}

_transmission_updateTransmission

path Parameters
id
required
string
Request Body schema: application/json
required
transmissionId
required
integer <int32>
transmissionDate
required
string <date-time>
transmissionFilePath
string
transmissionStatus
string
createdAt
string <date-time>
updatedAt
string <date-time>
deviceId
string
object (Device)

Responses

Request samples

Content type
application/json
{
  • "transmissionId": 0,
  • "transmissionDate": "2019-08-24T14:15:22Z",
  • "transmissionFilePath": "string",
  • "transmissionStatus": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deviceId": "string",
  • "device": {
    }
}

Response samples

Content type
application/json
{
  • "transmissionId": 0,
  • "transmissionDate": "2019-08-24T14:15:22Z",
  • "transmissionFilePath": "string",
  • "transmissionStatus": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "deviceId": "string",
  • "device": {
    }
}

_transmission_deleteTransmission

path Parameters
id
required
string

Responses

_users_listUsers

Responses

Response samples

Content type
application/json
[
  • {
    }
]

_users_createUser

Request Body schema: application/json
required
id
required
string
firstName
required
string
lastName
required
string
prefix
required
string
suffix
required
string
credentials
required
string
birthDate
string <date-time>
email
required
string
phoneNumber
required
string
mobileNumber
string
object (Address)
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
createdBy
required
string
updatedBy
required
string
role
required
string
Enum: "Admin" "Practitioner" "User"
required
Array of objects (Organization)
parentOrganizationId
string
object (Organization)
lastLogin
string <date-time>
featureFlagRole
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "credentials": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "address": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "role": "Admin",
  • "organizations": [
    ],
  • "parentOrganizationId": "string",
  • "parentOrganization": {
    },
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "featureFlagRole": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "credentials": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "address": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "role": "Admin",
  • "organizations": [
    ],
  • "parentOrganizationId": "string",
  • "parentOrganization": {
    },
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "featureFlagRole": 0
}

_users_getUser

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "credentials": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "address": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "role": "Admin",
  • "organizations": [
    ],
  • "parentOrganizationId": "string",
  • "parentOrganization": {
    },
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "featureFlagRole": 0
}

_users_updateUser

path Parameters
id
required
string
Request Body schema: application/json
required
id
required
string
firstName
required
string
lastName
required
string
prefix
required
string
suffix
required
string
credentials
required
string
birthDate
string <date-time>
email
required
string
phoneNumber
required
string
mobileNumber
string
object (Address)
createdAt
required
string <date-time>
updatedAt
required
string <date-time>
createdBy
required
string
updatedBy
required
string
role
required
string
Enum: "Admin" "Practitioner" "User"
required
Array of objects (Organization)
parentOrganizationId
string
object (Organization)
lastLogin
string <date-time>
featureFlagRole
integer <int32>

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "credentials": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "address": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "role": "Admin",
  • "organizations": [
    ],
  • "parentOrganizationId": "string",
  • "parentOrganization": {
    },
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "featureFlagRole": 0
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "credentials": "string",
  • "birthDate": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "phoneNumber": "string",
  • "mobileNumber": "string",
  • "address": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "role": "Admin",
  • "organizations": [
    ],
  • "parentOrganizationId": "string",
  • "parentOrganization": {
    },
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "featureFlagRole": 0
}

_users_deleteUser

path Parameters
id
required
string

Responses