API reference
The reference contains 79 operations from production Swagger. It includes PAT-enabled operations and the basic health probe. Interactive administration, token management, and upstream diagnostics are excluded from this integration view.
Download OpenAPI 3.1 JSON · Contract provenance · Schemas
Service status
Section titled “Service status”Your account
Section titled “Your account”Workspaces
Section titled “Workspaces”Patients
Section titled “Patients”GETList patientsPOSTCreate patientsGETGet patientsPATCHUpdate patientsDELETEArchive patientsPOSTRestore patientsGETDownload an import template — PatientsPOSTConvert a patient spreadsheet — Patients
Health professionals
Section titled “Health professionals”GETList health professionalsPOSTCreate health professionalsGETGet health professionalsPATCHUpdate health professionalsDELETEArchive health professionalsPOSTRestore health professionals
Saved services
Section titled “Saved services”GETList saved servicesPOSTCreate saved servicesGETGet saved servicesPATCHUpdate saved servicesDELETEArchive saved servicesPOSTRestore saved services
Payers
Section titled “Payers”GETList payersPOSTCreate payersGETGet payersPATCHUpdate payersDELETEArchive payersPOSTRestore payers
Invoice resolutions
Section titled “Invoice resolutions”Credit note resolutions
Section titled “Credit note resolutions”Debit note resolutions
Section titled “Debit note resolutions”RIPS packages
Section titled “RIPS packages”GETGet preparation context — RIPS packagesGETList rips packagesPOSTCreate rips packagesGETGet rips packagesPATCHRevise a package — RIPS packagesDELETEArchive rips packagesPOSTRestore rips packagesPOSTValidate a revision — RIPS packagesGETList dispatch attempts — RIPS packagesPOSTRequest dispatch — RIPS packagesPOSTReconcile an unknown outcome — RIPS packages
Medication catalogs
Section titled “Medication catalogs”GETGet medication catalog metadata — Medication catalogsGETSearch medications — Medication catalogsGETGet a medication — Medication catalogs
Health invoices
Section titled “Health invoices”GETGet preparation context — Health invoicesGETList health invoicesPOSTEmit a health document — Health invoicesGETGet health invoicesPOSTRetry document emission — Health invoicesPOSTReconcile an unknown outcome — Health invoicesGETDownload an artifact — Health invoicesGETExport document data — Health invoicesPOSTSend a document by email — Health invoicesPOSTPrepare the companion RIPS — Health invoices
Credit notes
Section titled “Credit notes”GETList credit notesPOSTEmit a health document — Credit notesGETGet preparation context — Credit notesGETGet credit notesPOSTRetry document emission — Credit notesPOSTReconcile an unknown outcome — Credit notesGETDownload an artifact — Credit notesPOSTSend a document by email — Credit notesPOSTPrepare the companion RIPS — Credit notes
Debit notes
Section titled “Debit notes”GETList debit notesPOSTEmit a health document — Debit notesGETGet preparation context — Debit notesGETGet debit notesPOSTRetry document emission — Debit notesPOSTReconcile an unknown outcome — Debit notesGETDownload an artifact — Debit notesPOSTSend a document by email — Debit notesPOSTPrepare the companion RIPS — Debit notes