SageBridge API - SearchPatients function

SearchPatients

function is used to search patients by variery of criteria (wildcard search).

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"SearchPatients",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);

Request parameters:

(at least one field must be populated)

patientID	(string)	Unique Patient Id (PM identifier).
first	(string)	Patient first name.
middle	(string)	Patient middle initial.
last	(string)	Patient last name.
birthdate	(string)	Patient birth date.
sex	(string)	Patient gender.
SSN	(string)	Patient Social Security Number.
addr1	(string)	Patient Address Line 1.
addr2	(string)	Patient Address Line 2.
city	(string)	Patient City.
state	(string)	Patient State.
zip	(string)	Patient Zipcode.
phone	(string)	Patient phone.
email	(string)	Patient email.

Notes

Some practice may have partial search by last field enabled.
To perform partial search please use '*' symbol at the end of last value.
Only single '*' character is allowed in a parameter.
Example of partial search: 'Adam*' will return 'Adam', 'Adams', 'Adamson', 'Adam Jr', 'Adamson III', etc.
Example of search regarless of suffix: 'Adam *' will return 'Adam Jr' only.

JSON string request example:

{
  "last": "ZzTest",
  "first": "John",
  "birthdate": "1963-08-12"
}

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.
This function returns payload with array of Patient data.
It will return APIResponse with "0" return code if patient is found on a practice side. Otherwise refer to result code and description in APIResponse.

Call example (C#):

For the source code of working example see testSearchPatients() method in SageBridgeApiCallExecutor class of SageBrige.API.Tester project can be downloaded here.

Possible return values (see APIResponse )

0 - Success. Description can be vary per function
-1 - General error. Description attribute will show more details about an error
-2 - Function is not supported
500 - Invalid credentials provided
501 - License is expired
502 - License is not active
503 - Token is not active or expired
550 - Unknow functionName or not subscribed
551 - Unknown practice
552 - No Subscription found
553 - Subscription is inactive or expired
600 - Invalid or empty request parameters
601 - No valid route found for this subscription
602 - Unable to parse request parameters

This function may return other codes not listed above; they may vary by practice.

Notes:

All examples of source code and compiled version of SageBridge API can be found here.

Known Issues:

None