Skip to main content
Hasta formları (anamnez, onam formu vb.) hastanın giriş yapmadan doldurabileceği bir link ile paylaşılır. Kendi form sayfanızı yazmak isterseniz bu linkin arkasındaki açık API’yi kullanırsınız: bir GET ile formu okur, bir POST ile yanıtları gönderirsiniz. Bu uçlar OAuth gerektirmez. Authorization ve X-Tenant başlıkları gönderilmez; tek kimlik bilgisi yolundaki form token’ıdır.

Form linki

Form linkini klinik adına yetkili bir istemci oluşturur: POST /api/v1/form-templates/{id}/links. Bu çağrı form_templates:write scope’unu ve GenerateLink:FormTemplate iznini gerektirir. Ayrıntılar için Hasta formları ve Hasta formu gönderme sayfalarına bakın. Gövdede isteğe bağlı customer_id gönderebilirsiniz. Boş bırakırsanız link anonim olur: URL’yi bilen herkes formu doldurabilir ve yanıtlar hiçbir hastaya bağlanmaz. Yanıt 201 döner:
Her çağrı yeni bir bekleyen (pending) form oluşturur. token, 6 karakterlik rastgele büyük harf ve rakam dizisidir. Açık uçların yoluna {token} olarak aynen yazılır.
url, hastanın tarayıcıda açacağı Flextell form sayfasıdır. Bu sayfayı kullanırsanız aşağıdaki uçları çağırmanız gerekmez. Kendi sayfanızı yazıyorsanız yalnızca token değerini alıp açık API’yi kullanın.

Formu okuma

Başarılı yanıt 200 döner ve Cache-Control: no-store başlığı taşır. Yanıt klinik, hasta veya personel bilgisi içermez.

Soru nesnesi

Her görünürlük kuralı id, depends_on_question_id, operator, value ve match_type alanlarını taşır. operator değerleri: equals, not_equals, in, not_in, greater_than, less_than, contains.
Kendi sayfanızda, bir sorunun kuralları sağlanmıyorsa o soruyu gizleyin. Sunucu gizli sorulardaki yanıtları doğrulamaz ve kaydetmez.

Formu gönderme

answers zorunludur ve anahtarları soru kimliği olan bir nesnedir.
Başarılı yanıt 200 döner ve Cache-Control: no-store başlığı taşır:

Yanıt değerleri

Kurallar:
  • Zorunlu (required) ve görünür her soru yanıtlanmalıdır.
  • Gizli sorular doğrulanmaz ve yanıtları atılır.
  • Başka şablona ait soru kimlikleri ve sayısal olmayan anahtarlar yok sayılır.
  • Gönderim tek seferliktir. Yanıtlar kaydedilince form completed olur ve completed_at dolar.
  • Aynı anda gelen iki gönderimden yalnızca biri kaydedilir.

Yanıt biçimleri

Hata gövdeleri API’nin genel hata yapısını izler. Ayrıntı için Hatalar sayfasına bakın. Hata mesajları Accept-Language başlığına göre yerelleştirilir.
404 yanıtı, token’ın yanlış olmasıyla şablonun ya da hastanın silinmiş olması arasında ayrım yapmaz. Bu bilinçlidir: token tahmin etmeye çalışan biri hiçbir şey öğrenemez.

Doğrulama hataları

422 yanıtında hatalar answers.{soru_id} anahtarıyla gelir. Checkbox öğeleri için anahtar answers.{soru_id}.{n} olur. Alan adı olarak sorunun label değeri kullanılır. Örneğin zorunlu Ad Soyad sorusu boş bırakılırsa answers.101 anahtarı altında The Ad Soyad field is required. biçiminde bir mesaj gelir. Hata gövdesinin genel yapısı için Hatalar sayfasına bakın.

Tek kullanımlık formlar

Her link bir kez doldurulabilir.
  1. Link oluşturulduğunda form pending durumundadır.
  2. Başarılı bir POST formu completed yapar.
  3. Bundan sonra aynı token ile hem GET hem POST 409 CUSTOMER_FORM_ALREADY_COMPLETED döndürür.
Hastaya yeniden doldurtmak için yeni bir link oluşturun. Başarısız (örneğin 422) bir gönderim formu tamamlamaz; hasta düzeltip yeniden gönderebilir.
Formu doldurmak hastanın ön görüşme (intake) durumunu değiştirmez. Bu uçlar kliniğin faturalama veya kurulum durumuna da bağlı değildir.

Oran sınırları

Sınırlar form token’ına değil, istemcinin IP adresine uygulanır. Token’lar kısa olduğu için sınır tüm token’ları birlikte sayar; böylece token tahmini engellenir. Sınır aşılınca 429 TOO_MANY_REQUESTS döner. Yanıt, oran sınırı başlıklarını ve Retry-After değerini taşır; beklenen süre dolmadan yeniden denemeyin. Kimliği doğrulanmış API’nin sınırları farklıdır: Oran sınırları.
Form sayfasını sunucunuz üzerinden çağırırsanız tüm hastalar aynı IP’den görünür ve sınırı birlikte tüketir. Çağrıları hastanın tarayıcısından yapın.

İlgili sayfalar

Hasta formları

Form şablonları, link oluşturma ve doldurulan formlar.

Hasta formu gönderme

Link oluşturmadan yanıtları okumaya uçtan uca akış.