CancelAppointment

function is used to cancel scheduled appointment.

Call example:


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

Request parameters:

request parameter is JSON string representing set of fields:
appointmentId(string)Appointment Id to confirm
patientdob(string)Patient Birth Date
patientId(string)Patient Id
reason(string)Cancel reason. Default value provided in GetAvailablePractices function output
notes(string)Free text with cancellation notes
facilityId(string)Location Id to Cancel Appointment (for multi-location practices only. Contact Sophrona support for more explanations.)

Both extpatientId and patientdob parameters must be provided for validation purpose.
JSON string request example: 
{
"appointmentid":"66536",
"patientdob":"6/2/1981",
"patientid":"CL01831451",
"reason":"BC27E1DF-6A0F-42D3-AD54-76F4EEE551C7",
"notes":"I am unable to keep this appointment b/c of car problems.",
"facilityId":"6EEAD924-6310-470D-94AC-85F370D23FAF"
}

Response:

XML or JSON string representing APIResponse structure.

APIResponse payload element may be encrypted and delivered as Base64 string.
This function returns empty payoad. See APIResponse result code and description for a result of operation

Call example (C#):

For the source code of working example see testCancelAppointment() 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