Portal Visit Type

Data container to represent visit type information.
PortalVisitType data has following elements:
Name Type Size Desciption
visitTypeid(integer)Unique Visit Type ID (primary key generated by portal when category created, used to update or delete visit type).
visitTypeName(string)50Visit Type name/category.
[appointmentTypes](array)Represents a list of appointment types as used in PM/EMR system.
appointmentType.variationid(integer)Unique appointment type id (primary key generated by portal when appointment type created, used to update or delete appointment type).
appointmentType.apptTypeId(string)50Appointment type identifier as defined in PM/EMR system. Use this value to book an appointment or check appointment type. (required).
appointmentType.description(string)150Visit Type name as used in practice.
appointmentType.abbreviation(string)10Visit Type abbreviation. (optional) (some practices use abbreviation instead of visitTypeId to book appointments).
appointmentType.duration(integer)Default duration of given visit type.
appointmentType.problemOkFlag(string)Problem OK flag (0/1 or N/Y or false/true).
appointmentType.newPatientsFlag(string)New Patients flag (0/1 or N/Y or false/true).
appointmentType.refreactionNeededFlag(string)Refraction Needed flag (0/1 or N/Y or false/true).
appointmentType.filterFlag(string)(0/1 or N/Y or false/true).
appointmentType.appointmentRequestFlag(string)(0/1 or N/Y or false/true).
appointmentType.quickAppointmentFlag(string)(0/1 or N/Y or false/true).
appointmentType.videoVisitFlag(string)(0/1 or N/Y or false/true).
appointmentType.inputNewPatientFlag(string)(0/1 or N/Y or false/true).
appointmentType.inputProblemFlag(string)(0/1 or N/Y or false/true).
appointmentType.inputRefractionFlag(string)(0/1 or N/Y or false/true).
appointmentType.techNeededMinutes(int)Technician duration, if needed. Empty if no technician needed.
appointmentType.techNeededFlag(string)(0/1 or N/Y or false/true).
Notes:
  • apptTypeId is a visit type used by practices as appointment type.
  • Some practices may use abbreviation value to book new appointments.
  • At least a signle appointment type must be defined for a given visit type (required).
  • apptTypeId values can be a same within a given visit type.
  • problemOk, newPatients, refreactionNeeded combination must be unique per visit type.
  • Any of problemOk, newPatients, refreactionNeeded are nullable. null value means it covers both true and false values.
JSON Example:
{
  "visitTypeId": 405,
  "visitTypeName": "Eye Exam",
  "appointmentTypes": [
    {
      "variationId": 1986,
      "apptTypeId": "77",
      "description": "Established Pt Eye Exam",
      "abbreviation": "EVALLAS",
      "duration": "15",
      "problemOkFlag": "false",
      "newPatientsFlag": "false",
      "refractionNeededFlag": "false",
      "filterFlag": "true",
      "appointmentRequestFlag": "false",
      "quickAppointmentFlag": "false",
      "videoVisitFlag": "false",
      "inputNewPatientFlag": "false",
      "inputProblemFlag": "false",
      "inputRefractionFlag": "false",
      "techNeededMinutes": "0",
      "techNeededFlag": "false"
    },
    {
      "variationId": 1987,
      "apptTypeId": "77",
      "description": "Established Pt Eye Exam",
      "abbreviation": "EVALLAS",
      "duration": "15",
      "problemOkFlag": "true",
      "newPatientsFlag": "false",
      "refractionNeededFlag": "false",
      "filterFlag": "true",
      "appointmentRequestFlag": "false",
      "quickAppointmentFlag": "false",
      "videoVisitFlag": "false",
      "inputNewPatientFlag": "false",
      "inputProblemFlag": "false",
      "inputRefractionFlag": "false",
      "techNeededMinutes": "0",
      "techNeededFlag": "false"
    }
  ]
}
XML Example:
See also:
API Functions, API Data, GetPortalVisitTypes function