Ana içeriğe atla
POST
Yeni bir hasta profili oluştur ve bunu bir profil grubuna ata. Profil, randevularda ve laboratuvar siparişlerinde kullanılan demografik verileri tutar. create_user 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
Hastanın adı. 1 ile 100 karakter arasında olmalı ve Latin karakterleri kullanmalıdır.
string
gerekli
Hastanın soyadı. 1 ile 100 karakter arasında olmalı ve Latin karakterleri kullanmalıdır. Laboratuvarlar soyadı olmayan bir hasta için verilen siparişleri reddeder, bu nedenle soyadı olmadan profil oluşturulamaz.Test verilerini önceden oluşturmak için üç değer ayrılmıştır — bkz. Sandbox test verileri.
integer
gerekli
ISO/IEC 5218 standardına göre biyolojik cinsiyet. Erkek için 1, kadın için 2 kullan. Laboratuvar referans aralıkları için buna ihtiyaç duyar, bu nedenle 0 (bilinmiyor) değeri 400 döndürür. Profil grubun hastanın bunu kit etkinleştirme sayfasında girmesine izin vermediği sürece zorunludur. İzin veriyorsa atla. Bkz. Doğum tarihi ve cinsiyeti hastanın girmesine izin ver.
string
gerekli
YYYY-MM-DD biçiminde doğum tarihi. Geçmişte olmalı ve 1900’den önce olmamalıdır. Hesaplanan yaş 16 ile 100 arasında olmalıdır. Diğer değerler 400 döndürür. Profil grubun hastanın bunu kit etkinleştirme sayfasında girmesine izin vermediği sürece zorunludur. İzin veriyorsa atla.
string
gerekli
Bu profilin atanacağı profil grubuna yönelik çok biçimli referans (UUID veya slug). UUID değiştirilemez kimliktir ve slug yeniden adlandırmalarından etkilenmez; slug ise okunabilir kimlikler üzerine kurulu pazarlama ve iş ortağı entegrasyonları için kabul edilmeye devam eder. UUID tercih edilir. Profil grubu, API anahtarının erişim bağlamı içinde olmalıdır. Kullanımdan kaldırılan profile_group_slug alanını göndermiyorsan zorunludur.
string
kullanımdan kaldırıldı
Kullanımdan kaldırıldı: profile_group kullan. Profil grubunun slug değeri. Yalnızca küçük harfler, rakamlar, tireler ve alt çizgiler.
string
Profilin e-posta adresi. Gönderilmezse Aniva otomatik olarak bir e-posta adresi oluşturur.email sağlamak oluşturma işlemini yeniden denemeye karşı güvenli kılar: bir adrese yalnızca tek bir profil bağlı olabilir, bu nedenle tekrarlanan bir istek ikinci bir profil yerine 409 döndürür. Otomatik oluşturulan adresler her istek için benzersizdir. Entegrasyonun yeniden deneme yapıyorsa email veya bir Idempotency-Key gönder.
string
E.164 biçiminde telefon numarası (ör. +14155552671).
number
Santimetre cinsinden boy.
number
Kilogram cinsinden kilo.
string
varsayılan:"en"
Profil için tercih edilen dil: en, bg, ca, cs, da, de, el, es, et, fi, fr, ga, hr, hu, is, it, lb, lt, lv, mt, nl, no, pl, pt, ro, ru, sk, sl, sr, sv, tr veya uk. Varsayılan olarak en kullanılır.
boolean
Bu profilin işlemsel (programatik) e-postaları — randevu onayları, sonuçların hazır olduğuna dair bildirimler vb. — alıp almayacağı. Profil grubunun varsayılanını geçersiz kılar. Pazarlama onayından ayrıdır. Varsayılanı kullanmak için atla.
boolean
Bu profilin pazarlama e-postalarına (bültenler, ürün güncellemeleri) onay verip vermediği. Profil grubunun varsayılanını geçersiz kılar. İşlemsel e-postalardan ayrıdır. Profil grubunun varsayılanını kullanmak için atla. Yalnızca yazılabilir: profil yanıtında döndürülmez.

