Skip to main content
POST
Disdici un appuntamento

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string

Facoltativa. La stessa chiave entro 24 ore ripete la prima risposta 2xx.

Maximum string length: 255

Path Parameters

id
string<uuid>
required

Identificativo della risorsa.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

L'appuntamento disdetto (o gia' disdetto).

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
patientId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
facilityId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
doctorId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
chairId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
calendarId
string<uuid> | null
required

Il calendario da cui e' nato: le sue regole valgono per spostarlo e disdirlo. null = fuori calendario.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
start
string
required

ISO 8601 con fuso (UTC).

end
string
required

ISO 8601 con fuso (UTC).

status
enum<string>
required
Available options:
draft,
scheduled,
confirmed,
checked_in,
in_progress,
completed,
cancelled,
no_show,
pending,
postponed
type
enum<string> | null
required
Available options:
checkup,
treatment,
consultation,
emergency,
other
category
enum<string> | null
required
Available options:
recall,
treatment_plan,
first_visit,
case_study,
standard
title
string | null
required

Ogni lettura finisce nel registro accessi (testo libero).

reason
string | null
required

Il motivo della visita. Ogni lettura finisce nel registro accessi (testo libero).

origin
enum<string>
required

Da dove e' nato: manual (agenda), bot (WhatsApp), voice (agente vocale), api.

Available options:
manual,
bot,
voice,
api
treatmentPlanId
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
createdAt
string | null
required

ISO 8601 con fuso (UTC).

updatedAt
string | null
required

ISO 8601 con fuso (UTC).

notes
string | null

Solo con lo scope clinical:read (l'accesso finisce nel registro).

clinicalNotes
string | null

Solo con lo scope clinical:read (l'accesso finisce nel registro).

completionNotes
string | null

Solo con lo scope clinical:read.