Spring til hovedindhold
POST
Anmod om en ordre på et hjemmetestkit til en patientprofil. En ordre på et hjemmetestkit sender et gør-det-selv-testkit med posten — Aniva sender kittet til leveringsadressen, patienten tager selv en prøve derhjemme og sender den tilbage. Det adskiller sig fra en tid, som er en venøs blodprøvetagning på et teststed. Der kræves præcis ét panel. Et hjemmetestkit svarer 1:1 til et fysisk kitprodukt — panelet er kittet — og ordren kommer i pakkekøen, så snart den oprettes, så sammensætningen skal ligge fast fra starten. Du kan stadig skifte panelet via Opdater ordre på hjemmetestkit, mens ordren har status pending.

Erstatningskits

Når et kit ikke kan levere sine resultater — patienten kunne ikke fylde røret, prøven ankom med for lidt materiale, laboratoriet kunne ikke analysere den — så bestil en erstatning ved at sende replaces_home_kit_order_id. En erstatning er en ny ordre med en ny laboratoriekode, også når det første kit aldrig blev aktiveret: Laboratoriet har brug for en ny rekvisition, og to prøver med samme kode kan ikke skelnes fra hinanden. Den ordre, du erstatter, røres ikke — den beholder sin egen status, sin egen laboratoriekode og eventuelle resultater, der allerede er registreret under den. To ting følger af det:
  • Panelet nedarves. Udelad panel_id, så overtager erstatningen panelet fra den ordre, den erstatter, hvilket er det, patienten har købt, og sådan æsken er brandet.
  • Du vælger, hvad der skal køres igen. Send biomarker_ids med de markører, der fejlede, så kører laboratoriet kun dem igen, og kittet indeholder kun de rør, de kræver. Udelad feltet for at køre hele panelet igen.
Markører køres igen som panelets grupper, ikke én ad gangen. Angiver du én markør i en gruppe, køres hele gruppen igen, fordi der ikke kan oprettes en laboratorieordre, som rapporterer mere, end der blev bestilt. En erstatning med én markør kan derfor komme tilbage med mere end ét resultat, og antallet af rør kan være større, end listen over markører antyder. Der må kun være én erstatning pr. kit på vej ad gangen.
Hvis du integrerede, før disse felter fandtes, læser Aniva også metadata.original_kit_id og metadata.replacement_reason ved oprettelse og behandler ordren som en erstatning. Det er det eneste sted, hvor metadata fortolkes; det findes kun for at understøtte den tidligere integration, og felterne ovenfor vinder altid. Send felterne.
En 201 betyder, at ordren er bekræftet og sendes videre til ekspedition — du behøver ikke gøre andet, for at kittet bliver pakket og sendt. Kræver scopet home_kit_orders_manage. Send en valgfri Idempotency-Key-header for at gøre denne oprettelse sikker at prøve igen — gentages den samme nøgle, returneres det oprindelige svar i stedet for at oprette endnu en. Se Idempotens.

Forespørgsel

Body-parametre

