Przejdź do treści

CodeableConcept

CodeableConcept (pojęcie kodowane) to typ danych oznaczający wartość opisaną kodem z systemu terminologii i/lub tekstem – np. rola strony (customer, supplier), status (active, inactive), typ dokumentu, stawka VAT. Wzorowany na FHIR CodeableConcept: jeden element może zawierać kilka kodów z różnych systemów (coding[]) oraz tekst do wyświetlania (text).

1. Zakres i zastosowanie

CodeableConcept służy do:

  • Ról i typów – w PartyRole pole role (customer, supplier, payer…), w Party type (osoba, firma), status, category.
  • Klasyfikacji – cel identyfikatora w Identifier (type, kody FHIR v2-0203), typ adresu, rodzaj kontaktu.
  • Wartości słownikowych – stawka VAT, sposób płatności, rejestr FK, wariant dekretacji itd. – bez mnożenia pól; rozszerzalność przez system (URI) i code.

Zalecenie: gdy wartość pochodzi z listy kodów, podać coding (system + code + display); text jako uzupełnienie lub gdy brak kodu.

2. Zawartość (struktura)

Nazwa Kard. Typ Opis
coding 0..* Coding Kod(y) z systemów terminologii – każdy z system, code, display (zob. Coding poniżej)
text 0..1 string Tekstowa reprezentacja pojęcia (gdy brak kodu lub jako uzupełnienie)

Coding (element w tablicy coding): odniesienie do kodu z jednego systemu.

Nazwa Kard. Typ Opis
system 0..1 uri Identyfikator systemu kodów (np. https://api-erp.kamsoft.pl/vs/party-role, https://api-erp.kamsoft.pl/vs/vat-rate)
code 0..1 code Symbol kodu w tym systemie
display 0..1 string Tekst do wyświetlania (np. „Odbiorca”, „23%”)

Reguła: przynajmniej jedno z coding lub text powinno być ustawione. Jeśli podano coding, zwykle podaje się code (i opcjonalnie display); display bez code jest mniej użyteczne do przetwarzania.

3. Przykłady systemów (URI)

Słowniki wspólne leżą bezpośrednio w https://api-erp.kamsoft.pl/vs/, słowniki domenowe mają segment finance, warehouse, assets, hr lub retail. Rejestr: code-systems.

  • https://api-erp.kamsoft.pl/vs/party-role – role strony
  • https://api-erp.kamsoft.pl/vs/party-kind – rodzaj strony (employee, employer, contractor, asset-holder)
  • https://api-erp.kamsoft.pl/vs/vat-rate – stawka VAT
  • party-type – typ podmiotu, warianty: finance, assets, hr (person, organization)
  • document-type – typ dokumentu, warianty: finance, warehouse, hr
  • statusy – osobny słownik per zasób i domena, np. hr/organization-unit-status, finance/document-status

4. Odniesienia