Metadata-Version: 2.5
Name: docspera-appointment-agent-contracts
Version: 1.0.0rc1
Summary: Versioned data contracts (pydantic models + JSON Schema) for the DocSpera Appointment Agent
Author: DocSpera
License-Expression: MIT
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: pydantic<3,>=2.7
Description-Content-Type: text/markdown

# docspera-appointment-agent-contracts

Versioned data contracts for the **DocSpera Appointment Agent**: an AI assistant that contacts patients before their appointments by SMS or phone. Patients can ask questions, confirm, reschedule, or reach a person.

A customer integrates by building a *connector* against these contracts:

| Module | Direction | What |
|---|---|---|
| `appointment_v1` | customer → agent | `AppointmentUpserted` / `AppointmentCancelled` events |
| `connector_v1` | agent → customer (sync) | `GetAppointmentContext`, `VerifyIdentity`, `ListOpenSlots`, `RescheduleAppointment`, `GetRescheduleLink` |
| `outreach_v1` | agent → customer | outcome events: confirmed, rescheduled, hand-off, opted out… |
| `config_v1` | operator | tenant defaults and per-facility overrides |

The models are pydantic v2 (`Model.from_wire(dict)` / `model.to_wire()`, camelCase JSON, UTC instants). Matching JSON Schemas (2020-12) are published in the source repository. Within a major version, changes are additive only.

To certify a connector, use `docspera-appointment-agent-conformance`.
