Ana içeriğe atla
GET
Bir evde test kiti siparişi için klinik ve genetik laboratuvar sonuçlarını, laboratuvar raporu PDF’lerinin belge referanslarıyla birlikte al. Kit için sipariş edilen her biyobelirteç yanıtta görünür; böylece yalnızca geri dönenleri değil, tüm siparişi takip edebilirsin. Sonuçlar siparişin lab_code kodu altında toplanır — laboratuvar siparişi etkinleştirme sırasında verilir ve laboratuvar belirteçleri analiz edildikçe tek tek raporlar; bu yüzden kısmi veri gelmesi normaldir ve üst düzey status alanı son rapora kadar in_progress olarak kalır. value değerini kullanmadan önce her sonuçtaki status alanını oku:
  • Sipariş in_progress durumundayken henüz tamamlanmamış testler planned durumuyla görünür. Bu uç noktayı etkinleştirmeden önce de çağırabilirsin — o durumda sipariş edilen her belirteç planned olur.
  • Laboratuvarın ilettiği ancak klinik olarak kullanılmaması gereken sonuçlar fault veya undeliverable durumuyla görünür ve nedenini açıklayan bir status_reason taşır. fault durumundaki bir sonuçta value alanı yine de doludur — bu değer yanlıştır. Asla bulgu olarak gösterme.
  • Aniva’nın veya üyenin şüphe duyduğu sonuçlar likely_wrong durumu ve bir status_reason ile görünür. Değer doğrulanmamıştır. İncelenmeden bulgu olarak gösterme.
documents dizisinde referans verilen laboratuvar raporu PDF’lerini Belgeyi indir ile indir. Bu uç noktayı düzenli aralıklarla sorgulamana gerek yok. home_kit_order.results.updated veya home_kit_order.results.completed webhook’larına abone ol ve bir olay geldiğinde uç noktayı çağır. Yedek yöntem olarak periyodik sorgulama da çalışır. results_view kapsamını — laboratuvar sonuçları ve belgeler, randevu sonuçları ve Belge indir gibi her zaman bu kapsama bağlıdır — ve kit siparişinin kendisine erişmek için home_kit_orders_view veya home_kit_orders_manage kapsamını gerektirir.

İstek

Yol parametreleri

string
gerekli
Sonuçları alınacak evde test kiti siparişinin benzersiz kimliği (UUID).

Yanıt

Başarılı olduğunda API, sonuçlar nesnesiyle birlikte 200 OK döndürür.
string
gerekli
Genel sonuç durumu. Şunlardan biri:
  • in_progress — bazı istemler hâlâ laboratuvarda.
  • completed — her istem kapandı ve en az biri rapor verdi.
  • fault — her istem rapor vermeden sonlandı. Beklenen bir şey kalmadı.
object[]
gerekli
Her laboratuvar istemi için bir giriş — birden fazla tüpü veya laboratuvarı kapsayan bir kan almada birden fazla giriş bulunur. Her giriş kapandığında ve biri rapor verdiğinde üst düzey status completed olur.
object[]
gerekli
Klinik biyobelirteç sonuçları dizisi.
object[]
gerekli
Genetik biyobelirteç sonuçları dizisi.
object[]
gerekli
Laboratuvar raporu belgeleri. Her dosyayı indirmek için GET /api/v1/documents/{id} kullan.

Tekrarlanan çağrılar

Aniva, bu uç noktanın yanıtını her API anahtarı için 60 dakika saklar. Bu süre içinde yapılan tekrarlı bir çağrı, evde test kiti siparişi ve sonuçları değişmediği sürece saklanan yanıtı alır. Bir değişiklikten sonra güncel bir yanıt alırsın. Cache-Status ve Age başlıkları yanıtın saklandığını ve ne kadar eski olduğunu gösterir. Bir değişiklikten hemen haberdar olmak için home_kit_order.results.updated, home_kit_order.results.completed ve home_kit_order.results.fault webhook olaylarına abone ol. Bkz. Tekrarlı okumalar.

Hata yanıtları