SageBridge API - GetChangedAppointments function

GetChangedAppointments

Used to retrieve a list of modified appointments for certain criterias

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"GetChangedAppointments",                    
"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 get appointments for.
appointmentIds	(string)	(optional)	Comma-separated list of appointment IDs to get.
apptLastModifiedStart	(string)	(required)	Appointment modified time from.
apptLastModifiedEnd	(string)	(required)	Appointment modified time to.
appStartDate	(string)	(optional)	Appointment Start datetime.
appEndDate	(string)	(optional)	Appointment End datetime.
facilityIds	(string)	(optional)	Comma-separated list of locations.
appTypes	(string)	(optional)	Comma-separated list of appointment types.
providerIds	(string)	(optional)	Comma-separated list of providers.
retrieveCancelled	(string)	(optional)	(Y/N/) Include cancelled appointments.
newPatientsOnly	(string)	(optional)	(Y/N/) Appointments for a new patients only.
onePerPatient	(string)	(optional)	(Y/N/) Inlcude only one appointment per patient.
patientDob	(string)	(optional)	Patient DOB.

Notes:

Either patientIds or appointmentIds are required.
Both apptLastModifiedStart and apptLastModifiedEnd parameters are required.

One of patientIds or appointmentIDs is required.

JSON string request example:

{
    "appStartDate": null,
    "appEndDate": null,
    
    "patientIds": "123499,280348,2342142,234234,234232,34533333,4444,55534,6563453,2345456,7322365,80416,3907",
    "apptLastModifiedStart": "07/28/1916 18:47",
    "apptLastModifiedEnd": "07/28/2016 18:47" ,
    "appointmentIds": null,
    "patientDob": null,
    "facilityIds": null,
    "appTypes": null,
    "providerIds": null,
    
    "onePerPatient": "N",
    "newPatientsOnly": "N",
    "retrieveCancelled": "Y"
}

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 appointments

JSON Response Example: (Raw JSON )

    
[
  {
    "appointmentId": "16368",
    "encounterId": "",
    "apptTypeId": "08be3c18-6533-44ce-8076-4bea7867467c",
    "apptTypeName": "Annual Exam",
    "status": "C",
    "facilityId": "13c69063-dd37-45e0-b1d5-2fff6d9f300f",
    "facilityName": "Brookline Boston Eye Group",
    "providerId": "296b5d2f-c26f-48d1-ade6-fc5a672b8865",
    "providerName": "Mahnaz Nouri MD",
    "patientId": "4444",
    "apptStart": "01/16/2008 10:30",
    "apptStop": "01/16/2008 10:35",
    "notes": "Annual Exam",
    "lastModified": "1/16/2008 10:34:19 AM",
    "lastModifiedBy": null,
    "first": "Frank",
    "middle": "",
    "last": "Hubert",
    "EMailAddress": "lol13@comcast.net",
    "birthdDate": "07/08/1932",
    "primaryPhone": null,
    "primaryExt": null,
    "homePhone": "5084771212",
    "workPhone": null,
    "workExt": null,
    "sex": "M",
    "ownerId": "4444",
    "apptKind": null,
    "addr1": "22 Main Circle",
    "addr2": null,
    "city": "Mashpee",
    "state": "MA",
    "zip": "02649",
    "vipFlag": "0",
    "referralComanage": "C"

  },
  {
    "appointmentId": "20499",
    "encounterId": "",
    "apptTypeId": "d35caaab-4e33-49fb-8129-4d1e154b2c4c",
    "apptTypeName": "Follow Up-Old",
    "status": "C",
    "facilityId": "13c69063-dd37-45e0-b1d5-2fff6d9f300f",
    "facilityName": "Brookline Boston Eye Group",
    "providerId": "b9b2120b-2d79-43ad-a85b-1274062e7183",
    "providerName": "Lashkari, Kameran MD",
    "patientId": "4444",
    "apptStart": "02/08/2008 14:20",
    "apptStop": "02/08/2008 14:25",
    "notes": "Follow Up-Old",
    "lastModified": "2/8/2008 2:03:19 PM",
    "lastModifiedBy": null,
    "first": "Frank",
    "middle": "",
    "last": "Hubert",
    "EMailAddress": "lol13@comcast.net",
    "birthdDate": "07/08/1932",
    "primaryPhone": null,
    "primaryExt": null,
    "homePhone": "5084771212",
    "workPhone": null,
    "workExt": null,
    "sex": "M",
    "ownerId": "4444",
    "apptKind": null,
    "addr1": "22 Main Circle",
    "addr2": null,
    "city": "Mashpee",
    "state": "MA",
    "zip": "02649",
    "vipFlag": "1",
    "referralComanage": "O"

  }
]

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