Base Path: /actor/current/patientlist
Version: 8.2.0
This API provides access to the published patient list sources.
Authorization: OAuth 2.0 Bearer token is required to access the resources of this API. Once signed up, credentials and URL to access the OAuth API can be found on My Apps Page.
GET /actor/current/patientlist/
Returns an object with an array of available patient lists as the payload.
200
Patient list was retrieved successfully
curl -X GET "https://api.orionhealth.io/actor/current/patientlist/" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'
GET /actor/current/patientlist/{patientlistname}
Returns an object with the specified patient list container as the payload.
Name
Type
Data Type
Description
Name:
patientlistname
required
Type:
path
Data Type:
string
Description:
The name of the patient list
Sample Value: watchlist
200
Patient list container was retrieved successfully
curl -X GET "https://api.orionhealth.io/actor/current/patientlist/watchlist" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'
GET /actor/current/patientlist/{patientlistname}/{sourceName}
Returns an object with an array of patient identities from the source as the payload.
Name
Type
Data Type
Description
Name:
patientlistname
required
Type:
path
Data Type:
string
Description:
The name of the patient list
Sample Value: watchlist
Name:
sourceName
required
Type:
path
Data Type:
string
Description:
The name of the patient list source
Sample Value: Red
200
Patient list source was retrieved successfully
curl -X GET "https://api.orionhealth.io/actor/current/patientlist/watchlist/Red" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <Access Token>'