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 – rodzaj identyfikatora w Identifier (type), 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/ns/party-role, https://api-erp.kamsoft.pl/ns/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)

  • https://api-erp.kamsoft.pl/ns/party-role – role strony (customer, supplier, payer, payee, carrier…)
  • https://api-erp.kamsoft.pl/ns/party-type – typ podmiotu (osoba, firma, oddział)
  • https://api-erp.kamsoft.pl/ns/vat-rate – stawka VAT
  • https://api-erp.kamsoft.pl/ns/document-type – typ dokumentu
  • https://api-erp.kamsoft.pl/ns/status – statusy (active, inactive) w różnych kontekstach

4. Odniesienia