Entwicklerplattform · API v1

Erstellen Sie mit der FastClinic-API.

Entdecken Sie die synthetische Live-Demo über eine typisierte, versionierte API mit öffentlichen Lesevorgängen und tokengesteuerten Vorgängen.

Zugriff auf die öffentliche Vorschau. Synthetische klinische und aggregierte GET-Endpunkte erfordern keine Authentifizierung. Für operative Lesevorgänge und alle Schreibvorgänge ist FASTSME_API_TOKEN erforderlich. Sie geben 503 zurück, wenn es nicht konfiguriert ist. Aktivierte Clients senden Authorization: Bearer <token>.

Vollständige API-Oberfläche

Klinische Aufzeichnungen

Patienten, Parteien, Erziehungsberechtigte und Kostenträger, Konsultationen, Diagnosen, Behandlungen und validierte Bearbeitung von Notizen.

GETPOSTPATCHDELETE
/api/v1/patientsPatienten-CRUD; Archive LÖSCHENÖffentliches Lesen · Token-Schreiben
GETPOSTPATCHDELETE
/api/v1/partiesPartei CRUD; Verlinkte Parteien können nicht gelöscht werdenÖffentliches Lesen · Token-Schreiben
GETPOSTPATCHDELETE
/api/v1/relationshipsVormunds-, Selbst-, Zahler-, Familien- und NotfallrollenÖffentliches Lesen · Token-Schreiben
GET
/api/v1/consultations · /diagnoses · /treatmentsImportierte klinische TätigkeitÖffentliche synthetische Lektüre
GETPOSTPATCHDELETE
/api/v1/notesValidierter Notizlebenszyklus; Archive LÖSCHENÖffentliches Lesen · Token-Schreiben

Terminplanung

Verfügbarkeit, Ärzte, konfliktsichere Buchung, Umplanung, Statusänderungen und Stornierung.

