iSalusSchedule.CreateAppointment

The iSalusSchedule.CreateAppointment webservice allows an appointment to be created and/or updated.  

Sample Request

<request>
    <security>
        <key>Client_ID~Password~Company_ID</key>
        <version>1.0</version>
        <userid />
        <account>REDACTED</account>
    </security>
    <appointment_id>-1</appointment_id>
    <resource_eid>37333</resource_eid>
    <patient_id>24928</patient_id>
    <appointment_type_id>2</appointment_type_id>
    <start_date_time>08/07/2020 08:00am</start_date_time>
    <end_date_time>08/07/2020 08:30am</end_date_time>
    <chief_complaint>Cough complaint</chief_complaint>
    <comment>Call to confirm</comment>
    <referring_eid></referring_eid>
    <prior_authorization>4839SS</prior_authorization>
    <service_location_eid>37349</service_location_eid>
</request>

Request

The Request element will serve as a wrapper for the entire body of the XML request.

Request > Security

See documentation for the Security node here:  Access to Webservices

Request > Appointment_ID

  • New Appointments: When creating a brand new appointment, the appointment ID should be set to -1.  
  • Updating Appointments: The internal ID for the appointment that needs updated.

Request > Resource_EID

The entity_ID (internal ID) for the resource that the appointment will be scheduled with.

Request > Patient_ID

The patient chart number (internal ID) of the patient that the appointment will be scheduled for.

Request > Appointment_Type_ID

The internal ID for the appointment type that will be set for the appointment.

Request > Start_Date_Time

The start date and start time of the appointment.  Note, the time is assumed to be correct based on the local time zone of the client.  Formatted as "MM/DD/YYYY HH:MMpm/am".

Request > End_Date_Time

The end date and end time of the appointment.  Note, the time is assumed to be correct based on the local time zone of the client.  Formatted as "MM/DD/YYYY HH:MMpm/am".

Request > Chief_Complaint

The chief complaint for the appointment.

Request > Comment

The comment for the appointment.

Request > Referring_EID

The entity_id for the referring provider on the appointment. 

Request > Prior_Authorization

The prior authorization number for the appointment.

Request > Service_Location_Eid

The entity_Id (internal ID) for the service location where the appointment is to be scheduled at.

Sample Response

Appointment Created/Updated: An appropriate appointment Id will be returned.

<response xmlns="http://www.isalushealthcare.webservices/">
    <appointment_id>84070</appointment_id>
</response>

Error:  When there is an error retrieving the results, an <Error> node will be returned with the appropriate code and description of the error.

<response xmlns="http://www.isalushealthcare.webservices/">
    <error>
        <code>1</code>
        <description>Invalid patient</description>
    </error>
</response>

Response

The Response element will serve as a wrapper for the entire body of the XML response.

Response > Appointment_id

The appointment Id associated with the updated or created appointment.