Hopp til hovedinnhold
POST
Be om en bestilling av hjemmetestsett for en pasientprofil. En bestilling av hjemmetestsett sender et gjør-det-selv-testsett i posten — Aniva sender settet til leveringsadressen, pasienten tar prøven selv hjemme og sender den tilbake i posten. Dette skiller seg fra en time, som er en venøs blodprøvetaking på et teststed. Nøyaktig ett panel kreves. Et hjemmetestsett tilsvarer 1:1 et fysisk settprodukt — panelet er settet — og bestillingen går rett i pakkekøen så snart den er opprettet, så sammensetningen må være endelig på forhånd. Du kan likevel bytte panel via Oppdater bestilling av hjemmetestsett mens bestillingen er pending.

Erstatningssett

Når et sett ikke kan gi resultater — pasienten fikk ikke fylt røret, prøven kom frem med for lite materiale, laboratoriet kunne ikke analysere den — bestiller du en erstatning ved å sende replaces_home_kit_order_id. En erstatning er en ny bestilling med en ny laboratoriekode, også når det første settet aldri ble aktivert: laboratoriet trenger en ny rekvisisjon, og to prøver under én kode kan ikke skilles fra hverandre. Bestillingen du erstatter blir ikke berørt — den beholder sin egen status, sin egen laboratoriekode og eventuelle resultater som allerede er registrert på den. To ting følger av dette:
  • Panelet arves. Utelat panel_id, så får erstatningen panelet fra bestillingen den erstatter, som er det pasienten kjøpte og slik esken er profilert.
  • Du velger hva som kjøres på nytt. Send biomarker_ids med markørene som feilet, så kjører laboratoriet bare disse på nytt, og settet sendes bare med rørene som trengs. Utelat feltet for å kjøre hele panelet på nytt.
Markører kjøres på nytt som panelets grupper, ikke én og én. Oppgir du én markør i en gruppe, kjøres hele gruppen på nytt, fordi en laboratoriebestilling som rapporterer mer enn det som ble bedt om ikke kan legges inn. En erstatning for én markør kan derfor komme med mer enn ett resultat, og antall rør kan være høyere enn markørlisten antyder. Bare én erstatning per sett kan være på vei av gangen.
Hvis du integrerte før disse feltene fantes, leser Aniva også metadata.original_kit_id og metadata.replacement_reason ved opprettelse og behandler bestillingen som en erstatning. Dette er det eneste stedet metadata tolkes, det finnes bare for å støtte den tidligere integrasjonen, og feltene over vinner alltid. Send feltene.
En 201 betyr at bestillingen er bekreftet og sendes videre til ordrehåndtering — du trenger ikke gjøre noe mer for at settet skal bli pakket og sendt. Krever scope-et home_kit_orders_manage. Send en valgfri Idempotency-Key-header for å gjøre denne opprettelsen trygg å prøve på nytt — hvis samme nøkkel sendes igjen, returneres det opprinnelige svaret i stedet for å opprette en til. Se Idempotens.

Forespørsel

Body-parametere

