PostPatientAppointments

Used to post patient appointmens.

Call example:


string result = SageBridgeAPI.executeAPICall(
"cf389659-588c-4fd9-ab9e-7c37b438905c", // security token
"PostPatientAppointments",                    
"bos5",                                 // practice Path or Tax ID
"JSON",                                 // output format (XML or JSON)
"--request parameters XML or JSON---"   // request parameters
);
Request:JSON or XML serialized PostPatientAppointmentsRequest data.
Response: APIResponse with payload representing PostPatientAppointmentsResponse data.

Notes:

Request example:


{ 
  "patientInfo": {
    "patientID": "A2016103XXX",
    "last": "Likestocook",
    "first": "Alex",
    "middle": null,
    "birthdate": "01/01/1970",
    "sex": "M",
    "contactInfo": {
      "phone": "8005551212",
      "cell": "9145551212",
      "email": "noemail@dadada.com",
      "cellOptIn": "true",
      "emailOptIn": "true"
    }
  },
  "appointments": [
    {
      "AppointmentId": "appt123",
      "PatientId": "A2016103XXX",
      "ApptTypeId": "followup",
      "Status": "S",
      "FacilityId": "office1",
      "ProviderId": "134",
      "ApptStart": "09/18/2017 10:15",
      "ApptStop": "09/18/2017 10:30",
      "Notes": "Just time to follow up appointment"
    },
    {
      "AppointmentId": "appt333c",
      "PatientId": "A2016103XXX",
      "ApptTypeId": "surgery",
      "Status": "S",
      "FacilityId": "office1",
      "ProviderId": "134",
      "ApptStart": "09/21/2017 11:15",
      "ApptStop": "09/21/2017 11:30",
      "Notes": "Just time to follow up appointment"
    }
  ]
}

Response example:

For details aboout logs see APILog data. 
{
    "code": 0,
    "message": "success",
    "level": 0,

  "logs": [
    { "itemTypeId": 102, "itemId": "appt123", "code": 0, "message": "Appointment Posted", "level": 0 },
    { "itemTypeId": 102, "itemId": "appt333", "code": 0, "message": "Appointment Posted", "level": 0 }
  ]
}

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

Notes:

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

Known Issues:

None

See Also:

API Functions, APIResponse structure, PostPatientAppointmentsRequest data , PostPatientAppointmentsResponse data