Dokumentacja Integracyjna SMPL
25.0.0 - STU1 Poland flag

Profil zasobu: PLSMPLAdminValueSet

Logiczny url: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet Wersja: 25.0.0
Active z dnia 2024-09-17 Nazwa: PLSMPLAdminValueSet

Profil dla słowników zarządzanych administracyjnie

Usage:

Profil

Opis sposobu prezentacji profilu ujęty jest w specyfikacji standardu FHIR.

Struktura bazuje na ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... id 0..1 id Unikalny identyfikator logiczny zasobu
... meta 1..1 Meta Metadane zasobu
.... id 0..0
.... extension 0..0
.... versionId 0..1 id Wersja zasobu
.... source 0..0
.... profile 1..1 canonical(StructureDefinition) Profil zasobu
Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... identifier 0..0
... name 1..1 string Nazwa słownika
... title 0..1 string Tytuł słownika
... status 1..1 code Status słownika
... experimental 0..1 boolean Oznaczenie słowników eksperymentalnych / testowych
... description 0..1 markdown Opis słownika
... useContext 1..1 UsageContext Kontekst użycia - kod rodzaju słownika
.... id 0..0
.... extension 0..0
.... code 1..1 Coding Kod rodzaju słownika
..... id 0..0
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:0.0.0.0.0
..... version 0..0
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: setOfValueSet
..... display 0..0
..... userSelected 0..0
.... value[x] 1..1 CodeableConcept Rodzaj słownika
..... id 0..0
..... extension 0..0
..... coding 1..* Coding Kod rodzaju słownika
...... id 0..0
...... extension 0..0
...... system 1..1 uri System
...... version 0..0
...... code 1..1 code Kod
...... display 0..0
...... userSelected 0..0
..... text 0..0
... immutable 0..0
... purpose 0..0
... copyright 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Unikalny identyfikator logiczny zasobu
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet
... name ΣC 1..1 string Nazwa słownika
... status ?!Σ 1..1 code Status słownika
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean Oznaczenie słowników eksperymentalnych / testowych
... description 0..1 markdown Opis słownika
... useContext Σ 1..1 UsageContext Kontekst użycia - kod rodzaju słownika
.... extension 0..0
.... code Σ 1..1 Coding Kod rodzaju słownika
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.

..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:0.0.0.0.0
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: setOfValueSet
.... value[x] Σ 1..1 CodeableConcept Rodzaj słownika
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

..... extension 0..0
..... coding Σ 1..* Coding Kod rodzaju słownika
...... extension 0..0
...... system Σ 1..1 uri System
...... code Σ 1..1 code Kod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext.codeextensibleFixed Value: setOfValueSet
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorValueSetIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Unikalny identyfikator logiczny zasobu
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet
... text 0..1 Narrative Text summary of the resource, for human interpretation
... version Σ 0..1 string Business version of the value set
... name ΣC 1..1 string Nazwa słownika
... title Σ 0..1 string Tytuł słownika
... status ?!Σ 1..1 code Status słownika
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean Oznaczenie słowników eksperymentalnych / testowych
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Opis słownika
... useContext Σ 1..1 UsageContext Kontekst użycia - kod rodzaju słownika
.... extension 0..0
.... code Σ 1..1 Coding Kod rodzaju słownika
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.

..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:0.0.0.0.0
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: setOfValueSet
.... value[x] Σ 1..1 CodeableConcept Rodzaj słownika
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

..... extension 0..0
..... coding Σ 1..* Coding Kod rodzaju słownika
...... extension 0..0
...... system Σ 1..1 uri System
...... code Σ 1..1 code Kod
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... value 1..1 string The text value for this designation
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains C 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system 0..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext.codeextensibleFixed Value: setOfValueSet
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorValueSetIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

Struktura bazuje na ValueSet

Summary

Mandatory: 9 elements
Fixed: 3 elements
Prohibited: 28 elements

Widok Differential

Struktura bazuje na ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... id 0..1 id Unikalny identyfikator logiczny zasobu
... meta 1..1 Meta Metadane zasobu
.... id 0..0
.... extension 0..0
.... versionId 0..1 id Wersja zasobu
.... source 0..0
.... profile 1..1 canonical(StructureDefinition) Profil zasobu
Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet
.... security 0..0
.... tag 0..0
... implicitRules 0..0
... contained 0..0
... extension 0..0
... modifierExtension 0..0
... identifier 0..0
... name 1..1 string Nazwa słownika
... title 0..1 string Tytuł słownika
... status 1..1 code Status słownika
... experimental 0..1 boolean Oznaczenie słowników eksperymentalnych / testowych
... description 0..1 markdown Opis słownika
... useContext 1..1 UsageContext Kontekst użycia - kod rodzaju słownika
.... id 0..0
.... extension 0..0
.... code 1..1 Coding Kod rodzaju słownika
..... id 0..0
..... system 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:0.0.0.0.0
..... version 0..0
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: setOfValueSet
..... display 0..0
..... userSelected 0..0
.... value[x] 1..1 CodeableConcept Rodzaj słownika
..... id 0..0
..... extension 0..0
..... coding 1..* Coding Kod rodzaju słownika
...... id 0..0
...... extension 0..0
...... system 1..1 uri System
...... version 0..0
...... code 1..1 code Kod
...... display 0..0
...... userSelected 0..0
..... text 0..0
... immutable 0..0
... purpose 0..0
... copyright 0..0

