GetPatientInfoAuditable Method

Retrieves detailed information about patients by first name, last name, and birth date.

Method Type: GET
Authorization:

Token (Required): Type: Bearer Token
Authorization token

Request

Usage

Copy

https://test.hs1api.com/ascend-gateway/api/v0/MU/GetPatientInfoAuditable?filter=firstName==Alice,lastName==Newman,birthDate==1978-11-11

Parameters

filter (Required): Filter expression, using a combination of the following parameters:

firstName (Optional): Type: string
The patient's first name
lastName (Optional): Type: string
The patient's last name
birthDate (Optional): Type: dateTime
The patient's date of birth

Headers

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

Request Body

None

Response

statusCode: Type: numeric
Response status code
data: Type: patientInfo
Array of PatientInfo objects

Example

{
    "statusCode": 200,
    "data": {
        "patientInfo": [
            {
                "PatId": 1000003,
                "PatDb": 1000016,
                "EmailAdress": "",
                "FirstName": "Alice",
                "LastName": "Newman",
                "PrefName": "",
                "Phone": "8015551234",
                "OtherPhone": "",
                "Pager": "8015551111",
                "Gender": 2,
                "BirthDate": "1978-11-11T00:00:00.000Z",
                "Street": "1234, Some St",
                "Street2": "",
                "City": "Anytown",
                "State": "AK",
                "Zip": "12345",
                "Active": null,
                "FirstVisitDate": "2015-06-22T00:00:00.000Z",
                "LastVisitDate": "2019-02-28T00:00:00.000Z",
                "PatientDeathDate": null,
                "DueDate": "2020-02-29T00:00:00.000Z",
                "IntervalUnit": null,
                "IntervalQty": null,
                "PrinsUserId": 0,
                "PrinsUserDb": 0,
                "InsuredPartyId": null,
                "InsuredPartyDb": null,
                "GuarId": 1000003,
                "GuarDb": 1000016,
                "ProvId": 1000017,
                "ProvDb": 1000016,
                "MissedAppt": 0,
                "PrivacyFlags": 0,
                "ConsultFlag": 0,
                "ConsentDate": "2015-06-22T00:00:00.000Z"
            }         ]
    }
}

Possible Errors

"Execution timeout expired" - See General Errors
"Access token expired" - See Authentication Errors
"Invalid access token" - See Authentication Errors
"Patient not found" - See Patient Data Errors