string
påkrevd
UUID for pasientprofilen bestillingen av hjemmetestsett skal opprettes for.
string
påkrevd
UUID for katalogpanelet som skal bestilles. Nøyaktig ett — et hjemmetestsett tilsvarer 1:1 et fysisk settprodukt, så panelet er settet. Panel-ID-er oppgis av Aniva for partnerkontoen din; se List opp paneler. Valgfritt på en erstatning, der standardverdien er panelet fra bestillingen du erstatter.
string
UUID for bestillingen av hjemmetestsett som denne erstatter. Sender du dette, blir dette et erstatningssett — se Erstatningssett over. Bestillingen må tilhøre samme profil, og kan ikke allerede ha en erstatning på vei.
string
Hvorfor erstatningen trengs, i én setning (for eksempel Zu wenig Material, HbA1c nicht auswertbar). Påkrevd når du sender replaces_home_kit_order_id, og ignoreres ellers. Høyst 500 tegn.
integer[]
På en erstatning, markørene laboratoriet skal kjøre på nytt — normalt de det første settet ikke kunne levere. Hver av dem må være en del av det bestillingen du erstatter ba om; kryssjekk mot List opp biomarkører med home_kit=true. Utelat feltet for å kjøre hele panelet på nytt. Godtas bare sammen med replaces_home_kit_order_id, og ikke sammen med en annen panel_id. Dette krever ikke noe ekstra scope: å kjøre markører pasienten allerede har betalt for på nytt er ikke et à la carte-valg.
object
Dine egne nøkkel/verdi-par, som returneres ordrett ved hver lesing og aldri tolkes av Aniva. Bruk feltet til å sende med din egen ordrereferanse, slik at du kan koble bestillinger uten å lagre våre ID-er. Høyst 20 nøkler; nøkler må samsvare med [A-Za-z0-9_-] og ha høyst 40 tegn; verdier er en streng, et tall eller en boolsk verdi, der strenger har høyst 500 tegn; 16 384 byte serialisert totalt. Nøkler som begynner med aniva_ er reservert. Legg aldri personopplysninger eller kliniske data i metadata — det behandles ikke som pasientdata.
string[]
Opptil 5 adresser som hver får én e-post når alle laboratorieresultatene er endelige. E-posten lenker til resultatsiden i Anivas adminpanel. Nøkkelen din må ha results_view-tilgang til pasienten, ellers returneres 403. Utelat feltet for å bruke standardadressene som er angitt for pasientens gruppe. En tom liste slår e-postene av. Se E-poster om klare resultater.
object
påkrevd
Adressen settet skal sendes til — én av to former: enten { location_id } som refererer til et kjent teststed, eller adressefeltene direkte (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfrie — samme vokabular som i locations-API-et). Oppgi nøyaktig én — en stedsreferanse eller en adresse direkte, ikke begge.
Packstation eller Postfiliale (bare Tyskland): sett street til Packstation eller Postfiliale, house_number til det tresifrede stasjonsnummeret, og address_line_2 til mottakerens DHL Postnummer (6–10 sifre, mellomrom er tillatt). Uten Postnummer kan pakken ikke bestilles. Postfach støttes ikke.

Respons

Ved suksess returnerer API-et 201 Created med den nye bestillingen av hjemmetestsett.
string
påkrevd
Unik identifikator (UUID) for bestillingen av hjemmetestsett.
string
påkrevd
UUID for profilen denne bestillingen av hjemmetestsett tilhører.
string
påkrevd
Nåværende status for bestillingen av hjemmetestsett. Én av pending, dispatched, activated eller cancelled. En nyopprettet bestilling starter i pending.
object
påkrevd
Adressen settet skal sendes til – én av to former: enten { location_id } som refererer til et kjent teststed, eller direkte adressefelt (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfrie – samme struktur som i lokasjons-API-et). Oppgi nøyaktig én – en stedsreferanse eller en direkte adresse, ikke begge.
object
påkrevd
Nøkkel/verdi-parene du oppga. Alltid til stede — {} når du ikke angir noen.
string
Bestillingen av hjemmetestsett som denne erstatter. null på en vanlig bestilling.
string
Begrunnelsen du oppga. null på en vanlig bestilling.
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
Prøvekode hos laboratoriet som resultatene rapporteres under – trykt på det fysiske settet, og det pasienten leser av esken som aktiveringskode. null til settet er pakket. Skrivebeskyttet.
string
påkrevd
Tidspunkt for prøvetaking rapportert via Aktiver. null frem til settet er aktivert.
string
påkrevd
ISO 8601-tidsstempel for når bestillingen av hjemmetestsett ble opprettet.
string
ISO 8601-tidsstempel for siste oppdatering. Kan være null.
object
påkrevd
Pasientprofilen som er knyttet til denne bestillingen av hjemmetestsett.
HomeKitOrderPanel[]
påkrevd
Panelet knyttet til denne bestillingen av hjemmetestsett — det du oppga som panel_id, stemplet med opprettelsestidspunktet for bestillingen. Alltid nøyaktig ett. Slå opp paneldetaljer (navn, biomarkører) via List opp paneler.
HomeKitOrderIndividualBiomarker[]
påkrevd
Biomarkører lagt til utenfor panelet. Tom ved en vanlig opprettelse — bestillinger av hjemmetestsett bestilles per panel, og å endre denne listen i etterkant krever funksjonsscopet home_kit_orders_individual_biomarker_selection. På en erstatning inneholder den biomarker_ids du sendte, som er det laboratoriet kjører på nytt.
HomeKitOrderShipmentLink[]
påkrevd
Pakker koblet til denne bestillingen av hjemmetestsett, eldste kobling først. Alltid tom ved opprettelse — les de fullstendige pakkene med List opp forsendelser og ?home_kit_order_id=.

Feilresponser