Spring til hovedindhold
En tid er en planlagt blodprøvetagning for en patientprofil på et fysisk teststed, udført af en sundhedsperson. Kits, der sendes med posten til en patient, er ikke tider — se Ordrer på hjemmetestkits.

Felter

string
påkrævet
UUID autogenereret af Aniva. Brug dette til at tilføje paneler, bekræfte blodprøvetagningen og hente resultater.
string
påkrævet
UUID for den profil, denne tid tilhører.
string
UUID for det teststed, hvor blodprøvetagningen finder sted. Hjemmetestkits er ikke tider — se Ordrer på hjemmetestkits.
string
Planlagt dato og tidspunkt for blodprøvetagningen i ISO 8601-format. Returneres altid som et UTC-tidspunkt med et Z-suffiks (f.eks. 2026-04-15T08:30:00Z). Ved oprettelse / opdatering skal værdien indeholde en tidszoneangivelse (enten Z eller en eksplicit forskydning som +02:00) — tidspunkter uden tidszone afvises. Skal ligge i fremtiden og på Aniva-drevne lokationer mindst 12 timer fremme (mindste varsel).
string
påkrævet
Aktuel livscyklusstatus. En af pending, confirmed, blood_drawn eller cancelled. Se Livscyklus nedenfor. Færdiggørelsesstatus for laboratorieresultater (in_progress vs. completed) hentes fra Hent resultater; mere detaljeret forsendelsesstatus (undervejs, leveret osv.) hentes ved at følge hvert element i det indlejrede shipments-array 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. Null, hvis tiden aldrig er blevet opdateret.
string[]
påkrævet
Laboratoriekoder (stregkoder på prøveglas) registreret ved Bekræft blodprøvetagning, 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. mikrotainer. Resultater og dokumenter henviser til disse via lab_code.
object[]
påkrævet
Paneler knyttet til denne tid som { panel_id, added_at }-elementer. Se Tilføjelse af paneler.
object[]
påkrævet
Enkeltstående biomarkører knyttet til denne tid som { biomarker_id, added_at }-elementer. Se Individuelle biomarkører.
object[]
påkrævet
Forsendelser knyttet til denne tid som { id, added_at }-elementer med den ældste tilknytning først. Se Tilknytning af forsendelser.
object
påkrævet
Det fulde profilobjekt for patienten, indlejret i hvert svar for en tid. Felterne nedenfor er et udsnit. Hent tid viser dem alle.

Livscyklus

Tider har fire livscyklustilstande:
Statusoversigten for tider er bevidst overordnet — mere detaljeret fremdrift vises via dedikerede endpoints:
  • Færdiggørelse af laboratorieresultater → Hent resultater — topniveau-feltet status er in_progress eller completed.
  • Forsendelsesfremdrift (undervejs, leveret osv.) → følg hvert element i det indlejrede shipments-array på tiden til Hent forsendelse — hver forsendelse har sin egen status og en status_updates-hændelseslog.
Hver statusændring sender en appointment.*-webhook, for eksempel appointment.confirmed. Et nyt tidspunkt eller en ny lokation sender appointment.rescheduled.
Bekræftelse af en tid (at flytte den til blood_drawn) er uigenkaldelig. Når du først har indsendt laboratoriekoden/-koderne, sættes laboratorieordreflowet i gang og kan ikke fortrydes. Opdateringer og aflysninger er kun tilladt, mens tiden har status pending eller confirmed.

Visning af tider

Hent alle tider, som din API-nøgle har adgang til:
Du kan valgfrit angive ?profile_id={uuid} for at filtrere efter en bestemt profil. Uden denne parameter anvendes et standardtidsvindue (seneste 2 måneder til kommende 1 måned).

Opdatering af en tid

Før blodprøvetagningen er bekræftet, kan du flytte tiden eller ændre teststedet:
Angiv en hvilken som helst kombination af scheduled_at, location_id, draw_method og results_ready_emails for at opdatere. Medtag kun de felter, du vil ændre.

Prøvetagningsmetode

Hver tid har en draw_method: capillary (fingerspids eller overarm, i mikrotainere) eller venous (fra venen, i prøveglas). Den gælder kun for blodprøvetagningen. Urinprøver, podninger og andre prøver, der ikke er blodprøver, opsamles på samme måde uanset metode. Som standard er det lokationens default_draw_method. Angiv draw_method ved oprettelse eller opdatering for at bruge en anden metode, eller sæt den til null for at gå tilbage til lokationens standard. Lokationen skal have metoden opført i sin draw_methods, og de bookede prøver skal kunne udføres med den, ellers returnerer anmodningen 400. Du kan ikke ændre den efter blodprøvetagningen. Efter blodprøvetagningen er draw_method den metode, der blev brugt.

