Skip to main content

PushTypes

Description

A PushTypes message is used to convey a list of appointment types from another system to an EHR or scheduling system. The appointment types represent different types of appointments that can be scheduled, such as new patient appointment, follow-up appointment, or specialty consultation, etc.

API endpoints for PushTypes

Sync REST API Endpoint to call the API: https://{base_url}/api/v1/scheduling/push-types.

Async REST API Endpoint to call the API: https://{base_url}/api/v1/endpoint.

Data Model JSON for PushTypes​

PushTypes - Sample Payload
{
    "Meta": {
        "DataModel": "Scheduling",
        "EventType": "PushTypes",
        "Test": true,
    "Source": {
    "ID": "a1ac9e62-7fe7-4781-a9d8-0460492765df",
    "Name": "CustomerID"
    }
 },
    "Appointment": {
        "AppointmentTypeName": "Office Visit Test Type",
        "Duration": 5,
        "Generic": true,
        "AppointmentTypeShortName": "OVTT",
        "Patient": true,
        "TemplateTypeOnly": null
     }
}