Implementation Guide
25.0.0 - R4 APIs

Publish Box goes here

Resource Profile: AthenaValueSet

Official URL: https://docs.mydata.athenahealth.com/fhir-r4/StructureDefinition-athena-valueset-profile.html Version: 25.0.0
Active as of 2022-03-01 Computable Name: AthenaValueSet

Defines constraints and extensions on the Binary resource as supported by Athena Products.

This ValueSet profile is part of the set of resource profiles supported by the API Server used with the athenaPractice and athenaFlow products. It further describes read and search capabilities of these products. Note: The create and update operations are NOT supported for this resource.

Overview

This resource represents a collection of vocabulary valuesused within various resources created or used by the API Server

Scope and Usage

This profile is used to define the content that will be returned by the API Server in response to requests to access ValueSet resources. All elements listed in the differential profile view are Supported, which means that the API Server is capable of supplying these fields from the product database when they have been populated via the product or its APIs.

Source

The ValueSet resource provides information about code systems used by the API Server, and athenaPractice, athenaFlow and site specific coding systems used in the products. The content is derived from an external file created during system installation.

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.

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ele-1: All FHIR elements must have a @value or children
... version Σ 0..1 string Business version of the value set
ele-1: All FHIR elements must have a @value or children
... name ΣC 0..1 string Name for this value set (computer friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ 0..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date Σ 0..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher Σ 0..1 string Name of the publisher (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact Σ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description 0..1 markdown Natural language description of the value set
ele-1: All FHIR elements must have a @value or children
... useContext Σ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
ele-1: All FHIR elements must have a @value or children
... purpose 0..1 markdown Why this value set is defined
ele-1: All FHIR elements must have a @value or children
... copyright 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
ele-1: All FHIR elements must have a @value or children
.... include ΣC 0..* BackboneElement Include one or more codes from a code system or other value set(s)
ele-1: All FHIR elements must have a @value or children
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system SΣC 1..1 uri The system the codes come from
ele-1: All FHIR elements must have a @value or children
..... version Σ 0..1 string Specific version of the code system referred to
ele-1: All FHIR elements must have a @value or children
..... concept C 0..* BackboneElement A concept defined in the system
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... code S 1..1 code Code or expression from system
ele-1: All FHIR elements must have a @value or children
...... display 0..1 string Text to display for this code for this value set in this valueset
ele-1: All FHIR elements must have a @value or children
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... property SΣ 1..1 code A property/filter defined by the code system
ele-1: All FHIR elements must have a @value or children
...... op SΣ 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.


ele-1: All FHIR elements must have a @value or children
...... value SΣ 1..1 string Code from the system, or regex criteria, or boolean value for exists
ele-1: All FHIR elements must have a @value or children
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
ele-1: All FHIR elements must have a @value or children
... expansion 0..1 BackboneElement Used when the value set is "expanded"
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier S 1..1 uri Identifies the value set expansion (business identifier)
ele-1: All FHIR elements must have a @value or children
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
ele-1: All FHIR elements must have a @value or children
.... total 0..1 integer Total number of codes in the expansion
ele-1: All FHIR elements must have a @value or children
.... offset 0..1 integer Offset at which this resource starts
ele-1: All FHIR elements must have a @value or children
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name S 1..1 string Name as assigned by the client or server
ele-1: All FHIR elements must have a @value or children
..... value[x] 0..1 string Value of the named parameter
ele-1: All FHIR elements must have a @value or children
.... contains C 0..* BackboneElement Codes in the value set
ele-1: All FHIR elements must have a @value or children
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system 0..1 uri System value for the code
ele-1: All FHIR elements must have a @value or children
..... abstract 0..1 boolean If user cannot select this entry
ele-1: All FHIR elements must have a @value or children
..... version 0..1 string Version in which this code/display is defined
ele-1: All FHIR elements must have a @value or children
..... code C 0..1 code Code - if blank, this is not a selectable code
ele-1: All FHIR elements must have a @value or children
..... display C 0..1 string User display for the concept
ele-1: All FHIR elements must have a @value or children
..... contains 0..* See contains (ValueSet) Codes contained under this entry
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... url 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier 0..1 Identifier Additional identifier for the value set (business identifier)
... version 0..1 string Business version of the value set
... status S 1..1 code draft | active | retired | unknown
... experimental 0..1 boolean For testing purposes, not real usage
... date 0..1 dateTime Date last changed
... publisher 0..1 string Name of the publisher (organization or individual)
... contact 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the value set
... useContext 0..* UsageContext The context that the content is intended to support
... immutable 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... lockedDate 0..1 date Fixed date for references with no specified version (transitive)
.... include 0..* BackboneElement Include one or more codes from a code system or other value set(s)
..... system S 1..1 uri The system the codes come from
..... version 0..1 string Specific version of the code system referred to
..... concept 0..* BackboneElement A concept defined in the system
...... code S 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
..... filter 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... property S 1..1 code A property/filter defined by the code system
...... op S 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value S 1..1 string Code from the system, or regex criteria, or boolean value for exists
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... identifier S 1..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... name S 1..1 string Name as assigned by the client or server
..... value[x] 0..1 string Value of the named parameter
.... contains 0..* BackboneElement Codes in the value set
..... system 0..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... version 0..1 string Version in which this code/display is defined
..... code 0..1 code Code - if blank, this is not a selectable code
..... display 0..1 string User display for the concept
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ 0..1 Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... name ΣC 0..1 string Name for this value set (computer friendly)
... title Σ 0..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the value set
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


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

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

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

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

This structure is derived from ValueSet

Summary

Mandatory: 1 element(8 nested mandatory elements)
Must-Support: 9 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
ele-1: All FHIR elements must have a @value or children
... version Σ 0..1 string Business version of the value set
ele-1: All FHIR elements must have a @value or children
... name ΣC 0..1 string Name for this value set (computer friendly)
ele-1: All FHIR elements must have a @value or children
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.


ele-1: All FHIR elements must have a @value or children
... experimental Σ 0..1 boolean For testing purposes, not real usage
ele-1: All FHIR elements must have a @value or children
... date Σ 0..1 dateTime Date last changed
ele-1: All FHIR elements must have a @value or children
... publisher Σ 0..1 string Name of the publisher (organization or individual)
ele-1: All FHIR elements must have a @value or children
... contact Σ 0..* ContactDetail Contact details for the publisher
ele-1: All FHIR elements must have a @value or children
... description 0..1 markdown Natural language description of the value set
ele-1: All FHIR elements must have a @value or children
... useContext Σ 0..* UsageContext The context that the content is intended to support
ele-1: All FHIR elements must have a @value or children
... immutable Σ 0..1 boolean Indicates whether or not any change to the content logical definition may occur
ele-1: All FHIR elements must have a @value or children
... purpose 0..1 markdown Why this value set is defined
ele-1: All FHIR elements must have a @value or children
... copyright 0..1 markdown Use and/or publishing restrictions
ele-1: All FHIR elements must have a @value or children
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... lockedDate Σ 0..1 date Fixed date for references with no specified version (transitive)
ele-1: All FHIR elements must have a @value or children
.... include ΣC 0..* BackboneElement Include one or more codes from a code system or other value set(s)
ele-1: All FHIR elements must have a @value or children
vsd-1: A value set include/exclude SHALL have a value set or a system
vsd-2: A value set with concepts or filters SHALL include a system
vsd-3: Cannot have both concept and filter
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system SΣC 1..1 uri The system the codes come from
ele-1: All FHIR elements must have a @value or children
..... version Σ 0..1 string Specific version of the code system referred to
ele-1: All FHIR elements must have a @value or children
..... concept C 0..* BackboneElement A concept defined in the system
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... code S 1..1 code Code or expression from system
ele-1: All FHIR elements must have a @value or children
...... display 0..1 string Text to display for this code for this value set in this valueset
ele-1: All FHIR elements must have a @value or children
..... filter ΣC 0..* BackboneElement Select codes/concepts by their properties (including relationships)
ele-1: All FHIR elements must have a @value or children
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... property SΣ 1..1 code A property/filter defined by the code system
ele-1: All FHIR elements must have a @value or children
...... op SΣ 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.


ele-1: All FHIR elements must have a @value or children
...... value SΣ 1..1 string Code from the system, or regex criteria, or boolean value for exists
ele-1: All FHIR elements must have a @value or children
.... exclude C 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
ele-1: All FHIR elements must have a @value or children
... expansion 0..1 BackboneElement Used when the value set is "expanded"
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... identifier S 1..1 uri Identifies the value set expansion (business identifier)
ele-1: All FHIR elements must have a @value or children
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
ele-1: All FHIR elements must have a @value or children
.... total 0..1 integer Total number of codes in the expansion
ele-1: All FHIR elements must have a @value or children
.... offset 0..1 integer Offset at which this resource starts
ele-1: All FHIR elements must have a @value or children
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... name S 1..1 string Name as assigned by the client or server
ele-1: All FHIR elements must have a @value or children
..... value[x] 0..1 string Value of the named parameter
ele-1: All FHIR elements must have a @value or children
.... contains C 0..* BackboneElement Codes in the value set
ele-1: All FHIR elements must have a @value or children
vsd-6: SHALL have a code or a display
vsd-9: Must have a code if not abstract
vsd-10: Must have a system if a code is present
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... system 0..1 uri System value for the code
ele-1: All FHIR elements must have a @value or children
..... abstract 0..1 boolean If user cannot select this entry
ele-1: All FHIR elements must have a @value or children
..... version 0..1 string Version in which this code/display is defined
ele-1: All FHIR elements must have a @value or children
..... code C 0..1 code Code - if blank, this is not a selectable code
ele-1: All FHIR elements must have a @value or children
..... display C 0..1 string User display for the concept
ele-1: All FHIR elements must have a @value or children
..... contains 0..* See contains (ValueSet) Codes contained under this entry
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

Differential View

This structure is derived from ValueSet

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet 0..* ValueSet A set of codes drawn from one or more code systems
... url 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier 0..1 Identifier Additional identifier for the value set (business identifier)
... version 0..1 string Business version of the value set
... status S 1..1 code draft | active | retired | unknown
... experimental 0..1 boolean For testing purposes, not real usage
... date 0..1 dateTime Date last changed
... publisher 0..1 string Name of the publisher (organization or individual)
... contact 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the value set
... useContext 0..* UsageContext The context that the content is intended to support
... immutable 0..1 boolean Indicates whether or not any change to the content logical definition may occur
... purpose 0..1 markdown Why this value set is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... compose 0..1 BackboneElement Content logical definition of the value set (CLD)
.... lockedDate 0..1 date Fixed date for references with no specified version (transitive)
.... include 0..* BackboneElement Include one or more codes from a code system or other value set(s)
..... system S 1..1 uri The system the codes come from
..... version 0..1 string Specific version of the code system referred to
..... concept 0..* BackboneElement A concept defined in the system
...... code S 1..1 code Code or expression from system
...... display 0..1 string Text to display for this code for this value set in this valueset
..... filter 0..* BackboneElement Select codes/concepts by their properties (including relationships)
...... property S 1..1 code A property/filter defined by the code system
...... op S 1..1 code = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists
...... value S 1..1 string Code from the system, or regex criteria, or boolean value for exists
.... exclude 0..* See include (ValueSet) Explicitly exclude codes from a code system or other value sets
... expansion 0..1 BackboneElement Used when the value set is "expanded"
.... identifier S 1..1 uri Identifies the value set expansion (business identifier)
.... timestamp S 1..1 dateTime Time ValueSet expansion happened
.... total 0..1 integer Total number of codes in the expansion
.... offset 0..1 integer Offset at which this resource starts
.... parameter 0..* BackboneElement Parameter that controlled the expansion process
..... name S 1..1 string Name as assigned by the client or server
..... value[x] 0..1 string Value of the named parameter
.... contains 0..* BackboneElement Codes in the value set
..... system 0..1 uri System value for the code
..... abstract 0..1 boolean If user cannot select this entry
..... version 0..1 string Version in which this code/display is defined
..... code 0..1 code Code - if blank, this is not a selectable code
..... display 0..1 string User display for the concept
..... contains 0..* See contains (ValueSet) Codes contained under this entry

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet C 0..* ValueSet A set of codes drawn from one or more code systems
vsd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this value set, represented as a URI (globally unique)
... identifier Σ 0..1 Identifier Additional identifier for the value set (business identifier)
... version Σ 0..1 string Business version of the value set
... name ΣC 0..1 string Name for this value set (computer friendly)
... title Σ 0..1 string Name for this value set (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description 0..1 markdown Natural language description of the value set
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for value set (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


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

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

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

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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ValueSet.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ValueSet.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ValueSet.compose.include.concept.designation.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ValueSet.compose.include.concept.designation.useextensibleDesignationUse
http://hl7.org/fhir/ValueSet/designation-use
from the FHIR Standard
ValueSet.compose.include.filter.oprequiredFilterOperator
http://hl7.org/fhir/ValueSet/filter-operator|4.0.1
from the FHIR Standard

This structure is derived from ValueSet

Summary

Mandatory: 1 element(8 nested mandatory elements)
Must-Support: 9 elements

 

Other representations of profile: CSV, Excel, Schematron

Notes:

Supported Interactions

The Interactions supported by this resource are listed below.

Search Parameters

ValueSet resources can be enumerated by retrieving the fhir/List resource with an id of ValueSet

GET [base]/fhir/List/ValueSet?{_format=[json|xml]&_summary=[true|text|data]}

Where:

Name Description
[base] Specifies the base URL of the FHIR Server, e.g.,https://cpsapisandbox.virenceaz.com:9443/demoAPIServer
[_format] Specifies the format of the output and may be xml or json. When present, the _format value overrides the value of the Accept header in the request.
[_summary] Filters the output to include only narrative elements (_summary=text), summary elements (_summary=true) or to omit the generated narrative (_summary=data). Note: If the generated html narrative for the resource is not going to be used by the call, using _summary=data provides improved API response times, especially when returning larger result sets.

HTTP Response Codes

The following HTTP response codes are returned by this API call:

200 OK The query was performed and any results found are contained within the body of the HTTP response. Note: The search API will return 200 OK when the query itself is successful, regardless of whether or not any matching results were found.
401 Unauthorized Authorization is required for this request, and either the Authorization header is missing or the supplied user credentials in the Authorization header are not valid or have expired. The body of the HTTP response will contain an OperationOutcome resource that indicates that Authorization is required.
500 Server Error The server may return other error codes to indicate other error conditions. The body of the HTTP response will contain an OperationOutcome resource that indicates the nature of the error.

Other Operations

The following additional operations are available.
$expand

Expand values from a value set to create collection of codes suitable for use for data entry or validation.

See $expand OperationDefinition for more detail.

$lookup

Given a code/system get additional details about the concept.

See $lookup OperationDefinition for more detail.

$validate-code

Validate that a coded value is in the set of codes allowed by a value set.

See $validate-code OperationDefinition for more detail.