Hopp til hovedinnhold
GET
Hent en liste over timer for blodprøvetaking. Hver time inkluderer den innebygde pasientprofilen. Filtrene kombineres:
  • date returnerer timene på én kalenderdag. Dagen er den lokale dagen for hvert prøvested, så en blodprøvetaking kl. 23:30 i Berlin teller på datoen i Berlin.
  • location_id returnerer timene på ett prøvested.
  • profile_id uten date returnerer alle timer for den profilen, uten tidsbegrensning.
  • Uten profile_id og uten date gjelder standard tidsvindu: de siste 2 månedene til 1 måned frem i tid.
Krever scopet appointments_view eller appointments_schedule.

Forespørsel

Spørreparametere

string
Filtrer etter profil-UUID. Når denne oppgis, returneres alle timer for denne profilen uavhengig av oppsatt dato. Når den utelates, gjelder standard tidsvindu.
string
Filtrer etter prøvestedets UUID.
string
Kalenderdag i YYYY-MM-DD-format, i tidssonen til hvert prøvested. Erstatter standard tidsvindu. Resultatene sorteres etter scheduled_at, tidligst først.

Respons

Ved suksess returnerer API-et 200 OK med en liste med timeobjekter.
string
påkrevd
Unik timeidentifikator (UUID).
string
påkrevd
UUID for profilen denne timen tilhører.
string
UUID for teststedet der blodprøvetakingen finner sted.
string
Planlagt tidspunkt for timen i UTC (ISO 8601 med Z-suffiks, f.eks. 2026-05-15T10:30:00Z). Kan være null.
string
påkrevd
Gjeldende status for timen. En av pending, confirmed, blood_drawn eller cancelled. Detaljert status for laboratorieresultater henter du fra Hent resultater, og mer detaljert fremdrift for forsendelser fra hvert element i den innebygde shipments-listen (se nedenfor) videre til Hent forsendelse.
string
Fritekstårsak som ble registrert da timen ble avbestilt (f.eks. manglende oppmøte, sen avbestilling, «Mislyktes. Må gjentas»). null med mindre status er cancelled.
string[]
påkrevd
Adresser som hver får én e-post når alle labresultater er endelige, i små bokstaver. Tom når den er slått av. Se E-poster om klare resultater.
string
påkrevd
Hvordan blodprøven tas: capillary (fingertupp eller overarm, i mikrorør) eller venous (fra vene, i prøverør). Det er metoden som er satt på timen, ellers default_draw_method for stedet. Etter blodprøvetakingen er det metoden som ble brukt.
string
påkrevd
ISO 8601-tidsstempel for når timen ble opprettet.
string
ISO 8601-tidsstempel for siste oppdatering. Kan være null.
object
påkrevd
Pasientprofilen som er knyttet til denne timen.
AppointmentPanel[]
påkrevd
Paneler som for øyeblikket er knyttet til denne timen. Utelater kansellerte tilknytninger. Slå opp paneldetaljer (navn, biomarkører) via Vis paneler.
AppointmentIndividualBiomarker[]
påkrevd
Enkeltbiomarkører knyttet til denne timen utenfor et panel (se Legg til egendefinerte biomarkører). Kryssreferer hver biomarker_id mot Vis biomarkører for visningsdata.
AppointmentShipmentLink[]
påkrevd
Forsendelser knyttet til denne timen, med eldste kobling først. Tomt array når ingen forsendelser er knyttet til. Slå opp hver id mot Hent forsendelse for fullstendige forsendelsesdata (status, sporingsnummer, statusoppdateringer osv.).
string[]
påkrevd
Labkoder (strekkoder på prøverør) som er registrert for denne timen, i skannerekkefølge. Tom til blodprøvetakingen er bekreftet. En venøs blodprøvetaking har én kode trykket på hvert prøverør; en kapillær blodprøvetaking har én kode per mikrorør. Resultater og dokumenter i Hent resultater refererer til disse kodene via lab_code.

Gjentatte kall

Aniva lagrer svaret fra dette endepunktet i 5 minutter for hver API-nøkkel. Et gjentatt kall innenfor denne tiden får det lagrede svaret. Headerne Cache-Status og Age viser at svaret er lagret og hvor gammelt det er. For å få beskjed om en endring med én gang, abonner på webhook-hendelsene appointment.created, appointment.rescheduled og hendelsen for hver status, for eksempel appointment.confirmed. Se Gjentatte lesinger.

Feilresponser