Przejdź do treści

ValueSet

ValueSet (zbiór wartości) definiuje dopuszczalne kody dla konkretnego kontekstu biznesowego: pola, zasobu, profilu lub endpointu. Model jest inspirowany FHIR ValueSet i upraszcza ten wzorzec do potrzeb API.ERP.

Rozszerza DomainResource.

1. Zakres i zastosowanie

ValueSet służy do:

  • publikowania dopuszczalnych kodów dla pól typu CodeableConcept,
  • wersjonowania i stabilizacji słowników w integracjach,
  • jawnego mapowania kontekstu walidacji (np. typ dokumentu FK, status dokumentu ESM),
  • zarządzania słownikami bez zmiany modelu danych zasobów biznesowych.

Typowe scenariusze:

  • Document.type ograniczony do ValueSet DocumentType-FK,
  • FixedAsset.status ograniczony do ValueSet AssetStatus,
  • FixedAssetAllocation.dimension ograniczony do ValueSet AllocationDimension.

2. Zawartość (struktura)

Oprócz elementów DomainResource (id, meta, name, attribute, comment, category, status, type, contained):

Nazwa Kard. Typ Opis
identifier 0..* Identifier[] Identyfikatory biznesowe ValueSet
url 1..1 uri Kanoniczny identyfikator ValueSet
version 0..1 string Wersja artefaktu słownikowego
title 0..1 string Czytelny tytuł ValueSet
experimental 0..1 boolean Oznaczenie wersji roboczej
immutable 0..1 boolean Czy zbiór jest niemodyfikowalny po publikacji
description 0..1 string Opis celu i zakresu ValueSet
compose 1..1 obiekt Definicja zbioru kodów (include[])

2a. Struktura compose

Nazwa Kard. Typ Opis
include 1..* lista obiektów Źródła kodów włączonych do ValueSet

2b. Struktura compose.include[]

Nazwa Kard. Typ Opis
system 1..1 uri URL code systemu (np. https://api-erp.kamsoft.pl/ns/document-type)
version 0..1 string Wersja code systemu
concept 1..* lista obiektów Jawnie dopuszczone koncepty (code/display)

2c. Struktura compose.include[].concept[]

Nazwa Kard. Typ Opis
code 1..1 string Kod dopuszczony w danym kontekscie
display 0..1 string Opis kodu do prezentacji

3. Odniesienia