Utviklerplattform 路 API v1

Bygg med FastClinic API.

Utforsk den levende syntetiske demoen gjennom en maskinskrevet, versjonert API med offentlige lesninger og token-gatede operasjoner.

Offentlig forh氓ndsvisningstilgang. Syntetiske kliniske og aggregerte GET-endepunkter krever ingen autentisering. Operasjonelle lesinger og alle skrivinger krever FASTSME_API_TOKEN; de returnerer 503 n氓r den ikke er konfigurert. Aktiverte klienter sender Authorization: Bearer <token>.

Komplett API-overflate

Kliniske journaler

Pasienter, parter, foresatte og betalere, konsultasjoner, diagnoser, behandlinger og validert notatredigering.

GETPOSTPATCHDELETE
/api/v1/patientsPasient CRUD; SLETT arkiverOffentlig lesing 路 token-skriving
GETPOSTPATCHDELETE
/api/v1/partiesParty CRUD; tilknyttede parter kan ikke slettesOffentlig lesing 路 token-skriving
GETPOSTPATCHDELETE
/api/v1/relationshipsVerge-, selv-, betaler-, familie- og n酶drollerOffentlig lesing 路 token-skriving
GET
/api/v1/consultations 路 /diagnoses 路 /treatmentsImportert klinisk aktivitetOffentlig syntetisk lesning
GETPOSTPATCHDELETE
/api/v1/notesValidert notat livssyklus; SLETT arkiverOffentlig lesing 路 token-skriving

Planlegging

Tilgjengelighet, klinikere, konfliktsikker booking, omlegging, statusoverganger og kansellering.

GET
/api/v1/clinicians 路 /availabilityBookbare tidsplaner for klinikereOffentlig lesning
GETPOSTPATCHDELETE
/api/v1/appointmentsKonfliktsikker avtalelivssyklusOffentlig lesing 路 token-skriving
GETPOST
/api/v1/external/*FastBooking tilgjengelighet og idempotente reservasjonerFastBooking-token

Mobil pasientapp

MedBackend OAuth/PKCE-identitet, egen oppstartstrap, samtalebestilling og avtalelivssyklus.

GET
/api/v1/mobile/me 路 /bootstrapAutentisert profil og app-oppstartsdataMedBackend OAuth-token
GET
/api/v1/mobile/availabilityPasientsikker live tilgjengelighetMedBackend OAuth-token
GETPOST
/api/v1/mobile/appointmentsEgne avtaler og deterministisk bookingMedBackend OAuth-token
POST
/api/v1/mobile/booking/chatLangGraph bestillingssamtaleMedBackend OAuth-token
GET
/api/v1/mobile/recordsEgne FHIR R4-poster i JSON eller XMLMedBackend OAuth-token

Aktivering og kommunikasjon

Samtykkefiltrerte tilbakekallingslister, vedvarende p氓minnelser, uforanderlige leveringslogger og resultatattribusjon.

GET
/api/v1/activation/due 路 /lapsed 路 /followupSamtykkefiltrerte aktiveringskohorterToken kreves
GETPOSTPATCHDELETE
/api/v1/remindersP氓minnelse livssyklus; SLETT avbryterToken kreves
GETPOST
/api/v1/communicationsSamtykkesperret SMS/e-post og uforanderlige loggerToken kreves
GETPATCH
/api/v1/parties/{id}/marketing-consentMarkedsf酶ringsopt-out-tilstandToken kreves

Fakturering og reskontro

Idempotent fakturering, betalinger og refusjoner, ugyldigheter gjennom reverseringsjournaler og balansert regnskapsrapportering.

GETPOSTPATCHDELETE
/api/v1/invoicesFaktura livssyklus; SLETT legger inn en ugyldig reverseringToken kreves
GETPOSTDELETE
/api/v1/paymentsIdempotente kvitteringer; SLETT legger inn en refusjonToken kreves
GET
/api/v1/ledger 路 /trial-balanceUforanderlig journal og saldoerToken kreves

Analyse og revisjon

De samme operasjonelle visningene som brukes av dashbordene, pluss en API-mutasjonsspor som bare kan legges til.

GET
/api/v1/analytics/*Oversikt, inntekter, spesialiteter, prosedyrer, demografi og klinikereOffentlig syntetisk lesning
GET
/api/v1/auditAppend-bare API-mutasjonsposterToken kreves
GET
/api/v1/healthVersjon og skriveberedskapsstatusOffentlig lesning

FHIR R4 & country adapters

Vanilla R4 pluss feillukkede britiske, litauiske og estiske nasjonale adaptersandkasser.

GET
/api/v1/fhir/metadataCapabilityStatementOffentlig lesning
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 kreves
GETPOST
/api/v1/adapters/GB/*NHS Number, UK Core export, STU3, remindersPublic map 路 token for ops
GETPOST
/api/v1/adapters/LT/*ESPBI, IPR og eLab R5 syntetisk sandkasseOffentlig kamp 路 innsending av token
GETPOST
/api/v1/adapters/EE/*TIS CDA, MPI R5 og X-Road syntetisk sandkasseOffentlig kamp 路 innsending av token

Clinical workspace

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

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

Kliniske leseressurser

Pasienter

Syntetisk pasientdemografi og registreringsjournal. SLETT arkiverer i stedet for 氓 slette et klinisk emne.

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

Fester

Kontaktbare eller fakturerbare parter, atskilt fra emner for omsorg for vergem氓l, samtykke og betalertilskrivelse.

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

Konsultasjoner

Syntetisk konsultasjonsaktivitet og inntekter. Avledede/importerte poster er skrivebeskyttet.

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

Behandlinger

Fakturerbare behandlingslinjer klassifisert etter kategori og spesialitet. Avledede/importerte poster er skrivebeskyttet.

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

Diagnoser

Syntetiske diagnosejournaler knyttet til konsultasjoner. Importerte kliniske fakta er skrivebeskyttet.

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

Kliniske notater

Syntetiske kliniske notater. Writes bruker dedikert validering og arkiv i stedet for hard sletting.

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

Rask start

# 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 er domenebevisst: pasienter og notater arkiveres, avtaler og purringer kanselleres, fakturaer annulleres med reverseringsjournaler og betalinger refunderes. Kommunikasjons- og reskontroposter forblir uforanderlige.

Runtime OpenAPI: /api/openapi.json 路 Stabilt kompatibilitetsskjema: /swagger.json 路 Interaktive dokumenter: /api/docs