Ana içeriğe atla
POST
Bir hasta profili için evde test kiti siparişi talep et. Evde test kiti siparişi, eve gönderilen ve kişinin kendisinin uyguladığı bir test kiti gönderir — Aniva kiti teslimat adresine kargolar, hasta evde örneğini kendisi alır ve postayla geri gönderir. Bu, bir test noktasında damardan kan alma işlemi olan randevudan farklıdır. Tam olarak bir panel gereklidir. Evde test kiti fiziksel bir kit ürünüyle 1:1 eşleşir — panelin kendisi kittir — ve sipariş oluşturulduğu anda paketleme kuyruğuna alınır, bu yüzden içeriğin baştan kesin olması gerekir. Sipariş pending durumundayken Evde test kiti siparişini güncelle üzerinden paneli yine de değiştirebilirsin.

Yedek kitler

Bir kit sonuçlarını veremediğinde — hasta tüpü dolduramamışsa, örnek yetersiz materyalle ulaşmışsa, laboratuvar örneği analiz edememişse — replaces_home_kit_order_id göndererek bir yedek kit sipariş et. Yedek kit, ilk kit hiç etkinleştirilmemiş olsa bile yeni bir laboratuvar kodu içeren yeni bir sipariştir: laboratuvarın yeni bir talebe ihtiyacı vardır ve aynı kod altındaki iki örnek birbirinden ayırt edilemez. Yerine sipariş verdiğin siparişe dokunulmaz — kendi durumunu, kendi laboratuvar kodunu ve altına daha önce işlenmiş tüm sonuçları korur. Bundan iki sonuç çıkar:
  • Panel devralınır. panel_id alanını göndermezsen yedek kit, yerine geçtiği siparişin panelini taşır; hastanın satın aldığı ve kutunun markalandığı panel budur.
  • Neyin yeniden çalışılacağını sen seçersin. Sonuç alınamayan belirteçlerle birlikte biomarker_ids gönderirsen laboratuvar yalnızca bunları yeniden çalışır, böylece kit sadece gereken tüplerle gönderilir. Tüm paneli yeniden çalışmak için bu alanı gönderme.
Belirteçler tek tek değil, panelin grupları halinde yeniden çalışılır. Bir gruptan tek bir belirteç belirtildiğinde o grubun tamamı yeniden çalışılır; çünkü istenenden fazlasını raporlayan bir laboratuvar siparişi verilemez. Tek belirteçli bir yedek kit bu nedenle birden fazla sonuçla gelebilir ve tüp sayısı belirteç listesinin düşündürdüğünden daha fazla olabilir. Bir kit için aynı anda yalnızca bir yedek kit yolda olabilir.
Entegrasyonunu bu alanlar eklenmeden önce yaptıysan Aniva, sipariş oluştururken metadata.original_kit_id ve metadata.replacement_reason alanlarını da okur ve siparişi yedek kit olarak değerlendirir. Metadata’nın yorumlandığı tek yer burasıdır, yalnızca bu eski entegrasyonu sürdürmek için vardır ve yukarıdaki alanlar her zaman önceliklidir. Bu alanları gönder.
201 yanıtı, siparişin kesinleştiği ve sipariş karşılama sürecine aktarılacağı anlamına gelir — kitin paketlenip kargolanması için başka bir şey yapmana gerek yok. home_kit_orders_manage kapsamını gerektirir. Bu oluşturma işlemini güvenle yeniden denenebilir kılmak için isteğe bağlı bir Idempotency-Key başlığı gönder — aynı anahtarın tekrarı ikincisini oluşturmak yerine ilk yanıtı döndürür. İdempotans bölümüne bak.

İstek

Gövde parametreleri

