Kehittäjäalusta · API v1

Rakenna FastClinic API:lla.

Tutustu elävään synteettiseen esittelyyn kirjoitetun, versioidun API:n kautta, jossa on julkisia lukuja ja tunnuksella suojattuja toimintoja.

Julkinen esikatseluoikeus. Synteettiset kliiniset ja aggregoidut GET-päätepisteet eivät vaadi autentikointia. Toiminnallinen lukeminen ja kaikki kirjoitukset vaativat FASTSME_API_TOKEN; ne palauttavat 503, kun sitä ei ole määritetty. Käytössä olevat asiakkaat lähettävät Authorization: Bearer <token>.

Täydellinen API-pinta

Kliiniset tiedot

Potilaat, osapuolet, huoltajat ja maksajat, konsultaatiot, diagnoosit, hoidot ja validoitu muistiinpanojen muokkaus.

GETPOSTPATCHDELETE
/api/v1/patientsPotilas CRUD; POISTA arkistotJulkinen luku · Token write
GETPOSTPATCHDELETE
/api/v1/partiespuolueen CRUD; linkitettyjä osapuolia ei voi poistaaJulkinen luku · Token write
GETPOSTPATCHDELETE
/api/v1/relationshipsHuoltajan, itsensä, maksajan, perheen ja hätäroolitJulkinen luku · Token write
GET
/api/v1/consultations · /diagnoses · /treatmentsTuotu kliininen toimintaJulkinen synteettinen luku
GETPOSTPATCHDELETE
/api/v1/notesValidoitu muistiinpanon elinkaari; POISTA arkistotJulkinen luku · Token write

Ajoitus

Saatavuus, lääkärit, konfliktiturvallinen varaus, uudelleenjärjestely, tilasiirtymät ja peruutukset.

