Spring til hovedindhold
GET
Hent en liste over tider til blodprøvetagning. Hver tid indeholder den indlejrede patientprofil. Filtrene kombineres:
  • date returnerer tiderne på én kalenderdag. Dagen er den lokale dag for hver tids lokation, så en blodprøvetagning kl. 23:30 i Berlin tæller på datoen i Berlin.
  • location_id returnerer tiderne på én testlokation.
  • profile_id uden date returnerer alle tider for den profil uden tidsbegrænsning.
  • Uden profile_id og uden date gælder standardtidsvinduet: de seneste 2 måneder og 1 måned frem.
Kræver scopet appointments_view eller appointments_schedule.

Forespørgsel

Forespørgselsparametre

string
Filtrer efter profil-UUID. Når den angives, returneres alle tider for denne profil uanset planlagt dato. Når den udelades, gælder standardtidsvinduet.
string
Filtrer efter testlokationens UUID.
string
Kalenderdag i formatet YYYY-MM-DD i hver tids lokations tidszone. Erstatter standardtidsvinduet. Resultaterne sorteres efter scheduled_at, tidligste først.

Svar

Ved succes returnerer API’et 200 OK med et array af tidsobjekter.
string
påkrævet
Unikt id for tiden (UUID).
string
påkrævet
UUID for den profil, denne tid tilhører.
string
UUID for det teststed, hvor blodprøvetagningen finder sted.
string
Planlagt dato og tidspunkt for tiden i UTC (ISO 8601 med Z-suffiks, f.eks. 2026-05-15T10:30:00Z). Kan være null.
string
påkrævet
Aktuel status for tiden. En af pending, confirmed, blood_drawn eller cancelled. Fremdriften i laboratorieresultaterne udledes fra Hent resultater; mere detaljeret forsendelsesfremdrift fra hvert element i det indlejrede shipments-array (se nedenfor) videre til Hent forsendelse.
string
Fritekstårsag registreret ved aflysning af tiden (f.eks. udeblivelse, sen aflysning, ‘Failed. Repeat required’). null, medmindre status er cancelled.
string[]
påkrævet
Adresser med små bogstaver, som hver modtager én e-mail, når alle laboratorieresultater er endelige. Tom, når funktionen er slået fra. Se E-mails når resultater er klar.
string
påkrævet
Hvordan blodet tages: capillary (fingerspids eller overarm i mikrorør) eller venous (fra venen i prøveglas). Det er den metode, tiden angiver, ellers default_draw_method for dens lokation. Efter blodprøvetagningen er det den metode, der blev brugt.
string
påkrævet
ISO 8601-tidsstempel for, hvornår tiden blev oprettet.
string
ISO 8601-tidsstempel for den seneste opdatering. Kan være null.
object
påkrævet
Den patientprofil, der er knyttet til denne tid.
AppointmentPanel[]
påkrævet
Paneler, der i øjeblikket er tilknyttet denne tid. Inkluderer ikke annullerede tilknytninger. Slå paneldetaljer (navn, biomarkører) op via Vis paneler.
AppointmentIndividualBiomarker[]
påkrævet
À la carte-biomarkører knyttet til denne tid uden for et panel (se Tilføj valgfrie biomarkører). Krydsreferer hvert biomarker_id med Vis biomarkører for visningsdata.
AppointmentShipmentLink[]
påkrævet
Forsendelser knyttet til denne tid, ældste tilknytning først. Tomt array, når ingen forsendelser er tilknyttet. Slå hvert id op via Hent forsendelse for at få det fulde payload for forsendelsen (status, sporingsnummer, statusopdateringer osv.).
string[]
påkrævet
Laboratoriekoder (stregkoder på prøveglas) registreret for denne tid i scanningsrækkefølge. Tom, indtil blodprøvetagningen er bekræftet. En venøs blodprøvetagning har én kode trykt på hvert prøveglas; en kapillær blodprøvetagning har én kode pr. mikrorør. Resultater og dokumenter i Hent resultater henviser til disse koder via lab_code.

Gentagne kald

Aniva gemmer svaret fra dette endpoint i 5 minutter for hver API-nøgle. Et gentaget kald inden for dette tidsrum får det gemte svar. Headerne Cache-Status og Age viser, at svaret er gemt, og hvor gammelt det er. For at få besked om en ændring med det samme kan du abonnere på webhook-hændelserne appointment.created, appointment.rescheduled og hændelsen for hver status, for eksempel appointment.confirmed. Se Gentagne læsninger.

Fejlsvar