Skip to Content
ReferenceAPIAppointmentsCreate an appointment

Appointments API

Create an appointment

Create an appointment in the current workspace.

POST/v1/appointments
capability appointments.create · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

  • patientIdstring<uuid>required
    body
  • offeringIdstring<uuid>required
    body
  • startsAtstring<date-time>required
    body
  • endsAtstring<date-time>required
    body
  • assignmentsobject[]required
    bodymin items 1max items 24
    • requirementIdstring<uuid>required
    • resourceIdstring<uuid>required
    • kind"person" | "site" | "room" | "equipment"required
    • practitionerIdstring<uuid> | nullrequired
    • startsAtstring<date-time>required
    • endsAtstring<date-time>required
  • reasonstring | null
    bodydefault nullmax length 240

Response

Successful responses use Dawn's data envelope.

  • dataAppointmentrequired
    • idstring<uuid>required
    • workspaceIdstring<uuid>required
    • patientIdstring<uuid>required
    • practitionerIdstring<uuid>required
    • offeringIdstring<uuid>required
    • resourceIdsstring<uuid>[]required
      default []max items 12
    • assignmentsobject[]required
      default []max items 24
      • requirementIdstring<uuid>required
      • resourceIdstring<uuid>required
      • kind"person" | "site" | "room" | "equipment"required
      • practitionerIdstring<uuid> | nullrequired
      • startsAtstring<date-time>required
      • endsAtstring<date-time>required
    • startsAtstring<date-time>required
    • endsAtstring<date-time>required
    • status"scheduled" | "checked_in" | "in_progress" | "completed" | "cancelled" | "no_show"required
    • reasonstring | nullrequired
      max length 240
    • createdAtstring<date-time>required
    • updatedAtstring<date-time>required
  • metaobject

Errors

Error responses use the shared error envelope.

  • 403Scheduling is disabled or the patient record is unavailable.
  • 409The requested appointment time is unavailable.
  • 422The appointment details are invalid.
  • 503The appointment could not be saved.
Last updated on