GET
/api/v1/clinicians · /availabilityBuchbare ArzttermineÖffentliche Lesung
GETPOSTPATCHDELETE
/api/v1/appointmentsKonfliktsicherer TerminlebenszyklusÖffentliches Lesen · Token-Schreiben
GETPOST
/api/v1/external/*FastBooking-Verfügbarkeit und idempotente ReservierungenFastBooking-Token

Mobile Patienten-App

MedBackend OAuth/PKCE-Identität, Bootstrap für eigene Datensätze, Konversationsbuchung und Terminlebenszyklus.

GET
/api/v1/mobile/me · /bootstrapAuthentifizierte Profil- und App-StartdatenMedBackend OAuth-Token
GET
/api/v1/mobile/availabilityPatientensichere Live-VerfügbarkeitMedBackend OAuth-Token
GETPOST
/api/v1/mobile/appointmentsEigene Termine und deterministische BuchungMedBackend OAuth-Token
POST
/api/v1/mobile/booking/chatLangGraph-BuchungsgesprächMedBackend OAuth-Token
GET
/api/v1/mobile/recordsEigene FHIR R4-Datensätze in JSON oder XMLMedBackend OAuth-Token

Aktivierung & Kommunikation

Nach Einwilligung gefilterte Rückruflisten, dauerhafte Erinnerungen, unveränderliche Zustellungsprotokolle und Ergebniszuordnung.

GET
/api/v1/activation/due · /lapsed · /followupEinwilligungsgefilterte AktivierungskohortenToken erforderlich
GETPOSTPATCHDELETE
/api/v1/remindersErinnerungslebenszyklus; DELETE bricht abToken erforderlich
GETPOST
/api/v1/communicationsEinwilligungsgesteuerte SMS/E-Mail und unveränderliche ProtokolleToken erforderlich
GETPATCH
/api/v1/parties/{id}/marketing-consentMarketing-Opt-out-StatusToken erforderlich

Abrechnung und Hauptbuch

Idempotente Rechnungsstellung, Zahlungen und Rückerstattungen, Stornierungen durch Stornieren von Journalen und ausgeglichene Hauptbuchberichte.

GETPOSTPATCHDELETE
/api/v1/invoicesRechnungslebenszyklus; Mit DELETE wird eine Stornobuchung durchgeführtToken erforderlich
GETPOSTDELETE
/api/v1/paymentsIdempotente Quittungen; DELETE sendet eine RückerstattungToken erforderlich
GET
/api/v1/ledger · /trial-balanceUnveränderliches Tagebuch und SaldenToken erforderlich

Analytik und Audit

Dieselben Betriebsansichten, die von den Dashboards verwendet werden, plus ein API-Mutationspfad nur zum Anhängen.

GET
/api/v1/analytics/*Überblick, Umsatz, Fachgebiete, Verfahren, Demografie und ÄrzteÖffentliche synthetische Lektüre
GET
/api/v1/auditNur anfügbare API-MutationsdatensätzeToken erforderlich
GET
/api/v1/healthVersions- und SchreibbereitschaftsstatusÖffentliche Lesung

FHIR R4 & country adapters

Vanilla R4 plus ausfallsichere nationale Adapter-Sandboxen für Großbritannien, Litauen und Estland.

GET
/api/v1/fhir/metadataCapabilityStatementÖffentliche Lesung
GET
/api/v1/fhir/{type}/{id}Single resource readPublic clinical · token for ops
GET
/api/v1/fhir/Patient/{id}/$everythingSubject bundlePublic clinical · token adds ops
POST
/api/v1/fhir/$validateStructural validationPublic
POST
/api/v1/fhir/$importMap a resource onto the coreToken erforderlich
GETPOST
/api/v1/adapters/GB/*NHS Number, UK Core export, STU3, remindersPublic map · token for ops
GETPOST
/api/v1/adapters/LT/*Synthetischer Sandkasten ESPBI, IPR und eLab R5Öffentliches Spiel · Token-Einreichung
GETPOST
/api/v1/adapters/EE/*TIS CDA, MPI R5 und X-Road synthetischer SandkastenÖffentliches Spiel · Token-Einreichung

Clinical workspace

Writable encounters, SOAP notes, diagnostic/medication orders, tasks, coverage, and in-app messages.

GETPOST
/api/v1/chart/encountersOpen a chart encounterToken erforderlich
POST
/api/v1/chart/encounters/{id}/finishFinish an encounterToken erforderlich
GETPOST
/api/v1/chart/notesSOAP notesToken erforderlich
GETPOSTPATCH
/api/v1/ordersLab, imaging, referral, medication ordersToken erforderlich
GETPOSTPATCH
/api/v1/care-tasksCare-coordination tasksToken erforderlich
GETPOST
/api/v1/coverageInsurance / payor coverageToken erforderlich
GETPOST
/api/v1/messagesIn-clinic message threadsToken erforderlich

Klinische Leseressourcen

Patienten

Synthetische Patientendaten und Registrierungsdatensätze. DELETE archiviert ein klinisches Subjekt, anstatt es zu löschen.

GET /api/v1/patientsGET /api/v1/patients/{id}

Partys

Kontaktierbare oder zahlungspflichtige Parteien, getrennt von den Pflegepersonen im Hinblick auf Vormundschaft, Einwilligung und Zuweisung des Kostenträgers.

GET /api/v1/partiesGET /api/v1/parties/{id}

Beratungen

Synthetische Beratungsaktivität und Einnahmen. Abgeleitete/importierte Datensätze sind schreibgeschützt.

GET /api/v1/consultationsGET /api/v1/consultations/{id}

Behandlungen

Kostenpflichtige Behandlungslinien, geordnet nach Kategorie und Fachgebiet. Abgeleitete/importierte Datensätze sind schreibgeschützt.

GET /api/v1/treatmentsGET /api/v1/treatments/{id}

Diagnosen

Synthetische Diagnoseaufzeichnungen im Zusammenhang mit Konsultationen. Importierte klinische Fakten sind schreibgeschützt.

GET /api/v1/diagnosesGET /api/v1/diagnoses/{id}

Klinische Hinweise

Synthetische klinische Notizen. Bei Schreibvorgängen wird eine dedizierte Validierung und Archivierung anstelle eines harten Löschens verwendet.

GET /api/v1/notesGET /api/v1/notes/{id}

Schnellstart

# Public synthetic read
curl "https://fastclinic.dev/api/v1/patients?limit=20"

# Token-authenticated, idempotent payment
curl -X POST "https://fastclinic.dev/api/v1/payments" \
  -H "Authorization: Bearer $FASTSME_API_TOKEN" \
  -H "Idempotency-Key: payment-your-stable-id" \
  -H "Content-Type: application/json" \
  -d '{"invoice_id": 7001, "amount": 25.00, "method": "card"}'

DELETE ist domänenbewusst: Patienten und Notizen werden archiviert, Termine und Erinnerungen storniert, Rechnungen mit Stornobuchungen storniert und Zahlungen zurückerstattet. Kommunikations- und Hauptbuchaufzeichnungen bleiben unveränderlich.

Laufzeit-OpenAPI: /api/openapi.json · Stabiles Kompatibilitätsschema: /swagger.json · Interaktive Dokumente: /api/docs