Skip to main content
POST
Crea un appuntamento fuori calendario

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string
required

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

Maximum string length: 255

Body

application/json
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>
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>
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})$
start
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
end
string<date-time>
required

Dopo start, entro 12 ore.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
chairId
string<uuid>

Deve stare nella sede.

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})$
status
enum<string>
default:scheduled
Available options:
draft,
scheduled,
confirmed
type
enum<string>
Available options:
checkup,
treatment,
consultation,
emergency,
other
title
string
Required string length: 1 - 200
reason
string
Maximum string length: 2000
notes
string
Maximum string length: 5000
origin
enum<string>
default:api
Available options:
api,
voice

Response

L'appuntamento creato.

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.