Sandbox test verileri

Test etmeye değer her okuma yolu — Randevuları listele, Sonuçları al, Belge indir — günler sonra gerçek bir kan alma işlemi yapılana kadar boştur. Bu da otomatik bir entegrasyon testi yazmayı zorlaştırır. Bunu çözmek için üç last_name değeri ayrılmıştır. Bunlardan biriyle bir profil oluştur; Aniva yanıt vermeden önce aşağıda açıklanan durumu önceden doldurur, böylece bir sonraki çağrın bunu hazır olarak görür: Eşleştirme büyük/küçük harfe duyarsızdır. date_of_birth ve sex dahil diğer tüm alanlar normal şekilde saklanır ve kullanılır; böylece geri aldığın referans aralıkları, oluşturduğun profile ait gerçek yaş ve cinsiyete özel aralıklardır. Randevu Aniva Test konumunda, bugünden en az beş gün sonraki (veya geçmiş durumlar için beş gün önceki) gerçekten randevu alınabilir bir zaman dilimine alınır. Bu veriyi oluşturmak laboratuvar siparişi vermez ve kurye ayarlamaz.
Test profillerine kontrol ettiğin bir adres ver. Aniva’nın randevu hatırlatıcıları scheduled_at alanına göre çalışır; bu nedenle profil transactional_emails_enabled: false ile devre dışı bırakılmadığı sürece yaklaşan test verisi bu hatırlatıcıları gönderir.
Panel, API anahtarının görebildiği paneller arasından rastgele seçilir; bu nedenle panel_id değeri her zaman kendi Panelleri listele sonucunla eşleşir. Klinik biyobelirteçler biyobelirtecin referans aralığı içinde bir değer alır; genler ise Aniva’nın referans verilerinden rastgele bir genotip alır ve eşleşen varyantlar, klinik anlamlılık ile rs ID’leri buna göre belirlenir.
Panel ve değerler her oluşturma işleminde yeniden üretilir; bu nedenle belirli bir panel veya kesin sayılar yerine veri yapısını doğrula.

Yanıt

İşlem başarılı olursa API, yeni oluşturulan profille birlikte 201 Created döndürür.
string
gerekli
Benzersiz profil kimliği (UUID).
string
Profil tanıtıcısı veya kullanıcı adı. null olabilir.
string
Ad. null olabilir.
string
Soyad. null olabilir.
string
E-posta adresi. null olabilir.
string
E.164 biçiminde telefon numarası. null olabilir.
integer
ISO/IEC 5218’e göre biyolojik cinsiyet (0 = bilinmiyor, 1 = erkek, 2 = kadın). null olabilir.
string
YYYY-MM-DD biçiminde doğum tarihi. null olabilir.
number
Santimetre cinsinden boy. null olabilir.
number
Kilogram cinsinden kilo. null olabilir.
string
Tercih edilen dil, yukarıdaki 32 koddan biri.
boolean
Bu profilin işlemsel (programatik) e-postaları alıp almayacağı. Hiç ayarlanmadığında null.
string
Profilin oluşturulduğu zamanın ISO 8601 zaman damgası.
string
Son güncellemenin ISO 8601 zaman damgası. Yeni oluşturulan profiller için null.

Hata yanıtları

Bir 409 yanıtı şu şekilde görünür — bunu “bu profil zaten var” şeklinde ele al ve oluşturmayı yeniden denemek yerine Profilleri listele (?email=) ile profili ara:
Anahtarının görebildiği bir profille aynı ad, soyad, cinsiyet ve doğum tarihine sahip bir kişi için error_name: "duplicate_profile_error" içeren bir 409 döner. İkinci bir profil oluşturmak yerine döndürülen profile_id değerini kullan:
Test verisi oluşturan sandbox soyadları hariç tutulur.