v2+ Details
0.3.2 - Working Draft to present the concept ideas (FO)

v2+ Details - Local Development build (v0.3.2). See the Directory of published versions

Resource Profile: Value Set Logical Definition

Official URL: https://hl7.eu/v2plus/StructureDefinition/ValueSetLogicalDefinition Version:
Draft as of 2023-10-23 Responsible: FO: for testing purposes only Computable Name: ValueSetLogicalDefinition

Usage:

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

Formal Views of Profile Content

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

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*ValueSetA set of codes drawn from one or more code systems
... id 1..1idLogical id of this artifact
... identifier 1..1IdentifierAdditional identifier for the value set (business identifier)
... version 1..1stringBusiness version of the value set
... title S0..1stringName for this value set (human friendly)
... status S1..1codedraft | active | retired | unknown
... date S0..1dateTimeDate last changed
... compose 0..0
... expansion 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C0..*ValueSetA set of codes drawn from one or more code systems
... id Σ1..1idLogical id of this artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... identifier Σ1..1IdentifierAdditional identifier for the value set (business identifier)
... version Σ1..1stringBusiness version of the value set
... name SΣC1..1stringName for this value set (computer friendly)
... title SΣ0..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ0..1dateTimeDate last changed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ValueSet.statusrequiredPublicationStatus
ValueSet.compose.include.filter.oprequiredFilterOperator

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}$')
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()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C0..*ValueSetA set of codes drawn from one or more code systems
... id Σ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ1..1IdentifierAdditional identifier for the value set (business identifier)
... version Σ1..1stringBusiness version of the value set
... versionAlgorithm[x] ΣTU0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC1..1stringName for this value set (computer friendly)
... title SΣ0..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date SΣ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel TU0..1stringCopyright holder and year(s)
... approvalDate TU0..1dateWhen the ValueSet was approved by publisher
... lastReviewDate TU0..1dateWhen the ValueSet was last reviewed by the publisher
... effectivePeriod ΣTU0..1PeriodWhen the ValueSet is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author TU0..*ContactDetailWho authored the ValueSet
... editor TU0..*ContactDetailWho edited the ValueSet
... reviewer TU0..*ContactDetailWho reviewed the ValueSet
... endorser TU0..*ContactDetailWho endorsed the ValueSet
... relatedArtifact TU0..*RelatedArtifactAdditional documentation, citations, etc
... scope TU0..1BackboneElementDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... inclusionCriteria 0..1stringCriteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1stringCriteria describing which concepts or codes should be excluded and why

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ValueSet.languagerequiredAllLanguages
ValueSet.versionAlgorithm[x]extensibleVersionAlgorithm
ValueSet.statusrequiredPublicationStatus
ValueSet.jurisdictionextensibleJurisdictionValueSet
ValueSet.topicexampleDefinitionTopic
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
ValueSet.compose.include.filter.oprequiredFilterOperator

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()
vsd-11errorValueSet.compose.include.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.exists()

This structure is derived from ValueSet

Summary

Mandatory: 4 elements
Must-Support: 4 elements
Prohibited: 2 elements

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..*ValueSetA set of codes drawn from one or more code systems
... id 1..1idLogical id of this artifact
... identifier 1..1IdentifierAdditional identifier for the value set (business identifier)
... version 1..1stringBusiness version of the value set
... title S0..1stringName for this value set (human friendly)
... status S1..1codedraft | active | retired | unknown
... date S0..1dateTimeDate last changed
... compose 0..0
... expansion 0..0

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C0..*ValueSetA set of codes drawn from one or more code systems
... id Σ1..1idLogical id of this artifact
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... identifier Σ1..1IdentifierAdditional identifier for the value set (business identifier)
... version Σ1..1stringBusiness version of the value set
... name SΣC1..1stringName for this value set (computer friendly)
... title SΣ0..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... date SΣ0..1dateTimeDate last changed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ValueSet.statusrequiredPublicationStatus
ValueSet.compose.include.filter.oprequiredFilterOperator

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}$')
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()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C0..*ValueSetA set of codes drawn from one or more code systems
... id Σ1..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC0..1uriCanonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ1..1IdentifierAdditional identifier for the value set (business identifier)
... version Σ1..1stringBusiness version of the value set
... versionAlgorithm[x] ΣTU0..1How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name SΣC1..1stringName for this value set (computer friendly)
... title SΣ0..1stringName for this value set (human friendly)
... status ?!SΣ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date SΣ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the value set
... useContext ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for value set (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... purpose 0..1markdownWhy this value set is defined
... copyright 0..1markdownUse and/or publishing restrictions
... copyrightLabel TU0..1stringCopyright holder and year(s)
... approvalDate TU0..1dateWhen the ValueSet was approved by publisher
... lastReviewDate TU0..1dateWhen the ValueSet was last reviewed by the publisher
... effectivePeriod ΣTU0..1PeriodWhen the ValueSet is expected to be used
... topic XD0..*CodeableConceptE.g. Education, Treatment, Assessment, etc
Binding: DefinitionTopic (example)
... author TU0..*ContactDetailWho authored the ValueSet
... editor TU0..*ContactDetailWho edited the ValueSet
... reviewer TU0..*ContactDetailWho reviewed the ValueSet
... endorser TU0..*ContactDetailWho endorsed the ValueSet
... relatedArtifact TU0..*RelatedArtifactAdditional documentation, citations, etc
... scope TU0..1BackboneElementDescription of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... inclusionCriteria 0..1stringCriteria describing which concepts or codes should be included and why
.... exclusionCriteria 0..1stringCriteria describing which concepts or codes should be excluded and why

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ValueSet.languagerequiredAllLanguages
ValueSet.versionAlgorithm[x]extensibleVersionAlgorithm
ValueSet.statusrequiredPublicationStatus
ValueSet.jurisdictionextensibleJurisdictionValueSet
ValueSet.topicexampleDefinitionTopic
ValueSet.compose.include.concept.designation.languagerequiredAllLanguages
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
ValueSet.compose.include.concept.designation.additionalUseextensibleDesignationUse
ValueSet.compose.include.filter.oprequiredFilterOperator

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()
vsd-11errorValueSet.compose.include.concept.designationMust have a value for concept.designation.use if concept.designation.additionalUse is present
: additionalUse.exists() implies use.exists()

This structure is derived from ValueSet

Summary

Mandatory: 4 elements
Must-Support: 4 elements
Prohibited: 2 elements

 

Other representations of profile: CSV, Excel, Schematron