CheckPatient

function is used to get patient id or refresh patient data

Call example:


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

Request parameters:


Request is a JSON string representing Patient data. It can be simplified depends on needs.

There are two possible ways to use this function.
  • Get patient ID from remote practice. First, last, middle name and birth date parameters are required for this type of request
  • Some implementations do require a phone number to lookup a patient. In such cases contactInfo with phone must be provided as shown below.
  • Get patient information to refresh known patient. Only patientId and birth date parameters are required for this type of request

JSON string request example:
Get patient info for existing patient: 
{
"patientID":"TS01831451",
"birthdate":"01/01/1965",
}
Get patient ID: 
{
"last":"Pistol",
"first":"Peter",
"middle":"",
"birthdate":"01/01/1965",
"contactInfo": {"phone":"8005551212"}
}
Social Security (SSN) is optional parameter for extra verification.
Any other fields and lists in Patient data must be set to NULL.

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.
This function returns payload with 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 testCheckPatient() 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

See Also:

API Functions, APIResponse structure, Patient structure