🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

Changed from v3.0.0: Adds request fields appointment_type.display_name, appointment_type.ehr_appt_descriptor_ids; removes request field appointment_type.emr_appt_descriptor_ids; adds response fields data.active, data.data_source_id, data.display_name, data.foreign_id (+2 more).

This endpoint creates a new appointment type; by default it is scoped to the institution, but is scoped to a specific location when location-level appointment types are enabled for the institution (by the NexHealth team) and the top-level location_id param is provided. Client-supplied parent_type is ignored on create.

{
  "appointment_type": {
    "display_name": "Hygiene visit"
  }
}

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 1,
    "name": "Medical",
    "parent_type": "Institution",
    "parent_id": 1,
    "minutes": 15,
    "display_name": "Hygiene visit",
    "source": "manual",
    "active": true,
    "foreign_id": "42",
    "data_source_id": 7,
    "working_hour_ids": [
      10,
      11
    ]
  },
  "count": 2
}