Specyfikacja interoperacyjności prototypu SSIDL
0.1.1 - ci-build

Specyfikacja interoperacyjności prototypu SSIDL, published by Uniwersytet Medyczny w Łodzi. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/SSIDL/ssidl-ig/ and changes regularly. See the Directory of published versions

Resource Profile: Zbiór wartości (SSIDL)

Official URL: http://loinc-ssidl.umed.pl/fhir/ig/ssidl/StructureDefinition/ssidl-valueSet Version: 0.1.1
Draft as of 2025-08-28 Computable Name: SsidlValueSet

Zbiór wartości zdefiniowany na potrzeby SSIDL

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Additional identifier for the value set (business identifier)
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... version SΣ 1..1 string Business version of the value set
... name SΣC 1..1 string Name for this value set (computer friendly)
... title SΣ 1..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... jurisdiction Σ 1..1 CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2
..... code SΣC 1..1 code Symbol in syntax defined by the system
Required Pattern: PL
..... display SΣC 1..1 string Representation defined by the system
Required Pattern: Poland
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
Required Pattern: true
... compose S 1..1 BackboneElement Content logical definition of the value set (CLD)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... include SΣC 1..1 BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system SΣC 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
ValueSet.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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-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()

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... url S 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier S 1..1 Identifier Additional identifier for the value set (business identifier)
.... use 0..0
.... type 0..0
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... period 0..0
.... assigner 0..0
... version S 1..1 string Business version of the value set
... versionAlgorithm[x] 0..0
... name S 1..1 string Name for this value set (computer friendly)
... title S 1..1 string Name for this value set (human friendly)
... status S 1..1 code draft | active | retired | unknown
Required Pattern: active
... experimental 0..0
... date 0..0
... publisher 0..0
... contact 0..0
... description 0..0
... useContext 0..0
... jurisdiction 1..1 CodeableConcept Intended jurisdiction for value set (if applicable)
.... coding S 1..1 Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2
..... version 0..0
..... code S 1..1 code Symbol in syntax defined by the system
Required Pattern: PL
..... display S 1..1 string Representation defined by the system
Required Pattern: Poland
..... userSelected 0..0
.... text 0..0
... immutable S 1..1 boolean Indicates whether or not any change to the content logical definition may occur
Required Pattern: true
... purpose 0..0
... copyright 0..0
... copyrightLabel 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... topic 0..0
... author 0..0
... editor 0..0
... reviewer 0..0
... endorser 0..0
... relatedArtifact 0..0
... compose S 1..1 BackboneElement Content logical definition of the value set (CLD)
.... extension 0..0
.... lockedDate 0..0
.... inactive 0..0
.... include S 1..1 BackboneElement Include one or more codes from a code system or other value set(s)
..... system S 0..1 uri The system the codes come from
..... version S 0..1 string Specific version of the code system referred to
..... concept S 0..0
..... filter 0..0
..... valueSet 0..0
.... exclude 0..0
.... property 0..0
... scope 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
Constraints: cnl-1
... identifier SΣ 1..1 Identifier Additional identifier for the value set (business identifier)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... version SΣ 1..1 string Business version of the value set
... name SΣC 1..1 string Name for this value set (computer friendly)
... title SΣ 1..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... jurisdiction Σ 1..1 CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2
..... code SΣC 1..1 code Symbol in syntax defined by the system
Required Pattern: PL
..... display SΣC 1..1 string Representation defined by the system
Required Pattern: Poland
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
Required Pattern: true
... compose S 1..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... include SΣC 1..1 BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... 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 SΣC 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to
..... copyright 0..1 string A copyright statement for the specific code system included in the value set
... 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)
.... next 0..1 uri Opaque urls for paging through expansion results
.... 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
.... property 0..* BackboneElement Additional information supplied about each 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
..... code 1..1 code Identifies the property on the concepts, and when referred to in operations
..... uri 0..1 uri Formal identifier for the property
.... contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... 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 System value for the code
..... abstract C 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
..... property 0..* BackboneElement Property value for the 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
...... code 1..1 code Reference to ValueSet.expansion.property.code
...... value[x] 1..1 Value of the property for this concept
....... valueCode code
....... valueCoding Coding
....... valueString string
....... valueInteger integer
....... valueBoolean boolean
....... valueDateTime dateTime
....... valueDecimal decimal
...... subProperty 0..* BackboneElement SubProperty value for the 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
....... code 1..1 code Reference to ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
ValueSet.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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-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.containsSHALL have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsSHALL have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

Summary

