Version: Current

Changelog, versioning and deprecation

Versioning

The API is versioned in the path: /api/v1/.... Breaking changes go to a new version (/api/v2), never breaking v1 in production.
The contract is additive: new response fields may be added at any time — handle unknown fields tolerantly. Internal engine/rule versions are in analysis_metadata.source_versions.
schema_version identifies the response contract (v2).

Features to be removed are announced here with at least 90 days notice and start returning the Deprecation header (RFC 8594) with the sunset date.
Admin endpoints remain documented in the Admin Swagger (/docs/admin), separate from the client routes.

FHIR R4 (POST /fhir/$check): Bundle → RiskAssessment + DetectedIssue; profiles MedicationRequest/Statement, Condition, AllergyIntolerance, Observation, Patient, Encounter, DiagnosticReport, Practitioner.
CDS Hooks (/cds-services): medication-prescribe and order-select with cards.
HL7 v2 (POST /hl7v2/$check): MSH/PID/AL1/DG1/RXO/RXE/RXR/OBX.
Batch (POST /interactions/batch, up to 25 items).
Idempotency (Idempotency-Key) on check/batch/fhir/hl7v2/cds.
Webhooks: delivery with up to 3 attempts + log + replay (admin).
Structured clinical contract (UCUM): dose+dose_unit (incl. mg/kg, mg/m2), form/concentration/duration/indication and DCB/ATC/RxNorm/GTIN codes; clinical_context_assessment block (completeness + residual risk).
Transactional semantics: response with request_id, replayed_request, billing_status; idempotent replay is not charged; GET /analyses/{id}/status.
Sandbox: sm_test_ keys are not billed (billing_status: "not_charged").
Dev: Python and Node SDKs, Postman collection, System flows page.

Alert governance (P2): alert_governance block, physician × pharmacist views, critical confirmation, "alerts that changed conduct" metric, dashboard/ROI (admin).
Clinical engine (P1): clinical_alerts (12 deterministic validations) + offline safety net.