GET
/api/v1/clinicians · /availabilityVarattavissa kliinikon aikataulutJulkinen luku
GETPOSTPATCHDELETE
/api/v1/appointmentsKonfliktiturvallinen tapaamisen elinkaariJulkinen luku · Token write
GETPOST
/api/v1/external/*FastBookingin saatavuus ja kyvyttömät varauksetFastBooking-tunnus

Mobiilipotilassovellus

MedBackend OAuth/PKCE -identiteetti, oman tietueen bootstrap, keskusteluvaraus ja tapaamisen elinkaari.

GET
/api/v1/mobile/me · /bootstrapTodennettu profiili ja sovelluksen käynnistystiedotMedBackend OAuth -tunnus
GET
/api/v1/mobile/availabilityPotilasturvallinen live saatavuusMedBackend OAuth -tunnus
GETPOST
/api/v1/mobile/appointmentsOmat ajanvaraukset ja deterministinen varausMedBackend OAuth -tunnus
POST
/api/v1/mobile/booking/chatLangGraph-varauskeskusteluMedBackend OAuth -tunnus
GET
/api/v1/mobile/recordsOmat FHIR R4 -tietueet JSON- tai XML-muodossaMedBackend OAuth -tunnus

Aktivointi ja viestintä

Suostumussuodatetut palautuslistat, jatkuvat muistutukset, muuttumattomat toimituslokit ja tulosten ansioksi lukeminen.

GET
/api/v1/activation/due · /lapsed · /followupSuostumussuodatetut aktivointikohortitTunnus vaaditaan
GETPOSTPATCHDELETE
/api/v1/remindersMuistutuksen elinkaari; DELETE peruuttaaTunnus vaaditaan
GETPOST
/api/v1/communicationsSuostumukselliset tekstiviestit/sähköpostit ja muuttumattomat lokitTunnus vaaditaan
GETPATCH
/api/v1/parties/{id}/marketing-consentMarkkinoinnin kieltäytymistilaTunnus vaaditaan

Laskutus & pääkirja

Idempotentti laskutus, maksut ja hyvitykset, tyhjiöt käänteiskirjauskansioista ja tasapainoinen pääkirjaraportointi.

GETPOSTPATCHDELETE
/api/v1/invoicesLaskun elinkaari; DELETE lähettää mitättömän peruutuksenTunnus vaaditaan
GETPOSTDELETE
/api/v1/paymentsIdempotentti kuitit; DELETE lähettää hyvityksenTunnus vaaditaan
GET
/api/v1/ledger · /trial-balanceMuuttumaton päiväkirja ja saldotTunnus vaaditaan

Analyysi ja auditointi

Samat toimintanäkymät, joita hallintapaneelit käyttävät, sekä vain liitettävä API-mutaatiopolku.

GET
/api/v1/analytics/*Yleiskatsaus, tulot, erikoisalat, menettelyt, väestötiedot ja lääkäritJulkinen synteettinen luku
GET
/api/v1/auditLiitä vain API-mutaatiotietueetTunnus vaaditaan
GET
/api/v1/healthVersio ja kirjoitusvalmiusJulkinen luku

FHIR R4 & country adapters

Vanilla R4 plus vikasuljetut Iso-Britannian, Liettuan ja Viron kansalliset adapterihiekkalaatikot.

GET
/api/v1/fhir/metadataCapabilityStatementJulkinen luku
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 coreTunnus vaaditaan
GETPOST
/api/v1/adapters/GB/*NHS Number, UK Core export, STU3, remindersPublic map · token for ops
GETPOST
/api/v1/adapters/LT/*ESPBI, IPR ja eLab R5 synteettinen hiekkalaatikkoJulkinen ottelu · Token lähettää
GETPOST
/api/v1/adapters/EE/*TIS CDA, MPI R5 ja X-Road synteettinen hiekkalaatikkoJulkinen ottelu · Token lähettää

Clinical workspace

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

GETPOST
/api/v1/chart/encountersOpen a chart encounterTunnus vaaditaan
POST
/api/v1/chart/encounters/{id}/finishFinish an encounterTunnus vaaditaan
GETPOST
/api/v1/chart/notesSOAP notesTunnus vaaditaan
GETPOSTPATCH
/api/v1/ordersLab, imaging, referral, medication ordersTunnus vaaditaan
GETPOSTPATCH
/api/v1/care-tasksCare-coordination tasksTunnus vaaditaan
GETPOST
/api/v1/coverageInsurance / payor coverageTunnus vaaditaan
GETPOST
/api/v1/messagesIn-clinic message threadsTunnus vaaditaan

Kliiniset resurssit

Potilaat

Synteettiset potilaiden demografiset ja rekisteröintitiedot. DELETE arkistoi kliinisen kohteen poistamisen sijaan.

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

Juhlat

Yhteydenotot tai laskutettavat osapuolet, jotka on erotettu huoltajista, suostumuksesta ja maksajan määrittämisestä.

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

Konsultaatiot

Synteettinen konsultointitoiminta ja tulot. Johdetut/tuodut tietueet ovat vain luku -tilassa.

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

Hoidot

Laskutettavat hoitolinjat luokitellaan luokan ja erikoisalan mukaan. Johdetut/tuodut tietueet ovat vain luku -tilassa.

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

Diagnoosit

Konsultaatioihin liittyvät synteettiset diagnoositiedot. Tuodut kliiniset tosiasiat ovat vain luku -tilassa.

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

Kliiniset huomautukset

Synteettiset kliiniset muistiinpanot. Kirjoitukset käyttävät erillistä vahvistusta ja arkistointia kovan poistamisen sijaan.

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

Pika aloitus

# 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 on verkkotunnuksen tietoinen: potilaat ja muistiinpanot arkistoidaan, tapaamiset ja muistutukset peruutetaan, laskut mitätöidään peruutetuilla päiväkirjoilla ja maksut palautetaan. Viestintä- ja pääkirjatietueet pysyvät muuttumattomina.

Ajonaikainen OpenAPI: /api/openapi.json · Vakaa yhteensopivuusskeema: /swagger.json · Interaktiiviset asiakirjat: /api/docs