İçeriğe geç

Sağlık

Sağlık uçları: parametreler, alanlar ve örnek yanıtlar.

Geliştirici belgesi

Nöbet listesini döndürür (hangi personel hangi gün hangi nöbette ya da çalışma saatinde)

GET /api/v1/health/duty-roster

Kapsam: health_scheduling:read

Şirketin seçilen günlerdeki etkin nöbet ve çalışma atamaları; Sağlık › Raporlar ekranındaki HBYS nöbet listesi dosyasıyla aynı satırlar. Eşleme anahtarı planlama kartının personel kodudur; T.C. kimlik no dönmez. Anahtarın rolü planlama kartını görmüyorsa staff_code null'dır. Aralık en çok 31 gündür. Sıra kimliğe göredir; örnek kayıtlar listeye girmez.

Parametreler

health.duty_roster.list: Parametreler
AlanTürAçıklama
company_id (sorgu)string (uuid)zorunluŞirket. Anahtarın kapsamında değilse liste boştur.
employee_id (sorgu)string (uuid)Yalnız bu çalışan.
from (sorgu)string (date)zorunluİlk gün (YYYY-MM-DD).
org_unit_id (sorgu)string (uuid)Yalnız bu birimdeki kişiler (kişinin bugünkü birimi).
to (sorgu)string (date)zorunluSon gün (YYYY-MM-DD), from ile en çok 31 gün.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

