Epi-Management API


INTRODUCTION


In this documentation we will list all the steps required to access protected health information based on the documentation of an open API.

Permissions


API access is managed using scopes and permissions. Scopes are granted to an API Application when a user authorizes and permissions are granted by a primary user to other users in his or her Practice Group. The scopes are granted during the oAuth process, whereas the permissions have to be granted from EpiManagement web app. In order for an app to access information on behalf of a EpiManagement user, the user must authorize the app for the required scopes, and the user must have the appropriate permissions set.

Requests


All requests must be made using the base URL https://neregaws.epilepsygroup.com/nereg.prod/rest/

Responses


All responses are in JSON format. Generally input may use the application/json, application/x-www-form-urlencoded or form/multipart.

Data Types


The data types referred to in the documentation, for both requests and responses, are listed below.

TypeExampleDescription
boolean
true
integer
123
string
"Hello, world!"
URLAn absolute URL, including protocol
object
{"key": "value"}
A nested object. When a value is of type "object", the word "object" will always link to a popup with the object's format.
array
[1, 2]
A value may have type "array of :type"
date
"2014-02-24"
An ISO 8601 encoded date
date range
"2014-02-24/2014-02-28"
A start and end date separated by a slash
fileWhen uploading, this is provided as a standard multipart/form-data file
base64encoded fileWhen uploading, this is provided as a base64 encoded file within JSON
time
"12:34:56"
An ISO 8601 encoded time
timestamp
"2014-02-24T15:32:19"
An ISO 8601 encoded timestamp, with no timezone
color
"#ABCDEF" or "rgb(12, 34, 45)"
A CSS color specified in either of these formats
decimal
"123.45"
A numeric value truncated to two decimal places. It may be passed to an endpoint as an integer, float or string, but will always be returned as a string.