Én tid pr. profil, lokation og tidspunkt

En profil kan højst have én ikke-aflyst tid pr. (location_id, scheduled_at)-par — én person kan ikke få taget blodprøve to gange på samme sted på samme tidspunkt, uanset hvor mange parallelle bookinger lokationen accepterer. Både Opret tid og Opdater tid håndhæver dette og returnerer 409 med et appointment_id, der peger på den tid, som allerede findes. Behandl dette svar som allerede booket frem for en fejl, der skal forsøges igen: hent, flyt eller aflys den angivne tid. Den praktiske effekt er, at gentagne oprettelser er sikre. En oprettelse, du sender igen efter en netværkstimeout, eller som en bruger udløser to gange, bliver til én enkelt tid i stedet for to – hvilket også betyder, at du aldrig behøver at rydde op i dobbeltbookinger for samme patient bagefter.
Opdateringer er kun tilladt før blodprøvetagningen – dvs. mens tiden har statussen pending eller confirmed. Når tiden skifter til blood_drawn eller er blevet cancelled, kan den ikke ændres. Den eneste undtagelse er results_ready_emails: du kan stadig ændre det alene efter blodprøvetagningen.

Aflys en tid

Aflys en tid, der ikke længere er brug for:
Det sætter tidens status til cancelled. Den aflyste tid returneres i svaret. Du kan valgfrit sende en cancellation_reason (op til 500 tegn) i bodyen for at angive årsagen. Den gemmes på tiden og returneres som cancellation_reason ved senere opslag.
Aflysning er kun tilladt før blodprøvetagningen – dvs. mens tiden har statussen pending eller confirmed. Tider, der allerede er skiftet til blood_drawn, kan ikke aflyses.

Tilføj paneler

Før du bekræfter blodprøvetagningen, skal du tilføje de blodprøvepaneler, du vil køre, ved at kalde:
Send et array af panel-UUID’er i feltet panel_ids. Panel-ID’er udleveres af Aniva til din partnerkonto.
Paneler skal tilføjes før blodprøvetagningen – dvs. mens tiden har statussen pending eller confirmed. Du kan ikke tilføje eller ændre paneler, når tiden er skiftet til blood_drawn.

Fjern paneler

Hvis du har brug for at fjerne paneler før blodprøvetagningen, så kald:
Send et array af panel-UUID’er i feltet panel_ids. Fjernelsen er idempotent: et panel, der ikke er tilknyttet, ignoreres.
Ligesom tilføjelse af paneler er fjernelse kun tilladt før blodprøvetagningen – dvs. mens tiden har statussen pending eller confirmed. Paneler kan ikke fjernes, når tiden er skiftet til blood_drawn.

Individuelle biomarkører

Du kan tilknytte individuelle biomarkører til en tid som à la carte-test uden for et færdigt panel. Det er nyttigt, når en behandler ønsker et skræddersyet udvalg frem for en foruddefineret pakke. De tilknyttede biomarkører vises i svaret for tiden som et individual_biomarkers-array (på samme niveau som panels). Routingbeslutninger træffes nedstrøms af ordrelogistik-pipelinen baseret på hver biomarkørs mapping pr. laboratorium. Tilføj biomarkører (idempotent – allerede tilknyttede biomarkører beholdes):
Fjern biomarkører (idempotent – biomarkører, der ikke er tilknyttet, ignoreres):
Begge endpoints tager et biomarker_ids-array og validerer det samlede sæt mod hvert laboratoriums afhængighedsregler – en ordre, der ikke kan afgives korrekt (f.eks. et CRP/HDL-forhold uden CRP og HDL), returnerer 400 med de biomarkører, du skal tilføje, og gemmer intet. Brug Vis biomarkører til at finde biomarkør-ID’er.
Ligesom ændringer i paneler kan individuelle biomarkører kun tilføjes eller fjernes før blodprøvetagningen – dvs. mens tiden har statussen pending eller confirmed. Når tiden skifter til blood_drawn, fastlåses det tilpassede snapshot.

Forhåndsvis beholderkrav

