Udviklerplatform · API v1

Byg med FastClinic API.

Udforsk den levende syntetiske demo gennem en maskinskrevet, versioneret API med offentlige læsninger og token-gatede operationer.

Offentlig adgang til forhåndsvisning. Syntetiske kliniske og aggregerede GET-endepunkter kræver ingen godkendelse. Operationelle læsninger og alle skrivninger kræver FASTSME_API_TOKEN; de returnerer 503, når det ikke er konfigureret. Aktiverede klienter sender Authorization: Bearer <token>.

Komplet API overflade

Kliniske optegnelser

Patienter, parter, værger og betalere, konsultationer, diagnoser, behandlinger og valideret noteredigering.

GETPOSTPATCHDELETE
/api/v1/patientsPatient CRUD; SLET arkiverOffentlig læsning · token skrivning
GETPOSTPATCHDELETE
/api/v1/partiesParty CRUD; tilknyttede parter kan ikke slettesOffentlig læsning · token skrivning
GETPOSTPATCHDELETE
/api/v1/relationshipsVærge-, selv-, betaler-, familie- og nødrollerOffentlig læsning · token skrivning
GET
/api/v1/consultations · /diagnoses · /treatmentsImporteret klinisk aktivitetOffentlig syntetisk læsning
GETPOSTPATCHDELETE
/api/v1/notesValideret notes livscyklus; SLET arkiverOffentlig læsning · token skrivning

Planlægning

Tilgængelighed, klinikere, konfliktsikker booking, omlægning, statusovergange og aflysning.

GET
/api/v1/clinicians · /availabilityBookbare tidsplaner for klinikereOffentlig læsning
GETPOSTPATCHDELETE
/api/v1/appointmentsKonfliktsikker aftalelivscyklusOffentlig læsning · token skrivning
GETPOST
/api/v1/external/*FastBooking tilgængelighed og idempotente reservationerFastBooking token

Mobil patient-app

MedBackend OAuth/PKCE-identitet, egen-record bootstrap, samtalebooking og aftalelivscyklus.

GET
/api/v1/mobile/me · /bootstrapGodkendte profil- og app-startdataMedBackend OAuth-token
GET
/api/v1/mobile/availabilityPatientsikker live tilgængelighedMedBackend OAuth-token
GETPOST
/api/v1/mobile/appointmentsEgne aftaler og deterministisk bookingMedBackend OAuth-token
POST
/api/v1/mobile/booking/chatLangGraph booking samtaleMedBackend OAuth-token
GET
/api/v1/mobile/recordsEgne FHIR R4-poster i JSON eller XMLMedBackend OAuth-token

Aktivering og kommunikation

Samtykkefiltrerede tilbagekaldelseslister, vedvarende påmindelser, uforanderlige leveringslogfiler og resultattilskrivning.

GET
/api/v1/activation/due · /lapsed · /followupSamtykkefiltrerede aktiveringskohorterToken påkrævet
GETPOSTPATCHDELETE
/api/v1/remindersPåmindelse livscyklus; SLET annullererToken påkrævet
GETPOST
/api/v1/communicationsSamtykkestyret SMS/e-mail og uforanderlige logfilerToken påkrævet
GETPATCH
/api/v1/parties/{id}/marketing-consentMarkedsføringsopt-out-tilstandToken påkrævet

Fakturering og hovedbog

Idempotent fakturering, betalinger og refusioner, annulleringer gennem tilbageførsel af journaler og balanceret regnskabsrapportering.

GETPOSTPATCHDELETE
/api/v1/invoicesFaktura livscyklus; SLET sender en ugyldig tilbageførselToken påkrævet
GETPOSTDELETE
/api/v1/paymentsIdempotente kvitteringer; SLET sender en refusionToken påkrævet
GET
/api/v1/ledger · /trial-balanceUforanderlig journal og saldiToken påkrævet

Analyse og revision

De samme operationelle visninger, der bruges af dashboards, plus et API-mutationsspor, der kun kan tilføjes.

GET
/api/v1/analytics/*Oversigt, omsætning, specialer, procedurer, demografi og klinikereOffentlig syntetisk læsning
GET
/api/v1/auditAPI-mutationsregistreringer, der kun tilføjesToken påkrævet
GET
/api/v1/healthVersions- og skriveberedskabsstatusOffentlig læsning

FHIR R4 & country adapters

Vanilla R4 plus fejllukkede britiske, litauiske og estiske nationale adaptersandkasser.

GET
/api/v1/fhir/metadataCapabilityStatementOffentlig læsning
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 påkrævet
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 sandkasseOffentligt opgør · token-indsendelse
GETPOST
/api/v1/adapters/EE/*TIS CDA, MPI R5 og X-Road syntetisk sandkasseOffentligt opgør · token-indsendelse

Clinical workspace

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

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

Kliniske læseressourcer

Patienter

Syntetiske patientdemografiske og registreringsjournaler. SLET arkiverer i stedet for at slette et klinisk emne.

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

Fester

Kontaktbare eller fakturerbare parter, adskilt fra emner om omsorg for værgemål, samtykke og betalertilskrivning.

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

Konsultationer

Syntetisk høringsaktivitet og omsætning. Afledte/importerede poster er skrivebeskyttet.

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

Behandlinger

Fakturerbare behandlingslinjer klassificeret efter kategori og speciale. Afledte/importerede poster er skrivebeskyttet.

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

Diagnoser

Syntetiske diagnosejournaler knyttet til konsultationer. Importerede kliniske fakta er skrivebeskyttet.

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

Kliniske noter

Syntetiske kliniske noter. Writes bruger dedikeret validering og arkivering i stedet for hård sletning.

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

Hurtig 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 domænebevidst: Patienter og notater arkiveres, aftaler og rykkere annulleres, fakturaer annulleres med tilbageførsel af journaler, og betalinger refunderes. Kommunikation og finansposter forbliver uforanderlige.

Runtime OpenAPI: /api/openapi.json · Stabilt kompatibilitetsskema: /swagger.json · Interaktive dokumenter: /api/docs