doco Documentation for this format

Widok kluczowych elementów

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Unikalny identyfikator logiczny zasobu
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet
... name ΣC 1..1 string Nazwa słownika
... status ?!Σ 1..1 code Status słownika
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean Oznaczenie słowników eksperymentalnych / testowych
... description 0..1 markdown Opis słownika
... useContext Σ 1..1 UsageContext Kontekst użycia - kod rodzaju słownika
.... extension 0..0
.... code Σ 1..1 Coding Kod rodzaju słownika
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.

..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:0.0.0.0.0
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: setOfValueSet
.... value[x] Σ 1..1 CodeableConcept Rodzaj słownika
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

..... extension 0..0
..... coding Σ 1..* Coding Kod rodzaju słownika
...... extension 0..0
...... system Σ 1..1 uri System
...... code Σ 1..1 code Kod

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext.codeextensibleFixed Value: setOfValueSet
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorValueSetIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
vsd-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Widok Snapshot

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Unikalny identyfikator logiczny zasobu
... meta Σ 1..1 Meta Metadane zasobu
.... extension 0..0
.... versionId Σ 0..1 id Wersja zasobu
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... profile Σ 1..1 canonical(StructureDefinition) Profil zasobu

Fixed Value: https://ezdrowie.gov.pl/fhir/StructureDefinition/PLSMPLAdminValueSet
... text 0..1 Narrative Text summary of the resource, for human interpretation
... version Σ 0..1 string Business version of the value set
... name ΣC 1..1 string Nazwa słownika
... title Σ 0..1 string Tytuł słownika
... status ?!Σ 1..1 code Status słownika
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean Oznaczenie słowników eksperymentalnych / testowych
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Opis słownika
... useContext Σ 1..1 UsageContext Kontekst użycia - kod rodzaju słownika
.... extension 0..0
.... code Σ 1..1 Coding Kod rodzaju słownika
Binding: UsageContextType (extensible): A code that specifies a type of context being specified by a usage context.

..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: urn:oid:0.0.0.0.0
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: setOfValueSet
.... value[x] Σ 1..1 CodeableConcept Rodzaj słownika
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

..... extension 0..0
..... coding Σ 1..* Coding Kod rodzaju słownika
...... extension 0..0
...... system Σ 1..1 uri System
...... code Σ 1..1 code Kod
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
.... inactive Σ 0..1 boolean Whether inactive codes are in the value set
.... include ΣC 1..* BackboneElement Include one or more codes from a code system or other value set(s)
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system ΣC 0..1 uri The system the codes come from
..... version Σ 0..1 string Specific version of the code system referred to
..... concept C 0..* BackboneElement A concept defined in the system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
...... designation 0..* BackboneElement Additional representations for this concept
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
....... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
....... language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
....... use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.

....... value 1..1 string The text value for this designation
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... property Σ 1..1 code A property/filter defined by the code system
...... op Σ 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter.

...... value Σ 1..1 string Code from the system, or regex criteria, or boolean value for exists
..... valueSet ΣC 0..* canonical(ValueSet) Select the contents included in this value set
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 0..1 uri Identifies the value set expansion (business identifier)
.... timestamp 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... name 1..1 string Name as assigned by the client or server
..... value[x] 0..1 Value of the named parameter
...... valueString string
...... valueBoolean boolean
...... valueInteger integer
...... valueDecimal decimal
...... valueUri uri
...... valueCode code
...... valueDateTime dateTime
.... contains C 0..* BackboneElement Codes in the value set
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system 0..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... inactive 0..1 boolean If concept is inactive in the code system
..... version 0..1 string Version in which this code/display is defined
..... code C 0..1 code Code - if blank, this is not a selectable code
..... display C 0..1 string User display for the concept
..... designation 0..* See designation (ValueSet) Additional representations for this item
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.useContext.codeextensibleFixed Value: setOfValueSet
http://hl7.org/fhir/ValueSet/usage-context-type
from the FHIR Standard
ValueSet.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorValueSetIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorValueSetIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorValueSetIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorValueSetIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceValueSetA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
vsd-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
vsd-1errorValueSet.compose.includeA value set include/exclude SHALL have a value set or a system
: valueSet.exists() or system.exists()
vsd-2errorValueSet.compose.includeA value set with concepts or filters SHALL include a system
: (concept.exists() or filter.exists()) implies system.exists()
vsd-3errorValueSet.compose.includeCannot have both concept and filter
: concept.empty() or filter.empty()
vsd-6errorValueSet.expansion.containsSHALL have a code or a display
: code.exists() or display.exists()
vsd-9errorValueSet.expansion.containsMust have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsMust have a system if a code is present
: code.empty() or system.exists()

Struktura bazuje na ValueSet

Summary

Mandatory: 9 elements
Fixed: 3 elements
Prohibited: 28 elements

 

Inne struktury profilu: CSV, Excel, Schematron