Når du har tilføjet paneler eller individuelle biomarkører, kan du forhåndsvise de fysiske prøvebeholdere, der skal bruges til prøvetagningen:
Svarets containers-array indeholder type, navn, lågfarve, volumen, producentens varenummer og antal for hver påkrævet beholder. Det hjælper behandlere med at klargøre de rigtige materialer før blodprøvetagningen. Svaret indeholder også et pricing-objekt – tidens samlede opgørelse (de udløste poster, de tilknyttede paneler og én linje pr. leveret biomarkør, prissat efter din prisliste med detailpris ved siden af; se Prissætning), som udfyldes, når tiden har tilknyttede prøver, og din nøgle har scopet prices_view, ellers null. routing eksponeres bevidst aldrig og er altid null.
Forhåndsvisningen afspejler de aktuelt tilknyttede paneler og biomarkører. Hvis du tilføjer eller fjerner paneler efter forhåndsvisningen, skal du kalde forhåndsvisningsendpointet igen for at få opdaterede beholderkrav.

Bekræft blodprøvetagningen

Efter blodprøvetagningen indsender du laboratoriekoderne (prøveglassenes stregkoder) for at starte laboratorieordre-pipelinen:
Send lab_code, når den samme kode står på alle glas (venøs blodprøvetagning), eller lab_codes med én post pr. kode – hver med de panel_ids, den dækker – når hvert panel tages i sine egne glas med sin egen kode (kapillær blodprøvetagning). Hvert panel bliver så sin egen laboratorierekvisition under sin kode. Koderne returneres som lab_codes på tiden. Ved en kapillær blodprøvetagning pakkes prøven i microtainers. Paneler kommer først i bookingrækkefølge. Individuelle biomarkører fylder derefter den ledige plads i panelernes microtainers. Når de skal bruge mere plads, åbner de nye microtainers. Vi fordeler dem jævnt. Hver microtainer rummer højst 150 µl individuelle biomarkører. Kald, der ændrer paneler eller biomarkører, svarer 400, når det samlede sæt bryder denne regel. Det skifter tidens status til blood_drawn og starter behandlingen på laboratoriet. Handlingen kan ikke fortrydes.

Afhentning af forsendelse

POST /api/v1/appointments/pickup er blevet fjernet sammen med statussen shipment_picked_up for tider. Det svarer nu 405 Method Not Allowed, fordi stien falder igennem til appointment-by-id-ruten. Endpointet fungerede i sin sidste fase som en no-op, der tog imod kaldet uden at gøre noget, så fjernelsen ændrer ingen adfærd, du var afhængig af.
For at følge forløbet efter blodprøvetagningen kan du følge hver post i tidens indlejrede shipments-array til Hent forsendelse – hver forsendelse har sin egen status og en status_updates-historik.

Tilknyt forsendelser

En tid kan knyttes til én eller flere forsendelser (og omvendt – relationen er mange-til-mange). De aktuelle tilknytninger vises indlejret på begge sider:
  • på tiden som et shipments-array med { id, added_at }-poster;
  • på forsendelsen som et appointments-array med { id, added_at }-poster.
Begge arrays er sorteret med den ældste tilknytning først. Hvert id henviser til det kanoniske detalje-endpoint (Hent forsendelse / Hent tid) for den fulde payload. Forsendelser tilknyttes ved oprettelsen via feltet appointment_id på Opret forsendelse. Efter oprettelsen administrerer du tilknytninger fra forsendelsen med Tilknyt tider til forsendelse og Fjern tider fra forsendelse; begge returnerer den opdaterede liste over tider for forsendelsen. For at læse en tids pakker i fuldt omfang bruger du Vis forsendelser med ?appointment_id=. Reglen for ændringer er: Tilknytninger kan oprettes eller fjernes, når ENTEN
  • tiden er forbi blodprøvetagningen (blood_drawn), eller
  • forsendelsen blev oprettet for mindre end 24 timer siden.
Uden for det tidsrum er tilknytningen låst, så historiske data forbliver stabile.

Hent laboratorieresultater

Når laboratoriet har behandlet blodprøverne, kan du hente kliniske og genetiske resultater:
Svaret indeholder planlagte tests (status planned) sammen med modtagne resultater, så du kan følge med i, hvad der stadig afventer. Feltet status på øverste niveau er in_progress, indtil hver indsendelse er afsluttet, og derefter completed (eller fault, hvis ingen af dem har rapporteret) – brug dette til at afgøre, om laboratoriearbejdet for tiden er færdigt. En appointment.results.completed-webhook giver dig besked, når det sker, så du ikke behøver at polle. Arrayet submissions opdeler dette pr. laboratorierekvisition, hver med sin egen lab_code. Hvert modtaget resultat og dokument har den lab_code, det blev registreret under. Laboratorierapporter i PDF-format er refereret i arrayet documents – brug GET /api/v1/documents/{id} til at downloade dem.

Eksempel på en tid