string
gerekli
Evde test kiti siparişinin oluşturulacağı hasta profilinin UUID’si.
string
gerekli
Sipariş edilecek katalog panelinin UUID’si. Tam olarak bir tane — evde test kiti fiziksel bir kit ürünüyle 1:1 eşleşir, yani panelin kendisi kittir. Panel ID’leri iş ortağı hesabın için Aniva tarafından sağlanır; Panelleri listele sayfasına bak. Yedek kit siparişinde isteğe bağlıdır; gönderilmediğinde yerine geçtiği siparişin paneli kullanılır.
string
Bu siparişin yerine geçtiği evde test kiti siparişinin UUID’si. Bunu göndermek siparişi bir yedek kit yapar — yukarıdaki Yedek kitler bölümüne bak. Sipariş aynı profile ait olmalı ve halihazırda yolda bir yedek kiti olmamalıdır.
string
Yedek kitin neden gerektiği, tek cümlede (örneğin Zu wenig Material, HbA1c nicht auswertbar). replaces_home_kit_order_id gönderdiğinde zorunludur, aksi halde yok sayılır. En fazla 500 karakter.
integer[]
Yedek kit siparişinde laboratuvarın yeniden çalışacağı belirteçler — genellikle ilk kitin sonuç veremediği belirteçlerdir. Her biri yerine geçtiği siparişin istediği belirteçlerin bir parçası olmalıdır; home_kit=true parametresiyle Biyobelirteçleri listele üzerinden kontrol et. Tüm paneli yeniden çalışmak için bu alanı gönderme. Yalnızca replaces_home_kit_order_id ile birlikte kabul edilir, farklı bir panel_id ile birlikte kabul edilmez. Bunun için ek bir kapsam gerekmez: hastanın zaten ödemesini yaptığı belirteçleri yeniden çalışmak tekil bir seçim değildir.
object
Her okumada olduğu gibi geri döndürülen ve Aniva tarafından hiçbir zaman yorumlanmayan kendi anahtar/değer çiftlerin. Bizim ID’lerimizi saklamadan eşleştirme yapabilmek için kendi sipariş referansını taşımak üzere kullan. En fazla 20 anahtar; anahtarlar [A-Za-z0-9_-] ile eşleşmeli ve en fazla 40 karakter olmalıdır; değerler metin, sayı veya boolean olabilir ve metinler en fazla 500 karakterdir; serileştirilmiş toplam boyut en fazla 16.384 bayttır. aniva_ ile başlayan anahtarlar ayrılmıştır. metadata içine asla kişisel veya klinik veri koyma — hasta verisi olarak işlenmez.
string[]
Tüm laboratuvar sonuçları kesinleştiğinde her biri bir e-posta alacak en fazla 5 adres. E-posta, Aniva yönetim panelindeki sonuç sayfasına yönlendirir. Anahtarının hasta için results_view erişimine sahip olması gerekir, aksi halde 403 döner. Hastanın grubu için ayarlanan varsayılan adresleri kullanmak için bu alanı gönderme. Boş bir liste e-postaları kapatır. Sonuçlar hazır e-postaları bölümüne bak.
object
gerekli
Kitin postalanacağı adres — iki biçimden biri olabilir: bilinen bir test noktasına referans veren { location_id } ya da satır içi adres alanları (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email isteğe bağlı — konumlar API’siyle aynı alan adları). Tam olarak birini ver — ya konum referansı ya da satır içi adres, ikisini birden değil.
Packstation veya Postfiliale (yalnızca Almanya): street alanını Packstation veya Postfiliale, house_number alanını üç haneli istasyon numarası ve address_line_2 alanını alıcının DHL Postnummer bilgisi (6–10 hane, boşluk kullanılabilir) olarak ayarla. Postnummer olmadan paket için kargo kaydı oluşturulamaz. Postfach desteklenmez.

Yanıt

İşlem başarılı olduğunda API, yeni evde test kiti siparişiyle birlikte 201 Created yanıtını döndürür.
string
gerekli
Benzersiz evde test kiti siparişi kimliği (UUID).
string
gerekli
Bu evde test kiti siparişinin ait olduğu profilin UUID’si.
string
gerekli
Mevcut evde test kiti sipariş durumu. pending, dispatched, activated veya cancelled değerlerinden biri. Yeni oluşturulan bir sipariş pending durumunda başlar.
object
gerekli
Kitin postalanacağı adres — iki biçimden biri: bilinen bir test konumuna referans veren { location_id } veya satır içi adres alanları (name, street, city, postal_code, country_code; company_name / house_number / address_line_2 / state / phone / email isteğe bağlı — konumlar API’siyle aynı terminoloji). Tam olarak birini belirt — konum referansı veya satır içi adres, ikisi birden değil.
object
gerekli
Sağladığın anahtar/değer çiftleri. Her zaman bulunur — hiç ayarlamadığında {} olur.
string
Bu siparişin yerine geçtiği evde test kiti siparişi. Normal bir siparişte null olur.
string
Sağladığın gerekçe. Normal bir siparişte null olur.
string[]
gerekli
Tüm laboratuvar sonuçları kesinleştiğinde her birine bir e-posta gönderilen, küçük harfe çevrilmiş adresler. Kapalıyken boştur. Bkz. Sonuçlar hazır e-postaları.
string
Sonuçların altında raporlandığı laboratuvar örnek kodu — fiziksel kitin üzerinde basılıdır ve hastanın kutudan etkinleştirme kodu olarak okuduğu koddur. Kit paketlenene kadar null. Salt okunur.
string
gerekli
Etkinleştir üzerinden bildirilen örnek alma zaman damgası. Kit etkinleştirilene kadar null olur.
string
gerekli
Evde test kiti siparişinin oluşturulduğu zamanın ISO 8601 zaman damgası.
string
Son güncellemenin ISO 8601 zaman damgası. null olabilir.
object
gerekli
Bu evde test kiti siparişiyle ilişkili hasta profili.
HomeKitOrderPanel[]
gerekli
Bu evde test kiti siparişine bağlı panel — panel_id olarak sağladığın ve siparişin oluşturulma zamanıyla damgalanmış panel. Her zaman tam olarak bir tane. Panel ayrıntılarına (ad, biyobelirteçler) Panelleri listele üzerinden bak.
HomeKitOrderIndividualBiomarker[]
gerekli
Panel dışında eklenen biyobelirteçler. Normal bir oluşturma işleminde boştur — evde test kiti siparişleri panel bazında verilir ve bu listeyi sonradan değiştirmek home_kit_orders_individual_biomarker_selection yetki kapsamını gerektirir. Yedek kit siparişinde, gönderdiğin ve laboratuvarın yeniden çalışacağı biomarker_ids değerlerini tutar.
HomeKitOrderShipmentLink[]
gerekli
Bu evde test kiti siparişine bağlı paketler, en eski bağlantı ilk sırada olacak şekilde. Oluşturma sırasında her zaman boştur — tüm paket bilgilerini Gönderileri listele ve ?home_kit_order_id= ile oku.

Hata yanıtları