Hopp til hovedinnhold
PATCH
Oppdater leveringsadresse, panel, metadata eller e-poster om klare resultater for en bestilling av hjemmetestsett. Ta bare med feltene du vil endre. Leveringsadressen og panelet kan bare endres mens bestillingen er pending, fordi det fysiske settet sendes ved utsendelse. metadata er din egen bokføring og kan skrives til i hele bestillingens levetid. Det finnes ingen endepunkter for å legge til eller fjerne paneler: Et hjemmetestsett inneholder nøyaktig ett panel (det tilsvarer 1:1 et fysisk settprodukt), så den eneste meningsfulle paneloperasjonen er byttet du gjør her. Krever scope-et home_kit_orders_manage.

Forespørsel

Stiparametere

string
påkrevd
Unik identifikator (UUID) for bestillingen av hjemmetestsett du vil oppdatere.

Body-parametere

Alle body-parametere er valgfrie – ta bare med feltene du vil endre.
object
Adressen settet skal sendes til — i ett av to formater: 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 feltstruktur som i steds-API-et). Oppgi nøyaktig én — en stedsreferanse eller en direkte adresse, 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.
string
UUID for panelet som skal knyttes til i stedet for det nåværende — med nøyaktig ett panel per sett er et bytte den eneste meningsfulle operasjonen. Bare mens bestillingen er pending, og bare til et panel Aniva har konfigurert med et settprodukt for utsendelse (422 ellers); et bytte til panelet som allerede er tilknyttet har ingen effekt.
object
Dine egne nøkkel/verdi-par. Slås sammen med eksisterende metadata i stedet for å erstatte dem: Nøkler du utelater blir beholdt, en nøkkel som sendes med verdien null slettes, og et tomt objekt {} tømmer alt. Grensene tilsvarer Opprett bestilling av hjemmetestsett, og valideringen er alt-eller-ingenting — hvis én nøkkel avvises, skrives ingenting. Legg aldri personlige eller kliniske data i metadata — feltet behandles ikke som pasientdata.
string[]
Erstatter listen med opptil 5 adresser som hver får én e-post når alle labresultater er endelige. Send [] for å slå av e-postene. Kan redigeres i alle statuser unntatt cancelled. Nøkkelen din trenger results_view-tilgang til pasienten, ellers returneres 403. Se E-poster om klare resultater.

Respons

Ved suksess returnerer API-et 200 OK med den oppdaterte bestillingen av hjemmetestsett og tilhørende innebygd profil.
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
Gjeldende status for bestillingen av hjemmetestsett. En av pending, dispatched, activated eller cancelled.
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.
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
Prøvetakingstidspunkt rapportert via Aktiver – når pasienten tok prøven sin. null til settet er aktivert.
string
Bestillingen av hjemmetestsett som denne erstatter, når det er et erstatningssett. null ved en vanlig bestilling. Se Opprett bestilling av hjemmetestsett.
string
Hvorfor erstatningen ble sendt. null ved 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.
object
påkrevd
Partnerdefinerte nøkkel/verdi-par, returnert uendret. Alltid med – {} når ikke angitt.
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 som er knyttet til denne bestillingen av hjemmetestsett — alltid nøyaktig ett (et hjemmetestsett tilsvarer 1:1 et fysisk settprodukt), og erstattes direkte når du sender panel_id. Slå opp paneldetaljer (navn, biomarkører) via Vis paneler.
HomeKitOrderIndividualBiomarker[]
påkrevd
Enkeltstående biomarkører som er knyttet til denne bestillingen av hjemmetestsett utenom et panel. Kryssjekk hver biomarker_id mot List opp biomarkører med home_kit=true for visningsdata.
HomeKitOrderShipmentLink[]
påkrevd
Pakker knyttet til denne bestillingen av hjemmetestsett, med den eldste først – vanligvis settet til pasienten og prøven tilbake til laboratoriet. Tom inntil lageret skriver ut en fraktetikett. Les de fullstendige pakkedetaljene med List opp forsendelser og ?home_kit_order_id=.

Feilresponser