health.duty_roster.list: Listedeki her öğe (data[])
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
employee_idstring (uuid)zorunlu
staff_codestringzorunlunull olabilirPlanlama kartındaki personel kodu (kurumun kendi kodu); rol planlama kartını görmüyorsa null.
first_namestringzorunlu
last_namestringzorunlu
job_titlestringzorunlunull olabilir
unitstringzorunlunull olabilirKişinin bugünkü birimi.
datestring (date)zorunluAtamanın başladığı gün.
shift_codestringzorunlu
shift_namestringzorunlu
shift_kindstringzorunluduty24: 24 saatlik nöbet, on_call: icap, normal, flexible, half. Değerler: normal, duty24, on_call, flexible, half
start_timestringzorunlu
end_timestringzorunluBitiş saati (SS:DD); başlangıçtan küçük ya da eşitse ertesi gündür.
Örnek yanıt
{
  "data": [
    {
      "id": "5c4b3a29-1807-4f6e-9d5c-4b3a29180706",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "staff_code": "DR-0042",
      "first_name": "Deniz",
      "last_name": "Kaya",
      "job_title": "Uzman Hekim",
      "unit": "Acil Servis",
      "date": "2026-12-02",
      "shift_code": "N24",
      "shift_name": "24 saat nobet",
      "shift_kind": "duty24",
      "start_time": "08:00",
      "end_time": "08:00"
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Hekim uygunluğunu FHIR Slot durumlarıyla döndürür

GET /api/v1/health/physician-availability

Kapsam: health_scheduling:read

Personel kodu olan her hekim için seçilen günleri boşluksuz aralıklara böler: busy-unavailable (onaylı izin, nöbet ya da icap), busy-tentative (onay bekleyen izin), free. İzin türü, tanı, not ve T.C. kimlik no dönmez. Anahtarın rolü planlama kartını ya da izni göremediği kişiyi listelemez; hiç göremiyorsa 403. Aralık en çok 31 gündür; sınırlar kiracının saat dilimindedir.

Parametreler

health.physician_availability.list: Parametreler
AlanTürAçıklama
company_id (sorgu)string (uuid)Yalnız bu şirketin hekimleri.
employee_id (sorgu)string (uuid)Yalnız bu hekim.
from (sorgu)string (date)zorunluİlk gün (YYYY-MM-DD).
to (sorgu)string (date)zorunluSon gün (YYYY-MM-DD), from ile en çok 31 gün.
cursor (sorgu)stringÖnceki yanıtın next_cursor değeri. Opaktır; aynı anahtarla ve aynı süzgeçle gönderilir.
limit (sorgu)integerSayfa boyutu; azamiyi aşan değer azamiye iner.

Yanıtlar

200 Başarılı

Liste yanıtı { data, next_cursor } zarfındadır.

health.physician_availability.list: Listedeki her öğe (data[])
AlanTürAçıklama
employee_idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
staff_codestringzorunluPlanlama kartındaki personel kodu.
slotsobject[]zorunluAralıklar: başlangıç, bitiş (UTC) ve FHIR Slot durumu (free, busy-unavailable, busy-tentative).
Örnek yanıt
{
  "data": [
    {
      "employee_id": "3f2b1c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
      "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
      "staff_code": "DR-0042",
      "slots": [
        {
          "start": "2026-12-01T21:00:00.000Z",
          "end": "2026-12-02T05:00:00.000Z",
          "status": "free"
        },
        {
          "start": "2026-12-02T05:00:00.000Z",
          "end": "2026-12-03T05:00:00.000Z",
          "status": "busy-unavailable"
        },
        {
          "start": "2026-12-03T05:00:00.000Z",
          "end": "2026-12-03T21:00:00.000Z",
          "status": "busy-tentative"
        }
      ]
    }
  ],
  "next_cursor": null
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout

Hekim performans primlerini yazar

POST /api/v1/health/physician-premiums

Kapsam: health_premiums:write

Sağlık › Nöbet ücreti ekranındaki HBYS prim dosyasının kurallarıyla: çalışan kimliği ya da personel kodu, ay, tutar (TL) ve isteğe bağlı kalem. Aynı çalışan, ay ve kalem şirkette bir kez yazılır; bordrosu onaylanmış ayın satırı hatadır. Bir satır hatalıysa hiçbir satır yazılmaz ve hatalar satır numarasıyla döner. Idempotency-Key zorunludur. Yanıt işin özetidir; tutar ve kişi yanıtta yoktur. Bordroya aktarım ekrandan yapılır.

Parametreler

health.physician_premiums.create: Parametreler
AlanTürAçıklama
Idempotency-Key (başlık)stringzorunluİsteğin tekil anahtarı (UUID önerilir). Aynı anahtar ve gövdeyle yinelenen istek kaynağın güncel hâlini ve Idempotent-Replayed: true döner; pencere 24 saattir.

İstek gövdesi

health.physician_premiums.create: İstek gövdesi
AlanTürAçıklama
company_idstring (uuid)zorunluŞirket. Anahtarın yazma kapsamı şirketi bütünüyle kapsamalıdır.
rowsobject[]zorunluSatırlar (1-500).

Yanıtlar

201 Oluşturuldu

health.physician_premiums.create: Yanıtlar
AlanTürAçıklama
idstring (uuid)zorunlu
company_idstring (uuid)zorunlu
statusstringzorunluapplied: yazıldı; undone: ekrandan geri alındı. Değerler: applied, undone
rowsintegerzorunluYazılan satır sayısı.
created_atstring (date-time)zorunlu
Örnek yanıt
{
  "id": "9e8d7c6b-5a49-4382-a716-f5e4d3c2b1a0",
  "company_id": "0b8f6c1e-5f0a-4c7e-9a43-2f6f3a1d9c10",
  "status": "applied",
  "rows": 2,
  "created_at": "2026-12-05T09:00:00.000Z"
}

Hata kodları

  • 400: bad_request, validation_failed, key_in_query, cookie_with_key, idempotency_key_required, idempotency_key_invalid, cursor_invalid
  • 401: unauthorized
  • 403: insufficient_scope, forbidden, module_disabled, trial_ended, key_suspended
  • 404: not_found
  • 409: idempotency_in_progress, conflict
  • 413: payload_too_large
  • 415: unsupported_media_type
  • 422: idempotency_key_reused
  • 429: rate_limited
  • 500: internal_error
  • 503: timeout