Oracle Health Sciences mHealth Connector Cloud Service - Studies, Subjects, and Devices

All REST Endpoints

device bootstrap

Mobile application on-boarding

Bootstrap or onboard a device: Method: post
Path: /api/deviceBootstrap
Get a bootstrap device's access ID and OTP: Method: get
Path: /api/studies/{studyId}/subjects/{subjectId}/devices/{deviceId}/cred
Recreate an access ID and OTP of a bootstrap device: Method: put
Path: /api/studies/{studyId}/subjects/{subjectId}/devices/{deviceId}/cred

devices

eSources or devices in an mHealth / digital study

Create a device to receive clinical data from an eSource: Method: post
Path: /api/studies/{studyId}/subjects/{subjectId}/devices
Delete a subject's eSource virtual device: Method: delete
Path: /api/studies/{studyId}/subjects/{subjectId}/devices/{deviceId}
Get all active eSource device instances created in the study: Method: get
Path: /api/studies/{studyId}/devices
Get an eSource virtual device for a subject by device ID: Method: get
Path: /api/studies/{studyId}/subjects/{subjectId}/devices/{deviceId}
Get eSource[s] / virtual devices associated with a subject: Method: get
Path: /api/studies/{studyId}/subjects/{subjectId}/devices
Update properties of a subject's eSource virtual device: Method: put
Path: /api/studies/{studyId}/subjects/{subjectId}/devices/{deviceId}

studies

Everything about mHealth / digital studies in a tenant

Get a study by ID: Method: get
Path: /api/studies/{studyId}
Get study-level settings: Method: get
Path: /api/studies/{studyId}/config
Get the status of a job: Method: get
Path: /api/studies/{studyId}/jobs/{jobId}
List all studies: Method: get
Path: /api/studies
Override study-level settings: Method: put
Path: /api/studies/{studyId}/config
Restart message delivery retry attempts on permanently failed dispatches: Method: post
Path: /api/studies/config/targetReconciler

subjects

Subjects in an mHealth / digital study

Delete a subject by ID: Method: delete
Path: /api/studies/{studyId}/subjects/{subjectId}
Delete subjects and decommission devices in a study: Method: delete
Path: /api/studies/{studyId}/subjects
Get a subject by ID: Method: get
Path: /api/studies/{studyId}/subjects/{subjectId}
List all subjects in a study: Method: get
Path: /api/studies/{studyId}/subjects
Register a subject in a study: Method: post
Path: /api/studies/{studyId}/subjects
Update subject attributes: Method: put
Path: /api/studies/{studyId}/subjects/{subjectId}