Pāriet uz galveno saturu
GET
Iegūsti vienu mājas testa komplekta pasūtījumu pēc tā UUID, ieskaitot iekļauto pacienta profilu. Izmanto šo galapunktu, lai pārbaudītu pasūtījuma statusu, apskatītu piegādes adresi vai pārbaudītu pievienotos paneļus un biomarķierus. Nepieciešams home_kit_orders_view vai home_kit_orders_manage tvērums.

Pieprasījums

Ceļa parametri

string
obligāts
Unikāls identifikators (UUID) mājas testa komplekta pasūtījumam, kuru iegūt.

Atbilde

Veiksmīgas izpildes gadījumā API atgriež 200 OK ar mājas testa komplekta pasūtījumu un tā iekļauto profilu.
string
obligāts
Unikālais mājas testa komplekta pasūtījuma identifikators (UUID).
string
obligāts
Tā profila UUID, kuram pieder šis mājas testa komplekta pasūtījums.
string
obligāts
Pašreizējais mājas testa komplekta pasūtījuma statuss. Viena no vērtībām: pending, dispatched, activated vai cancelled. Detalizēta informācija par laboratorijas rezultātu gatavību tiek iegūta no Iegūt rezultātus.
object
obligāts
Adrese, uz kuru nosūtīt komplektu — vienā no divām formām: vai nu { location_id }, kas atsaucas uz zināmu testēšanas vietu, vai tiešās adreses lauki (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email nav obligāti — tie paši lauki kā atrašanās vietu API). Norādi tieši vienu — atsauci uz vietu vai tiešo adresi, ne abas.
string
Laboratorijas parauga kods, zem kura tiek ziņoti rezultāti — uzdrukāts uz fiziskā komplekta, un tas ir kods, ko pacients nolasa no kastītes kā aktivizācijas kodu. null, līdz komplekts ir iepakots. Tikai lasīšanai.
string
obligāts
Parauga paņemšanas laikspiedols, kas ziņots ar Aktivizēt — kad pacients paņēma paraugu. null, līdz komplekts ir aktivizēts.
string
Mājas testa komplekta pasūtījums, ko šis aizstāj, ja tas ir aizstāšanas komplekts. null parastam pasūtījumam. Skati Izveidot mājas testa komplekta pasūtījumu.
string
Kāpēc tika nosūtīts aizstāšanas komplekts. null parastam pasūtījumam.
string[]
obligāts
Adreses mazajiem burtiem, no kurām katra saņem vienu e-pastu, tiklīdz visi laboratorijas rezultāti ir galīgi. Tukšs, kad izslēgts. Skatīt E-pasti par gataviem rezultātiem.
object
obligāts
Partnera definēti atslēgu un vērtību pāri, kas tiek atgriezti nemainītā veidā. Vienmēr norādīts — {}, ja nav iestatīts.
string
obligāts
ISO 8601 laikspiedols, kad tika izveidots mājas testa komplekta pasūtījums.
string
Pēdējā atjauninājuma ISO 8601 laikspiedols. Var būt null.
object
obligāts
Pacienta profils, kas saistīts ar šo mājas testa komplekta pasūtījumu.
HomeKitOrderPanel[]
obligāts
Šim mājas testa komplekta pasūtījumam pievienotais panelis — vienmēr tieši viens (mājas testa komplekts 1:1 atbilst fiziskam komplekta produktam), un to var nomainīt ar Atjaunināt, kamēr tas ir pending. Paneļa informāciju (nosaukumu, biomarķierus) meklē sadaļā Paneļu saraksts.
HomeKitOrderIndividualBiomarker[]
obligāts
Atsevišķi izvēlēti biomarķieri, kas pievienoti šim mājas testa komplekta pasūtījumam ārpus jebkura paneļa. Salīdzini katru biomarker_id ar Biomarķieru saraksts un home_kit=true, lai iegūtu attēlošanas datus.
HomeKitOrderShipmentLink[]
obligāts
Pakas, kas saistītas ar šo mājas testa komplekta pasūtījumu, sākot ar vecāko saiti — parasti komplekts pacientam un paraugs atpakaļ uz laboratoriju. Tukšs, līdz izpildes dienests izdrukā uzlīmi. Pilnu paku informāciju lasi ar Sūtījumu saraksts un ?home_kit_order_id=.

Atkārtoti izsaukumi

Aniva saglabā šī galapunkta atbildi 60 minūtes katrai API atslēgai. Atkārtots pieprasījums šajā laikā saņem saglabāto atbildi, kamēr mājas testa komplekta pasūtījums nav mainījies. Pēc izmaiņām tu saņem svaigu atbildi. Galvenes Cache-Status un Age rāda, ka atbilde ir saglabāta un cik veca tā ir. Lai par izmaiņām uzzinātu uzreiz, abonē tīmekļa āķa notikumus home_kit_order.created un katra statusa notikumu, piemēram, home_kit_order.activated. Skati Atkārtota lasīšana.

Kļūdu atbildes