webhookHmac.
For whom
- Hospital/insurer integrators (interoperability team)
- Product teams defining the appointment flow
Main flows
1) Get benefits/services (catalog of reasons/consultations)
- Route:
webhooks > appointment.getBenefits - Input:
collectiveId(insurance ID for filtering if needed),centerId,serviceId - Usage: prepares the catalog to calculate available slots.
2) Get available slots
- Route:
webhooks > appointment.getSlots - Input:
benefitId,centerId,serviceId,collectiveId,fromDateEpoch, … - Usage: present options to patients during the conversation.
3) Create appointment
- Route:
webhooks > appointment.create - Input:
slot,patientId,benefitId - Output:
appointmentId,status
4) Cancel appointment
- Route:
webhooks > appointment.cancel - Input:
appointmentId,reason
5) Mark appointment as pending reschedule (WIP)
- Route:
webhooks > appointment.reschedulePending
6) List a patient’s appointments
- Route:
webhooks > appointment.getList
7) Directories
directory.centersanddirectory.professionals
8) Patient authentication/onboarding
patient.authenticateandpatient.onboard
Sequence: appointment request and creation (inbound call)
Examples (illustrative)
These routes are webhooks that MarIA invokes towards your HIS. Shown only to illustrate expected payloads.
appointment.create (MarIA request to your HIS)
appointment.getSlots
Integration recommendations
- Always respond with
200and a valid body; use 4xx for validations. - Traceability: include
appointmentIdandpatientIdin logs. - Idempotency for
appointment.createusing arequestIdif applicable. - Timezones: use UTC and ISO 8601 formats.
Production checklist
- Pre-production environment with anonymized data.
- Latency and error rate monitoring per endpoint.
- PII retention/masking in logs.