GET /emr/amkai/appointments/summary


Get EMR appointment summary records either by id (native EMR id), contact_id (Call Center id), last_name (The last name of the patient) or chart (Amkia Account Number). If a single id is passed, at most one record will be returned (it is also possible to pass an array of id values. If the contact_id is passed it is possible that more than one record is returned since a call center contact can have more than one appointment scheduled. When using the last_name parameter the query might be very slow and return a large number of results (depending on the last name).

This API method fetches data from the remote Amkai database (MSSQL).

One and only one of the following parameters MUST be passed: id, ids, contact_id, last_name, chart

Resource URL

http://www.lsitampa.com/emr/amkai/appointments/summary.{response_format}

Method

GET

Response Format

json csv

Parameters

id - optional
The id of the emr appointment record to retreive. In the EMR system this id is the value of scheduling_abstractappointment.abstractscheduleissue_id. This parameter accepts either a single integer value or a semicolon separated list of integer values.
ids - optional
The ids of the emr appointment records to retreive. In the EMR system this id is the value of scheduling_abstractappointment.abstractscheduleissue_id. This is a main parameter.
contact_id - optional
The contact_id of the emr appointment record to retreive. In the EMR system this id is the value of reg_externalid.externalid. This is a main parameter.
last_name - optional
The last_name of the emr appointment record to search for and retreive. In the EMR system last_name is the value of reg_person.lastname. This is a main parameter.
chart - optional
The chart of the emr appointment record to search for and retreive. In the EMR system chart is the value of reg_account.accountnumber. This is a main parameter.
from_date - optional
The from_date of the emr appointment record to search for and retreive. In the EMR system from_date is the value of dbo.scheduling_abstractappointment.bt This is a mail parameter.
to_date - optional
The to_date of the emr appointment record to search for and retreive. In the EMR system to_date is the value of dbo.scheduling_abstractappointment.bt. If from_date is used and to_date isn't, to_date equals from_date
pay_class - optional
The pay_class of the emr appointment record to search for and retreive. In the EMR system pay_class is the value of dbo.di_item.name. Requires a main parameter
appt_type - optional
The appt_type of the emr appointment record to search for and retreive. In the EMR system appt_type is the value of dbo.di_item.name. Requires a main parameter, possible values are SX, CONSULT & TRIAGE, if null returns all three.
debug - optional
Used for debugging purposes
jsonp_callback - optional
If making cross domain Ajax calls use this as the call-back method name in your Ajax request.

HTTP Errors

400
{
  "error": {
    "code": 400,
    "message": "Bad request (if set by the developer, specific reason for bad request)"
  }
}
404
{
  "error": {
    "code": 404,
    "message": "Not found"
  }
}
500
{
  "error": {
    "code": 500,
    "message": "Internal Server Error"
  }
}