Utvecklarplattform · API v1

Bygg med FastClinic API.

Utforska den syntetiska livedemon genom ett maskinskrivet, versionerat API med offentliga läsningar och token-gated operationer.

Offentlig förhandsvisning. Syntetiska kliniska och aggregerade GET-slutpunkter kräver ingen autentisering. Operationella läsningar och alla skrivningar kräver FASTSME_API_TOKEN; de returnerar 503 när det inte är konfigurerat. Aktiverade klienter skickar Authorization: Bearer <token>.

Komplett API-yta

Kliniska uppgifter

Patienter, parter, vårdnadshavare och betalare, konsultationer, diagnoser, behandlingar och validerad anteckningsredigering.

GETPOSTPATCHDELETE
/api/v1/patientsPatient CRUD; RADERA arkivOffentlig läsning · token skrivning
GETPOSTPATCHDELETE
/api/v1/partiesParty CRUD; länkade parter kan inte raderasOffentlig läsning · token skrivning
GETPOSTPATCHDELETE
/api/v1/relationshipsFörmyndare, själv, betalare, familj och nödsituationerOffentlig läsning · token skrivning
GET
/api/v1/consultations · /diagnoses · /treatmentsImporterad klinisk aktivitetOffentlig syntetisk läsning
GETPOSTPATCHDELETE
/api/v1/notesValiderad anteckningslivscykel; RADERA arkivOffentlig läsning · token skrivning

Schemaläggning

Tillgänglighet, kliniker, konfliktsäker bokning, ombokning, statusövergångar och avbokning.

GET
/api/v1/clinicians · /availabilityBokningsbara klinikschemanOffentlig läsning
GETPOSTPATCHDELETE
/api/v1/appointmentsKonfliktsäker möteslivscykelOffentlig läsning · token skrivning
GETPOST
/api/v1/external/*FastBooking tillgänglighet och idempotenta reservationerFastBooking-token

Mobil patientapp

MedBackend OAuth/PKCE-identitet, bootstrap med eget rekord, samtalsbokning och möteslivscykel.

GET
/api/v1/mobile/me · /bootstrapAutentiserade profil- och appstartdataMedBackend OAuth-token
GET
/api/v1/mobile/availabilityPatientsäker livetillgänglighetMedBackend OAuth-token
GETPOST
/api/v1/mobile/appointmentsEgna möten och deterministisk bokningMedBackend OAuth-token
POST
/api/v1/mobile/booking/chatLangGraph bokningskonversationMedBackend OAuth-token
GET
/api/v1/mobile/recordsEgna FHIR R4-poster i JSON eller XMLMedBackend OAuth-token

Aktivering & kommunikation

Samtyckesfiltrerade återkallelselistor, ihållande påminnelser, oföränderliga leveransloggar och resultattillskrivning.

GET
/api/v1/activation/due · /lapsed · /followupSamtyckesfiltrerade aktiveringskohorterToken krävs
GETPOSTPATCHDELETE
/api/v1/remindersPåminnelse livscykel; DELETE avbryterToken krävs
GETPOST
/api/v1/communicationsSamtyckesstyrda SMS/e-post och oföränderliga loggarToken krävs
GETPATCH
/api/v1/parties/{id}/marketing-consentTillstånd för att välja bort marknadsföringToken krävs

Fakturering & reskontra

Idempotent fakturering, betalningar och återbetalningar, annulleringar genom reversering av journaler och balanserad redovisning.

GETPOSTPATCHDELETE
/api/v1/invoicesFaktura livscykel; DELETE postar en ogiltig återföringToken krävs
GETPOSTDELETE
/api/v1/paymentsIdempotenta kvitton; DELETE gör en återbetalningToken krävs
GET
/api/v1/ledger · /trial-balanceOföränderlig journal och saldonToken krävs

Analys och revision

Samma operativa vyer som används av instrumentpanelerna, plus en API-mutationsspår som endast kan läggas till.

GET
/api/v1/analytics/*Översikt, intäkter, specialiteter, procedurer, demografi och läkareOffentlig syntetisk läsning
GET
/api/v1/auditLägg endast till API-mutationsposterToken krävs
GET
/api/v1/healthVersion och skrivberedskapsstatusOffentlig läsning

FHIR R4 & country adapters

Vanilla R4 plus felstängda brittiska, litauiska och estniska nationella adaptersandlådor.

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 krävs
GETPOST
/api/v1/adapters/GB/*NHS Number, UK Core export, STU3, remindersPublic map · token for ops
GETPOST
/api/v1/adapters/LT/*ESPBI, IPR och eLab R5 syntetisk sandlådaOffentlig match · token inlämnande
GETPOST
/api/v1/adapters/EE/*TIS CDA, MPI R5 och X-Road syntetisk sandlådaOffentlig match · token inlämnande

Clinical workspace

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

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

Kliniska läsresurser

Patienter

Syntetisk patientdemografi och registreringsregister. DELETE arkiverar istället för att radera ett kliniskt ämne.

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

Fester

Kontaktbara eller fakturerbara parter, åtskilda från ämnen som behandlas för förmynderskap, samtycke och tillskrivning av betalare.

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

Konsultationer

Syntetisk konsultverksamhet och intäkter. Härledda/importerade poster är skrivskyddade.

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

Behandlingar

Fakturerbara behandlingslinjer klassificerade efter kategori och specialitet. Härledda/importerade poster är skrivskyddade.

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

Diagnoser

Syntetiska diagnosjournaler kopplade till konsultationer. Importerade kliniska fakta är skrivskyddade.

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

Kliniska anteckningar

Syntetiska kliniska anteckningar. Writes använder dedikerad validering och arkiv snarare än hård radering.

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

Snabbstart

# 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 är domänmedvetet: patienter och anteckningar arkiveras, möten och påminnelser avbokas, fakturor annulleras med reverserande journaler och betalningar återbetalas. Kommunikations- och reskontraposter förblir oföränderliga.

Runtime OpenAPI: /api/openapi.json · Stabilt kompatibilitetsschema: /swagger.json · Interaktiva dokument: /api/docs