Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Publishable ValueSet

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-publishablevalueset Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 3 Responsible: HL7 International / Terminology Infrastructure Computable Name: CRMIPublishableValueSet
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.45

Defines and enforces the minimum expectations for publication and distribution of a value set, typically as part of an artifact repository or implementation guide publication

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, pub-1
ValueSet.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ValueSet.meta.Slices for extension Content/Rules for all slices
ValueSet.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ValueSet.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ValueSet.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ValueSet.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ValueSet.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ValueSet.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ValueSet.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ValueSet.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ValueSet.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ValueSet.Slices for extension.extension:curationCoverageLevel C 0..1 (Complex) Relative completeness of curation coverage for this value set
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-curationCoverageLevel
Constraints: ccov-1
ValueSet.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ValueSet.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ValueSet.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ValueSet.Slices for extension.extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
ValueSet.Slices for extension.extension:sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
ValueSet.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ValueSet.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ValueSet.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ValueSet.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ValueSet.purpose This element must be supported. 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.Slices for extension Content/Rules for all slices
ValueSet.compose.Slices for extension.extension:composeCreatedBy 0..1 string Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
ValueSet.compose.Slices for extension.extension:composeCreationDate 0..1 date Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate
ValueSet.compose.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include This element is included in summaries. C 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
ValueSet.compose.include.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.system This element is included in summaries. C 0..1 uri The system the codes come from

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ccov-1 error ValueSet.extension:curationCoverageLevel If level is 'partial', levelReason SHALL be provided. extension.where(url='level').value.coding.where(system = 'http://terminology.hl7.org/CodeSystem/curation-coverage-level-codes' and code ~ 'partial').exists() implies extension.where(url='levelReason').exists()
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If 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-4 error ValueSet If 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-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error ValueSet If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
vsd-0 warning ValueSet Name 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-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: pub-1
ValueSet.meta
ValueSet.meta.Slices for extension Content/Rules for all slices
ValueSet.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ValueSet.Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ValueSet.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ValueSet.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ValueSet.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ValueSet.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ValueSet.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ValueSet.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ValueSet.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ValueSet.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ValueSet.Slices for extension.extension:curationCoverageLevel 0..1 (Complex) Relative completeness of curation coverage for this value set
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-curationCoverageLevel
ValueSet.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x]
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ValueSet.Slices for extension.extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
ValueSet.Slices for extension.extension:sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
ValueSet.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ValueSet.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ValueSet.identifier This element must be supported. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
ValueSet.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
ValueSet.purpose This element must be supported. 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.Slices for extension Content/Rules for all slices
ValueSet.compose.Slices for extension.extension:composeCreatedBy 0..1 string Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
ValueSet.compose.Slices for extension.extension:composeCreationDate 0..1 date Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error ValueSet If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, pub-1
ValueSet.id This element is included in summaries. 0..1 id Logical id of this artifact
ValueSet.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ValueSet.meta.id 0..1 string Unique id for inter-element referencing
ValueSet.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ValueSet.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ValueSet.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ValueSet.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
ValueSet.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ValueSet.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ValueSet.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ValueSet.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.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
ValueSet.contained 0..* Resource Contained, inline Resources
ValueSet.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ValueSet.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ValueSet.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ValueSet.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ValueSet.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ValueSet.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ValueSet.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ValueSet.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ValueSet.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ValueSet.Slices for extension.extension:curationCoverageLevel C 0..1 (Complex) Relative completeness of curation coverage for this value set
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-curationCoverageLevel
Constraints: ccov-1
ValueSet.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ValueSet.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
ValueSet.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ValueSet.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ValueSet.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ValueSet.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
ValueSet.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
ValueSet.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
ValueSet.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ValueSet.Slices for extension.extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
ValueSet.Slices for extension.extension:sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
ValueSet.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ValueSet.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.url This element is included in summaries. 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.version This element is included in summaries. 0..1 string Business version of the value set
ValueSet.name This element is included in summaries. C 0..1 string Name for this value set (computer friendly)
ValueSet.title This element is included in summaries. 0..1 string Name for this value set (human friendly)
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ValueSet.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ValueSet.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
ValueSet.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ValueSet.description 0..1 markdown Natural language description of the value set
ValueSet.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ValueSet.immutable This element is included in summaries. 0..1 boolean Indicates whether or not any change to the content logical definition may occur
ValueSet.purpose This element must be supported. 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.compose.Slices for extension.extension:composeCreatedBy 0..1 string Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
ValueSet.compose.Slices for extension.extension:composeCreationDate 0..1 date Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate
ValueSet.compose.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.lockedDate This element is included in summaries. 0..1 date Fixed date for references with no specified version (transitive)
ValueSet.compose.inactive This element is included in summaries. 0..1 boolean Whether inactive codes are in the value set
ValueSet.compose.include This element is included in summaries. C 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
ValueSet.compose.include.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.system This element is included in summaries. C 0..1 uri The system the codes come from
ValueSet.compose.include.version This element is included in summaries. 0..1 string Specific version of the code system referred to
ValueSet.compose.include.concept C 0..* BackboneElement A concept defined in the system
ValueSet.compose.include.concept.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.code 1..1 code Code or expression from system
ValueSet.compose.include.concept.display 0..1 string Text to display for this code for this value set in this valueset
ValueSet.compose.include.concept.designation 0..* BackboneElement Additional representations for this concept
ValueSet.compose.include.concept.designation.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.designation.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.designation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.designation.language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
ValueSet.compose.include.concept.designation.value 1..1 string The text value for this designation
ValueSet.compose.include.filter This element is included in summaries. C 0..* BackboneElement Select codes/concepts by their properties (including relationships)
ValueSet.compose.include.filter.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.filter.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.filter.property This element is included in summaries. 1..1 code A property/filter defined by the code system
ValueSet.compose.include.filter.op This element is included in summaries. 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.
ValueSet.compose.include.filter.value This element is included in summaries. 1..1 string Code from the system, or regex criteria, or boolean value for exists
ValueSet.compose.include.valueSet This element is included in summaries. C 0..* canonical(ValueSet) Select the contents included in this value set
ValueSet.compose.exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
ValueSet.expansion 0..1 BackboneElement Used when the value set is "expanded"
ValueSet.expansion.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.identifier 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.parameter.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.parameter.name 1..1 string Name as assigned by the client or server
ValueSet.expansion.parameter.value[x] 0..1 Value of the named parameter
ValueSet.expansion.parameter.value[x].valueString string
ValueSet.expansion.parameter.value[x].valueBoolean boolean
ValueSet.expansion.parameter.value[x].valueInteger integer
ValueSet.expansion.parameter.value[x].valueDecimal decimal
ValueSet.expansion.parameter.value[x].valueUri uri
ValueSet.expansion.parameter.value[x].valueCode code
ValueSet.expansion.parameter.value[x].valueDateTime dateTime
ValueSet.expansion.contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
ValueSet.expansion.contains.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.contains.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.contains.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.contains.system 0..1 uri System value for the code
ValueSet.expansion.contains.abstract 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code C 0..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display C 0..1 string User display for the concept
ValueSet.expansion.contains.designation 0..* See designation (ValueSet) Additional representations for this item
ValueSet.expansion.contains.contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ValueSet.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ValueSet.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.
ValueSet.compose.include.​filter.op Base required FilterOperator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ccov-1 error ValueSet.extension:curationCoverageLevel If level is 'partial', levelReason SHALL be provided. extension.where(url='level').value.coding.where(system = 'http://terminology.hl7.org/CodeSystem/curation-coverage-level-codes' and code ~ 'partial').exists() implies extension.where(url='levelReason').exists()
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If 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-4 error ValueSet If 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-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error ValueSet If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
vsd-0 warning ValueSet Name 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-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, pub-1
ValueSet.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ValueSet.meta.Slices for extension Content/Rules for all slices
ValueSet.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ValueSet.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ValueSet.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ValueSet.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ValueSet.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ValueSet.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ValueSet.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ValueSet.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ValueSet.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ValueSet.Slices for extension.extension:curationCoverageLevel C 0..1 (Complex) Relative completeness of curation coverage for this value set
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-curationCoverageLevel
Constraints: ccov-1
ValueSet.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ValueSet.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ValueSet.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ValueSet.Slices for extension.extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
ValueSet.Slices for extension.extension:sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
ValueSet.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ValueSet.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ValueSet.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ValueSet.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ValueSet.purpose This element must be supported. 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.Slices for extension Content/Rules for all slices
ValueSet.compose.Slices for extension.extension:composeCreatedBy 0..1 string Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
ValueSet.compose.Slices for extension.extension:composeCreationDate 0..1 date Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate
ValueSet.compose.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include This element is included in summaries. C 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
ValueSet.compose.include.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.system This element is included in summaries. C 0..1 uri The system the codes come from

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ccov-1 error ValueSet.extension:curationCoverageLevel If level is 'partial', levelReason SHALL be provided. extension.where(url='level').value.coding.where(system = 'http://terminology.hl7.org/CodeSystem/curation-coverage-level-codes' and code ~ 'partial').exists() implies extension.where(url='levelReason').exists()
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If 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-4 error ValueSet If 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-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error ValueSet If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
vsd-0 warning ValueSet Name 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-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: pub-1
ValueSet.meta
ValueSet.meta.Slices for extension Content/Rules for all slices
ValueSet.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ValueSet.Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ValueSet.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ValueSet.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ValueSet.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ValueSet.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ValueSet.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ValueSet.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ValueSet.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ValueSet.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ValueSet.Slices for extension.extension:curationCoverageLevel 0..1 (Complex) Relative completeness of curation coverage for this value set
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-curationCoverageLevel
ValueSet.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x]
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ValueSet.Slices for extension.extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
ValueSet.Slices for extension.extension:sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
ValueSet.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ValueSet.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ValueSet.identifier This element must be supported. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.date This element must be supported. 1..1 dateTime Date last changed
ValueSet.contact This element must be supported. 0..* ContactDetail Contact details for the publisher
ValueSet.useContext This element must be supported. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element must be supported. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
ValueSet.purpose This element must be supported. 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.Slices for extension Content/Rules for all slices
ValueSet.compose.Slices for extension.extension:composeCreatedBy 0..1 string Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
ValueSet.compose.Slices for extension.extension:composeCreationDate 0..1 date Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
pub-1 error ValueSet If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
ValueSet C 1..1 ValueSet A set of codes drawn from one or more code systems
Constraints: vsd-0, pub-1
ValueSet.id This element is included in summaries. 0..1 id Logical id of this artifact
ValueSet.meta This element is included in summaries. 0..1 Meta Metadata about the resource
ValueSet.meta.id 0..1 string Unique id for inter-element referencing
ValueSet.meta.Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ValueSet.meta.Slices for extension.extension:packageSource This element must be supported. 0..1 (Complex) What package the artifact is defined in
URL: http://hl7.org/fhir/StructureDefinition/package-source
ValueSet.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
ValueSet.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
ValueSet.meta.source This element is included in summaries. 0..1 uri Identifies where the resource comes from
ValueSet.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
ValueSet.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
ValueSet.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
ValueSet.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
ValueSet.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.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
ValueSet.contained 0..* Resource Contained, inline Resources
ValueSet.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
ValueSet.Slices for extension.extension:copyrightLabel This element must be supported. 0..1 string Copyright holder and year(s)
URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel
ValueSet.Slices for extension.extension:approvalDate This element must be supported. 0..1 date When resource approved by publisher
URL: http://hl7.org/fhir/StructureDefinition/resource-approvalDate
ValueSet.Slices for extension.extension:lastReviewDate This element must be supported. 0..1 date Last review date for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-lastReviewDate
ValueSet.Slices for extension.extension:effectivePeriod This element must be supported. 0..1 Period The effective date range for the resource
URL: http://hl7.org/fhir/StructureDefinition/resource-effectivePeriod
ValueSet.Slices for extension.extension:topic This element must be supported. 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-topic
Binding: DefinitionTopic (example): Topics associated with the artifact
ValueSet.Slices for extension.extension:author This element must be supported. 0..* ContactDetail Who authored the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-author
ValueSet.Slices for extension.extension:editor This element must be supported. 0..* ContactDetail Who edited the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-editor
ValueSet.Slices for extension.extension:reviewer This element must be supported. 0..* ContactDetail Who reviewed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-reviewer
ValueSet.Slices for extension.extension:endorser This element must be supported. 0..* ContactDetail Who endorsed the artifact
URL: http://hl7.org/fhir/StructureDefinition/artifact-endorser
ValueSet.Slices for extension.extension:curationCoverageLevel C 0..1 (Complex) Relative completeness of curation coverage for this value set
URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-curationCoverageLevel
Constraints: ccov-1
ValueSet.Slices for extension.extension:relatedArtifact This element must be supported. 0..* (Complex) Additional documentation, citations, etc.
URL: http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact
ValueSet.Slices for extension.extension:relatedArtifact.id 0..1 string Unique id for inter-element referencing
ValueSet.Slices for extension.extension:relatedArtifact.extension 0..0 Extension
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:relatedArtifact.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/artifact-relatedArtifact"
ValueSet.Slices for extension.extension:relatedArtifact.value[x] 1..1 RelatedArtifact Value of extension
ValueSet.Slices for extension.extension:relatedArtifact.value[x].id 0..1 string Unique id for inter-element referencing
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension Content/Rules for all slices
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationDate 0..1 date Publication date of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationDate
ValueSet.Slices for extension.extension:relatedArtifact.value[x].Slices for extension.extension:publicationStatus 0..1 code Publication status of referenced artifact
URL: http://hl7.org/fhir/StructureDefinition/cqf-publicationStatus
Binding: PublicationStatus (required): The lifecycle status of a reference artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].type This element is included in summaries. 1..1 code documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of
Binding: RelatedArtifactType (required): The type of relationship to the related artifact.
ValueSet.Slices for extension.extension:relatedArtifact.value[x].label This element is included in summaries. 0..1 string Short label
ValueSet.Slices for extension.extension:relatedArtifact.value[x].display This element is included in summaries. 0..1 string Brief description of the related artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].citation This element is included in summaries. 0..1 markdown Bibliographic citation for the artifact
ValueSet.Slices for extension.extension:relatedArtifact.value[x].url This element is included in summaries. 0..1 url Where the artifact can be accessed
ValueSet.Slices for extension.extension:relatedArtifact.value[x].document This element is included in summaries. 0..1 Attachment What document is being referenced
ValueSet.Slices for extension.extension:relatedArtifact.value[x].resource This element is included in summaries. 0..1 canonical(Resource) What resource is being referenced
ValueSet.Slices for extension.extension:otherTitle 0..* (Complex) Alternative titles
URL: http://hl7.org/fhir/StructureDefinition/valueset-otherTitle
ValueSet.Slices for extension.extension:sourceReference 0..1 uri Where did this content come from
URL: http://hl7.org/fhir/StructureDefinition/valueset-sourceReference
ValueSet.Slices for extension.extension:artifactComment 0..* (Complex) Additional documentation, review, or usage guidance
URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
ValueSet.Slices for extension.extension:authoritativeSource This element must be supported. 0..1 uri Original definitions
URL: http://hl7.org/fhir/StructureDefinition/artifact-authoritativeSource
ValueSet.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
ValueSet.url This element is included in summaries. 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ValueSet.identifier This element must be supported. This element is included in summaries. 0..* Identifier Additional identifier for the value set (business identifier)
ValueSet.version This element is included in summaries. 0..1 string Business version of the value set
ValueSet.name This element is included in summaries. C 0..1 string Name for this value set (computer friendly)
ValueSet.title This element is included in summaries. 0..1 string Name for this value set (human friendly)
ValueSet.status This element is a modifier element. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
ValueSet.experimental This element is included in summaries. 0..1 boolean For testing purposes, not real usage
ValueSet.date This element must be supported. This element is included in summaries. 1..1 dateTime Date last changed
ValueSet.publisher This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
ValueSet.contact This element must be supported. This element is included in summaries. 0..* ContactDetail Contact details for the publisher
ValueSet.description 0..1 markdown Natural language description of the value set
ValueSet.useContext This element must be supported. This element is included in summaries. 0..* UsageContext The context that the content is intended to support
ValueSet.jurisdiction This element must be supported. This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
ValueSet.immutable This element is included in summaries. 0..1 boolean Indicates whether or not any change to the content logical definition may occur
ValueSet.purpose This element must be supported. 0..1 markdown Why this value set is defined
ValueSet.copyright This element must be supported. 0..1 markdown Use and/or publishing restrictions
ValueSet.compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ValueSet.compose.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ValueSet.compose.Slices for extension.extension:composeCreatedBy 0..1 string Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-createdBy
ValueSet.compose.Slices for extension.extension:composeCreationDate 0..1 date Extension
URL: http://hl7.org/fhir/StructureDefinition/valueset-compose-creationDate
ValueSet.compose.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.lockedDate This element is included in summaries. 0..1 date Fixed date for references with no specified version (transitive)
ValueSet.compose.inactive This element is included in summaries. 0..1 boolean Whether inactive codes are in the value set
ValueSet.compose.include This element is included in summaries. C 1..* BackboneElement Include one or more codes from a code system or other value set(s)
Constraints: vsd-1, vsd-2, vsd-3
ValueSet.compose.include.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.system This element is included in summaries. C 0..1 uri The system the codes come from
ValueSet.compose.include.version This element is included in summaries. 0..1 string Specific version of the code system referred to
ValueSet.compose.include.concept C 0..* BackboneElement A concept defined in the system
ValueSet.compose.include.concept.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.code 1..1 code Code or expression from system
ValueSet.compose.include.concept.display 0..1 string Text to display for this code for this value set in this valueset
ValueSet.compose.include.concept.designation 0..* BackboneElement Additional representations for this concept
ValueSet.compose.include.concept.designation.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.concept.designation.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.concept.designation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.concept.designation.language 0..1 code Human language of the designation
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.use 0..1 Coding Types of uses of designations
Binding: DesignationUse (extensible): Details of how a designation would be used.
ValueSet.compose.include.concept.designation.value 1..1 string The text value for this designation
ValueSet.compose.include.filter This element is included in summaries. C 0..* BackboneElement Select codes/concepts by their properties (including relationships)
ValueSet.compose.include.filter.id 0..1 string Unique id for inter-element referencing
ValueSet.compose.include.filter.extension 0..* Extension Additional content defined by implementations
ValueSet.compose.include.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.compose.include.filter.property This element is included in summaries. 1..1 code A property/filter defined by the code system
ValueSet.compose.include.filter.op This element is included in summaries. 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.
ValueSet.compose.include.filter.value This element is included in summaries. 1..1 string Code from the system, or regex criteria, or boolean value for exists
ValueSet.compose.include.valueSet This element is included in summaries. C 0..* canonical(ValueSet) Select the contents included in this value set
ValueSet.compose.exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
ValueSet.expansion 0..1 BackboneElement Used when the value set is "expanded"
ValueSet.expansion.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.identifier 0..1 uri Identifies the value set expansion (business identifier)
ValueSet.expansion.timestamp 1..1 dateTime Time ValueSet expansion happened
ValueSet.expansion.total 0..1 integer Total number of codes in the expansion
ValueSet.expansion.offset 0..1 integer Offset at which this resource starts
ValueSet.expansion.parameter 0..* BackboneElement Parameter that controlled the expansion process
ValueSet.expansion.parameter.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.parameter.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.parameter.name 1..1 string Name as assigned by the client or server
ValueSet.expansion.parameter.value[x] 0..1 Value of the named parameter
ValueSet.expansion.parameter.value[x].valueString string
ValueSet.expansion.parameter.value[x].valueBoolean boolean
ValueSet.expansion.parameter.value[x].valueInteger integer
ValueSet.expansion.parameter.value[x].valueDecimal decimal
ValueSet.expansion.parameter.value[x].valueUri uri
ValueSet.expansion.parameter.value[x].valueCode code
ValueSet.expansion.parameter.value[x].valueDateTime dateTime
ValueSet.expansion.contains C 0..* BackboneElement Codes in the value set
Constraints: vsd-6, vsd-9, vsd-10
ValueSet.expansion.contains.id 0..1 string Unique id for inter-element referencing
ValueSet.expansion.contains.extension 0..* Extension Additional content defined by implementations
ValueSet.expansion.contains.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
ValueSet.expansion.contains.system 0..1 uri System value for the code
ValueSet.expansion.contains.abstract 0..1 boolean If user cannot select this entry
ValueSet.expansion.contains.inactive 0..1 boolean If concept is inactive in the code system
ValueSet.expansion.contains.version 0..1 string Version in which this code/display is defined
ValueSet.expansion.contains.code C 0..1 code Code - if blank, this is not a selectable code
ValueSet.expansion.contains.display C 0..1 string User display for the concept
ValueSet.expansion.contains.designation 0..* See designation (ValueSet) Additional representations for this item
ValueSet.expansion.contains.contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ValueSet.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ValueSet.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ValueSet.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.extension:relatedArtifact.​value[x].type Base required RelatedArtifactType 📍4.0.1 FHIR Std.
ValueSet.status Base required PublicationStatus 📍4.0.1 FHIR Std.
ValueSet.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ValueSet.compose.include.​concept.designation.​use Base extensible Designation Use 📍4.0.1 FHIR Std.
ValueSet.compose.include.​filter.op Base required FilterOperator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ccov-1 error ValueSet.extension:curationCoverageLevel If level is 'partial', levelReason SHALL be provided. extension.where(url='level').value.coding.where(system = 'http://terminology.hl7.org/CodeSystem/curation-coverage-level-codes' and code ~ 'partial').exists() implies extension.where(url='levelReason').exists()
dom-2 error ValueSet If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ValueSet If 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-4 error ValueSet If 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-5 error ValueSet If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ValueSet A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
pub-1 error ValueSet If knowledge capabilities are stated, they SHALL include publishable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'publishable').exists()
vsd-0 warning ValueSet Name 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-1 error ValueSet.compose.include A value set include/exclude SHALL have a value set or a system valueSet.exists() or system.exists()
vsd-2 error ValueSet.compose.include A value set with concepts or filters SHALL include a system (concept.exists() or filter.exists()) implies system.exists()
vsd-3 error ValueSet.compose.include Cannot have both concept and filter concept.empty() or filter.empty()
vsd-6 error ValueSet.expansion.contains SHALL have a code or a display code.exists() or display.exists()
vsd-9 error ValueSet.expansion.contains Must have a code if not abstract code.exists() or abstract = true
vsd-10 error ValueSet.expansion.contains Must have a system if a code is present code.empty() or system.exists()

 

Other representations of profile: CSV, Excel, Schematron