Naar hoofdinhoud gaan
PATCH
Werk het bezorgadres, panel, de metadata of de e-mails voor beschikbare resultaten van een thuistestkitbestelling bij. Stuur alleen de velden mee die je wilt wijzigen. Het bezorgadres en het panel kunnen alleen worden gewijzigd zolang de bestelling de status pending heeft, omdat de fysieke kit bij verzending wordt verstuurd. metadata is voor je eigen administratie en blijft tijdens de hele looptijd van de bestelling beschrijfbaar. Er zijn geen endpoints om een panel toe te voegen of te verwijderen: een thuistestkit bevat precies één panel (het komt 1:1 overeen met een fysiek kitproduct), dus de enige zinvolle panelbewerking is het wisselen dat je hier doet. Vereist de scope home_kit_orders_manage.

Verzoek

Padparameters

string
vereist
Unieke identifier (UUID) van de thuistestkitbestelling die je wilt bijwerken.

Bodyparameters

Alle bodyparameters zijn optioneel — neem alleen de velden op die je wilt wijzigen.
object
Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel { location_id } dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email optioneel — dezelfde veldnamen als in de locations API). Geef precies één optie mee — een locatieverwijzing of een inline adres, niet beide.
Packstation of Postfiliale (alleen Duitsland): stel street in op Packstation of Postfiliale, house_number op het driecijferige stationsnummer en address_line_2 op het DHL-Postnummer van de ontvanger (6–10 cijfers, spaties toegestaan). Zonder het Postnummer kan het pakket niet worden geboekt. Een Postfach wordt niet ondersteund.
string
UUID van het panel dat je in plaats van het huidige wilt koppelen — met precies één panel per kit is wisselen de enige zinvolle bewerking. Alleen zolang de bestelling de status pending heeft, en alleen naar een panel waarvoor Aniva een fulfilment-kitproduct heeft geconfigureerd (anders 422); wisselen naar het reeds gekoppelde panel is een no-op.
object
Je eigen sleutel-waardeparen. Wordt samengevoegd met de bestaande metadata in plaats van deze te vervangen: sleutels die je weglaat blijven behouden, een sleutel met de waarde null wordt verwijderd en een leeg object {} wist alles. De limieten komen overeen met Thuistestkitbestelling aanmaken, en de validatie is alles-of-niets — als één sleutel wordt afgewezen, wordt er niets weggeschreven. Zet nooit persoons- of klinische gegevens in metadata — dit wordt niet als patiëntgegevens behandeld.
string[]
Vervangt de lijst van maximaal 5 adressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn. Stuur [] om de e-mails uit te schakelen. Aanpasbaar bij elke status behalve cancelled. Je sleutel heeft results_view-toegang tot de patiënt nodig, anders volgt 403. Zie E-mails voor beschikbare resultaten.

Respons

Bij succes geeft de API 200 OK terug met de bijgewerkte thuistestkitbestelling en het ingesloten profiel.
string
vereist
Unieke identifier (UUID) van de thuistestkitbestelling.
string
vereist
UUID van het profiel waarbij deze thuistestkitbestelling hoort.
string
vereist
Huidige status van de thuistestkitbestelling. Een van pending, dispatched, activated of cancelled.
object
vereist
Het adres waar de kit naartoe wordt gestuurd — in een van twee vormen: ofwel { location_id } dat verwijst naar een bekende testlocatie, ofwel de inline adresvelden (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email optioneel — dezelfde velden als de locations-API). Geef precies één vorm op — een locatieverwijzing of een inline adres, niet beide.
string
Monstercode van het laboratorium waaronder de resultaten worden gerapporteerd — afgedrukt op de fysieke kit, en wat de patiënt van de doos afleest als activeringscode. null totdat de kit is verpakt. Alleen-lezen.
string
vereist
Afnametijdstempel doorgegeven via Activeren — wanneer de patiënt het monster heeft afgenomen. null totdat de kit is geactiveerd.
string
De thuistestkitbestelling die door deze bestelling wordt vervangen, als het een vervangende kit is. null bij een normale bestelling. Zie Thuistestkitbestelling aanmaken.
string
Waarom de vervangende kit is verstuurd. null bij een normale bestelling.
string[]
vereist
E-mailadressen die elk één e-mail krijgen zodra alle labresultaten definitief zijn, in kleine letters. Leeg wanneer uitgeschakeld. Zie E-mails bij beschikbare resultaten.
object
vereist
Door de partner gedefinieerde sleutel-waardeparen, letterlijk teruggegeven. Altijd aanwezig — {} indien niet ingesteld.
string
vereist
ISO 8601-tijdstempel waarop de thuistestkitbestelling is aangemaakt.
string
ISO 8601-tijdstempel van de laatste update. Kan null zijn.
object
vereist
Het patiëntprofiel dat bij deze thuistestkitbestelling hoort.
HomeKitOrderPanel[]
vereist
Het panel dat aan deze thuistestkitbestelling is gekoppeld — altijd precies één (een thuistestkit komt 1:1 overeen met een fysiek kitproduct) en wordt direct vervangen wanneer je panel_id meestuurt. Zoek paneldetails (naam, biomarkers) op via Panels ophalen.
HomeKitOrderIndividualBiomarker[]
vereist
Losse biomarkers die buiten een panel aan deze thuistestkitbestelling zijn gekoppeld. Vergelijk elke biomarker_id met Biomarkers weergeven met home_kit=true voor weergavegegevens.
HomeKitOrderShipmentLink[]
vereist
Pakketten die aan deze thuistestkitbestelling zijn gekoppeld, oudste koppeling eerst — normaal gesproken de kit naar de patiënt en het monster terug naar het laboratorium. Leeg totdat fulfilment een label afdrukt. Lees de volledige pakketgegevens met Zendingen weergeven en ?home_kit_order_id=.

Foutresponsen