GetPatients Method (Service)

Retrieves general information about patients belonging to a clinic and a provider in JSON format.

Method Type: GET
Authorization:

Token (Required): Type: Bearer Token
Authorization token

Request

Usage

Copy

https://test.hs1api.com/ascend-gateway/api/v0/MU/GetPatients

Parameters

clinicId (Optional): Type: string
Clinic Id
providerId (Optional): Type: string
Provider Id

Headers

Organization-ID (Required): Type: string
Organization Id

Request Body

None

Response

statusCode: Type: numeric
Response status code
data: Type: patients
Array of Patient objects

Example

{
    "statusCode": 200,
    "data": {
        "patients": [
            {
                "PatId": 1000001,
                "PatDb": 1000015,
                "FirstName": "Alex",
                "LastName": "Newman",
                "Chart": "NEWAL_0001",
                "BirthDate": "1976-11-11T00:00:00.000Z"
            },
            {
                "PatId": 1000003,
                "PatDb": 1000016,
                "FirstName": "Alice",
                "LastName": "Newman",
                "Chart": "NEWAL_0002",
                "BirthDate": "1978-11-11T00:00:00.000Z"
            }
        ]
    }
}

Possible Errors

"Execution timeout expired" - See General Errors
"Access token expired" - See Authentication Errors
"Invalid access token" - See Authentication Errors