GET PatientLists

Developer Tools

GET api/v1/{EMRSystem}/PatientLists

Returns all Patient Lists (e.g. location, custom, care team, etc.) for a given user.

HTTP Method

GET

Applicable Emissary Products

Interactive Workflow

Allscripts

Released

Athena

In Dev

Cerner

Released

Meditech

Released

Sandbox

In Dev

Don't see the data field you are looking for?

Request Information

URI Parameters

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

EMRSystem

The emr system.

EMRsystem

Required

UserId

Gets or sets the user identifier.

string

Required

ListType

Gets or sets the type of the list.

ListType

Required

 
Body Parameters
None
 

Response Information

 
Resource Description
Http response containing Patient Lists Response View Model.

NAME

DESCRIPTION

TYPE

ADDITIONAL INFO

GroupName

Gets or sets the name of the group.

string

None.

SubGroups

Gets or sets the sub groups.

Collection of PatientListSubGroupViewModel

None.

 
Response Codes

Http Status Code 200 – Returns Sansoro.Shared.SansoroServiceBus.Models.PatientListsResponseViewModel

Http Status Code 400 – Indicates that the request did not contain all the required fields.

Http Status Code 404 – Indicates that the resource to get could not be found.

Http Status Code 500 – Indicates that an internal server error occurred during processing of the request.

Http Status Code 502 – Indicates that a request made to the underlying EMR server could not be completed.

 
Response Formats
Sample Message
Download Json Schema
Not Applicable
Sample Message
Not Applicable

Submit a Comment

Your email address will not be published. Required fields are marked *

 

Don't see the data field you are looking for?