string
påkrævet
UUID for den patientprofil, som ordren på hjemmetestkittet skal oprettes til.
string
påkrævet
UUID for det katalogpanel, der skal bestilles. Præcis ét — et hjemmetestkit svarer 1:1 til et fysisk kitprodukt, så panelet er kittet. Panel-ID’er udleveres af Aniva til din partnerkonto; se Vis paneler. Valgfrit ved en erstatning, hvor det som standard bruger panelet fra den ordre, du erstatter.
string
UUID for den ordre på et hjemmetestkit, som denne erstatter. Sender du det, bliver ordren et erstatningskit — se Erstatningskits ovenfor. Ordren skal tilhøre samme profil og må ikke allerede have en erstatning på vej.
string
Hvorfor erstatningen er nødvendig, i én sætning (for eksempel Zu wenig Material, HbA1c nicht auswertbar). Påkrævet, når du sender replaces_home_kit_order_id, og ignoreres ellers. Højst 500 tegn.
integer[]
Ved en erstatning de markører, laboratoriet kører igen — normalt dem, det første kit ikke kunne levere. Hver markør skal være en del af det, den erstattede ordre bestilte; krydstjek med Vis biomarkører med home_kit=true. Udelad feltet for at køre hele panelet igen. Accepteres kun sammen med replaces_home_kit_order_id og ikke sammen med et andet panel_id. Det kræver intet ekstra scope: At køre markører igen, som patienten allerede har betalt for, er ikke et à la carte-valg.
object
Dine egne nøgle/værdi-par, som returneres ordret ved hver læsning og aldrig fortolkes af Aniva. Brug det til din egen ordrereference, så du kan koble data sammen uden at gemme vores ID’er. Højst 20 nøgler; nøgler skal matche [A-Za-z0-9_-] og må højst være 40 tegn; værdier skal være en streng, et tal eller en boolean, hvor strenge højst må være 500 tegn; 16.384 bytes serialiseret i alt. Nøgler, der begynder med aniva_, er reserverede. Læg aldrig personlige eller kliniske data i metadata — det behandles ikke som patientdata.
string[]
Op til 5 adresser, der hver får én e-mail, når alle laboratorieresultater er endelige. E-mailen linker til resultatsiden i Anivas adminpanel. Din nøgle skal have results_view-adgang til patienten, ellers 403. Udelad feltet for at bruge de standardadresser, der er angivet for patientens gruppe. En tom liste slår e-mails fra. Se E-mails om færdige resultater.
object
påkrævet
Adressen, kittet skal sendes til — i én af to former: enten { location_id }, der henviser til et kendt teststed, eller de inline-adressefelter (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfrie — samme feltnavne som i locations-API’et). Angiv præcis én — en henvisning til et teststed eller en inline-adresse, ikke begge.
Packstation eller Postfiliale (kun Tyskland): Sæt street til Packstation eller Postfiliale, house_number til det trecifrede stationsnummer og address_line_2 til modtagerens DHL Postnummer (6–10 cifre, mellemrum tilladt). Uden Postnummer kan pakken ikke bookes. Postfach understøttes ikke.

Svar

Ved succes returnerer API’et 201 Created med den nye ordre på hjemmetestkittet.
string
påkrævet
Unikt id (UUID) for hjemmetestkitordren.
string
påkrævet
UUID for den profil, som denne hjemmetestkitordre tilhører.
string
påkrævet
Aktuel status for ordren på hjemmetestkittet. En af pending, dispatched, activated eller cancelled. En nyoprettet ordre starter som pending.
object
påkrævet
Adressen, som kittet skal sendes til — i en af to former: enten { location_id }, der henviser til en kendt testlokation, eller de direkte adressefelter (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email er valgfri — samme feltnavne som i locations-API’et). Angiv præcis én — enten en lokationsreference eller en direkte adresse, ikke begge dele.
object
påkrævet
De nøgle/værdi-par, du har angivet. Altid til stede — {}, når du ikke angiver nogen.
string
Den ordre på et hjemmetestkit, som denne erstatter. null ved en almindelig ordre.
string
Den årsag, du har angivet. null ved en almindelig ordre.
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
Laboratoriets prøvekode, som resultaterne rapporteres under — trykt på det fysiske kit, og det, patienten aflæser på æsken som aktiveringskode. null, indtil kittet er pakket. Skrivebeskyttet.
string
påkrævet
Tidspunkt for prøvetagning rapporteret via Aktiver. null, indtil kittet er aktiveret.
string
påkrævet
ISO 8601-tidsstempel for, hvornår hjemmetestkitordren blev oprettet.
string
ISO 8601-tidsstempel for den seneste opdatering. Kan være null.
object
påkrævet
Patientprofilen, der er knyttet til denne hjemmetestkitordre.
HomeKitOrderPanel[]
påkrævet
Panelet, der er knyttet til denne ordre på et hjemmetestkit — det, du angav som panel_id, stemplet med ordrens oprettelsestidspunkt. Altid præcis ét. Slå paneldetaljer (navn, biomarkører) op via Vis paneler.
HomeKitOrderIndividualBiomarker[]
påkrævet
Biomarkører tilknyttet uden for panelet. Tom ved en almindelig oprettelse — ordrer på hjemmetestkits bestilles pr. panel, og ændring af denne liste bagefter kræver home_kit_orders_individual_biomarker_selection-scopet. Ved en erstatning indeholder den de biomarker_ids, du sendte, som er dem, laboratoriet kører igen.
HomeKitOrderShipmentLink[]
påkrævet
Pakker knyttet til denne ordre på et hjemmetestkit, ældste tilknytning først. Altid tom ved oprettelse — hent de fulde pakkeoplysninger med Vis forsendelser og ?home_kit_order_id=.

Fejlsvar