CheckChangedPatients
Used to retrieve a list of modified patients for certain criterias
Call example:
string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"CheckChangedPatients",
"bos5", // practice Path or Tax ID
"JSON", // output format (XML or JSON)
"--request parameters XML or JSON---" // request parameters
);
Request parameters:
Request parameter JSON string representing set of fields:
| patientIds | (string) | (optional) | Comma-separated list of patient IDs to check appointments for. |
| patientLastModifiedStart | (string) | (required) | Patient modified time from |
| patientLastModifiedEnd | (string) | (required) | Patient modified time to |
Notes:
- Both patientLastModifiedStart and patientLastModifiedEnd parameters are required.
- If patientIds is not provided, then a time range between patientLastModifiedStart and patientLastModifiedEnd cannot exceed 25 hours.
JSON string request example:
{
"patientIds": "123499,280348,2342142,234234,234232,34533333,4444,55534,6563453,2345456,7322365,80416,3907",
"patientLastModifiedStart": "08/14/1916 17:49",
"patientLastModifiedEnd": "08/14/2016 17:49"
}
Response:
XML or JSON string representing APIResponse structure.
APIResponse payload element may be encrypted and delivered as Base64 string.
Payload element of APIResponse is a list of modified appointment IDs
Output parameters:
| patientId | (string) | Patient ID. |
| BirthDate | (string) | Patient BirthDate. |
| ModifyTimestamp | (string) | Appointment modification timestamp. |
JSON Response Example: (Raw JSON )
[
{ "PatientId": "123499", "Birthdate": "09/24/1949", "ModifyTimestamp": "7/11/2016 4:17:58 PM" },
{ "PatientId": "3907", "Birthdate": "07/24/1944", "ModifyTimestamp": "6/23/2016 9:00:59 AM" },
{ "PatientId": "4444", "Birthdate": "07/08/1932", "ModifyTimestamp": "5/4/2016 12:05:01 PM" },
{ "PatientId": "55534", "Birthdate": "07/15/1994", "ModifyTimestamp": "1/4/2013 9:49:44 AM" },
{ "PatientId": "80416", "Birthdate": "04/06/1955", "ModifyTimestamp": "6/23/2016 9:17:18 AM" }
]
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
Known Issues:
None
See Also:
API Functions,
APIResponse structure