Mandatory: 14 elements(1 nested mandatory element)
Must-Support: 20 elements
Prohibited: 36 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... identifier SΣ 1..1 Identifier Additional identifier for the value set (business identifier)
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... version SΣ 1..1 string Business version of the value set
... name SΣC 1..1 string Name for this value set (computer friendly)
... title SΣ 1..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... jurisdiction Σ 1..1 CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2
..... code SΣC 1..1 code Symbol in syntax defined by the system
Required Pattern: PL
..... display SΣC 1..1 string Representation defined by the system
Required Pattern: Poland
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
Required Pattern: true
... compose S 1..1 BackboneElement Content logical definition of the value set (CLD)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... include SΣC 1..1 BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... system SΣC 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
ValueSet.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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-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()

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... url S 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier S 1..1 Identifier Additional identifier for the value set (business identifier)
.... use 0..0
.... type 0..0
.... system S 1..1 uri The namespace for the identifier value
.... value S 1..1 string The value that is unique
.... period 0..0
.... assigner 0..0
... version S 1..1 string Business version of the value set
... versionAlgorithm[x] 0..0
... name S 1..1 string Name for this value set (computer friendly)
... title S 1..1 string Name for this value set (human friendly)
... status S 1..1 code draft | active | retired | unknown
Required Pattern: active
... experimental 0..0
... date 0..0
... publisher 0..0
... contact 0..0
... description 0..0
... useContext 0..0
... jurisdiction 1..1 CodeableConcept Intended jurisdiction for value set (if applicable)
.... coding S 1..1 Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2
..... version 0..0
..... code S 1..1 code Symbol in syntax defined by the system
Required Pattern: PL
..... display S 1..1 string Representation defined by the system
Required Pattern: Poland
..... userSelected 0..0
.... text 0..0
... immutable S 1..1 boolean Indicates whether or not any change to the content logical definition may occur
Required Pattern: true
... purpose 0..0
... copyright 0..0
... copyrightLabel 0..0
... approvalDate 0..0
... lastReviewDate 0..0
... effectivePeriod 0..0
... topic 0..0
... author 0..0
... editor 0..0
... reviewer 0..0
... endorser 0..0
... relatedArtifact 0..0
... compose S 1..1 BackboneElement Content logical definition of the value set (CLD)
.... extension 0..0
.... lockedDate 0..0
.... inactive 0..0
.... include S 1..1 BackboneElement Include one or more codes from a code system or other value set(s)
..... system S 0..1 uri The system the codes come from
..... version S 0..1 string Specific version of the code system referred to
..... concept S 0..0
..... filter 0..0
..... valueSet 0..0
.... exclude 0..0
.... property 0..0
... scope 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
Constraints: cnl-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣC 1..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
Constraints: cnl-1
... identifier SΣ 1..1 Identifier Additional identifier for the value set (business identifier)
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system SΣ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value SΣC 1..1 string The value that is unique
Example General: 123456
... version SΣ 1..1 string Business version of the value set
... name SΣC 1..1 string Name for this value set (computer friendly)
... title SΣ 1..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... jurisdiction Σ 1..1 CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
.... id 0..1 id Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..1 Coding Code defined by a terminology system
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
Required Pattern: http://hl7.org/fhir/ValueSet/iso3166-1-2
..... code SΣC 1..1 code Symbol in syntax defined by the system
Required Pattern: PL
..... display SΣC 1..1 string Representation defined by the system
Required Pattern: Poland
... immutable SΣ 1..1 boolean Indicates whether or not any change to the content logical definition may occur
Required Pattern: true
... compose S 1..1 BackboneElement Content logical definition of the value set (CLD)
.... id 0..1 string Unique id for inter-element referencing
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... include SΣC 1..1 BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
..... 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 SΣC 0..1 uri The system the codes come from
..... version SΣ 0..1 string Specific version of the code system referred to
..... copyright 0..1 string A copyright statement for the specific code system included in the value set
... 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)
.... next 0..1 uri Opaque urls for paging through expansion results
.... 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
.... property 0..* BackboneElement Additional information supplied about each 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
..... code 1..1 code Identifies the property on the concepts, and when referred to in operations
..... uri 0..1 uri Formal identifier for the property
.... contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
..... 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 System value for the code
..... abstract C 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
..... property 0..* BackboneElement Property value for the 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
...... code 1..1 code Reference to ValueSet.expansion.property.code
...... value[x] 1..1 Value of the property for this concept
....... valueCode code
....... valueCoding Coding
....... valueString string
....... valueInteger integer
....... valueBoolean boolean
....... valueDateTime dateTime
....... valueDecimal decimal
...... subProperty 0..* BackboneElement SubProperty value for the 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
....... code 1..1 code Reference to ValueSet.expansion.property.code
....... value[x] 1..1 Value of the subproperty for this concept
........ valueCode code
........ valueCoding Coding
........ valueString string
........ valueInteger integer
........ valueBoolean boolean
........ valueDateTime dateTime
........ valueDecimal decimal
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ValueSet.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.statusrequiredPattern Value: active
http://hl7.org/fhir/ValueSet/publication-status|5.0.0
From the FHIR Standard
ValueSet.jurisdictionextensibleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
From the FHIR Standard
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
From the FHIR Standard
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
From the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|5.0.0
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningValueSetName should be usable as an identifier for the module by machine processing applications such as code generation
: name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1warningValueSet.urlURL should not contain | or # - these characters make processing canonical references problematic
: exists() implies matches('^[^|# ]+$')
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-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.containsSHALL have a code if not abstract
: code.exists() or abstract = true
vsd-10errorValueSet.expansion.containsSHALL have a system if a code is present
: code.empty() or system.exists()

This structure is derived from ValueSet

Summary

Mandatory: 14 elements(1 nested mandatory element)
Must-Support: 20 elements
Prohibited: 36 elements

 

Other representations of profile: CSV, Excel, Schematron