---
title: "Create an appointment"
method: POST
path: "/healthcare/{connection_id}/appointment"
tags: ["healthcare", "appointment"]
---

# Create an appointment

`POST /healthcare/{connection_id}/appointment`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/healthcare/{connection_id}/appointment`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- HealthcareAppointment
  - `id` string: Unique identifier for the appointment
  - `created_at` string, date-time: When the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: When the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `patient_id` string: The patient attending the appointment
  - `practitioner_ids` string[]: The practitioners participating in the appointment
  - `location_id` string: Where the appointment takes place
  - `slot_ids` string[]: The schedule slots this appointment occupies
  - `status` 'PROPOSED' | 'PENDING' | 'BOOKED' | 'ARRIVED' | 'CHECKED_IN' | 'FULFILLED' | 'CANCELLED' | 'NOSHOW' | 'WAITLIST' | 'ENTERED_IN_ERROR' | 'OTHER': Status of the appointment
  - `start_at` string, date-time: When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `end_at` string, date-time: When the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `description` string: Short description shown on the appointment
  - `service_types` HealthcareCode[]: Codings for the service/visit type being booked
    - `system` string: The code system URI (e.g. http://loinc.org, http://snomed.info/sct)
    - `code` string: The code within the system
    - `display` string: Human-readable display text for the code
  - `reasons` HealthcareCode[]: Codings for the reason for the visit
    - `system` string: The code system URI (e.g. http://loinc.org, http://snomed.info/sct)
    - `code` string: The code within the system
    - `display` string: Human-readable display text for the code
  - `cancellation_reason` string: Why the appointment was cancelled
  - `notes` string: Free-text notes or comments
  - `metadata` HealthcareMetadata[]: Custom field values
    - `id` string: Identifier of the custom field
    - `value` unknown
    - `namespace` string: The scope or origin of the custom field
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'ARRAY' | 'OBJECT': The data type of the value
    - `extra_data` unknown
    - `slug` string: The custom field key
  - `raw` unknown

## Response `200`

Successful

- HealthcareAppointment
  - `id` string: Unique identifier for the appointment
  - `created_at` string, date-time: When the appointment was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: When the appointment was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `patient_id` string: The patient attending the appointment
  - `practitioner_ids` string[]: The practitioners participating in the appointment
  - `location_id` string: Where the appointment takes place
  - `slot_ids` string[]: The schedule slots this appointment occupies
  - `status` 'PROPOSED' | 'PENDING' | 'BOOKED' | 'ARRIVED' | 'CHECKED_IN' | 'FULFILLED' | 'CANCELLED' | 'NOSHOW' | 'WAITLIST' | 'ENTERED_IN_ERROR' | 'OTHER': Status of the appointment
  - `start_at` string, date-time: When the appointment starts (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `end_at` string, date-time: When the appointment ends (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `description` string: Short description shown on the appointment
  - `service_types` HealthcareCode[]: Codings for the service/visit type being booked
    - `system` string: The code system URI (e.g. http://loinc.org, http://snomed.info/sct)
    - `code` string: The code within the system
    - `display` string: Human-readable display text for the code
  - `reasons` HealthcareCode[]: Codings for the reason for the visit
    - `system` string: The code system URI (e.g. http://loinc.org, http://snomed.info/sct)
    - `code` string: The code within the system
    - `display` string: Human-readable display text for the code
  - `cancellation_reason` string: Why the appointment was cancelled
  - `notes` string: Free-text notes or comments
  - `metadata` HealthcareMetadata[]: Custom field values
    - `id` string: Identifier of the custom field
    - `value` unknown
    - `namespace` string: The scope or origin of the custom field
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'ARRAY' | 'OBJECT': The data type of the value
    - `extra_data` unknown
    - `slug` string: The custom field key
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)