HL7 Terminology (THO)
6.1.0 - Continuous Process Integration (ci build)
HL7 Terminology (THO) - Local Development build (v6.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://terminology.hl7.org/StructureDefinition/expandedvalueset | Version: 1.0.0 | |||
Standards status: Trial-use | Maturity Level: 3 | Responsible: HL7 International / Terminology Infrastructure | Computable Name: ExpandedValueSet |
Defines an executable value set as one that SHALL have an expansion included, as well as a usage warning indicating the expansion is a point-in-time snapshot and must be maintained over time for production usage. The value set expansion specifies the timestamp when the expansion was produced, SHOULD contain the parameters used for the expansion, and SHALL contain the codes that are obtained by evaluating the value set definition. If this is ONLY an executable value set, a computable definition of the value set must be obtained to compute the updated expansion.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | ShareableValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevel (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | Value of extension ele-1: All FHIR elements must have a @value or children Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the value set ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this value set (computer friendly) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this value set (human friendly) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | markdown | Natural language description of the value set ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identifies the value set expansion (business identifier) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Total number of codes in the expansion ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Offset at which this resource starts ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Parameter that controlled the expansion process ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Name as assigned by the client or server ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
SC | 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: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | uri | System value for the code ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | boolean | If user cannot select this entry ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If concept is inactive in the code system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | Version in which this code/display is defined ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | User display for the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Property value for the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Reference to ValueSet.expansion.property.code ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Value of the property for this concept ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
code | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | See contains (ValueSet) | Codes contained under this entry ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
ValueSet.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ValueSet.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
vsd-9 | error | ValueSet.expansion.contains | SHALL have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | error | ValueSet.expansion.contains | SHALL have a system if a code is present : code.empty() or system.exists() |
This structure is derived from ShareableValueSet
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | ShareableValueSet | A set of codes drawn from one or more code systems | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
![]() ![]() ![]() |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identifies the value set expansion (business identifier) |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Time ValueSet expansion happened |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Total number of codes in the expansion |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Offset at which this resource starts |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Parameter that controlled the expansion process |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Codes in the value set |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | System value for the code |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If user cannot select this entry |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If concept is inactive in the code system |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | Version in which this code/display is defined |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Code - if blank, this is not a selectable code |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | User display for the concept |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Property value for the concept |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Reference to ValueSet.expansion.property.code |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code, Coding, string, integer, boolean, dateTime, decimal | Value of the property for this concept |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | Codes contained under this entry | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ShareableValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevel (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the value set | ||||
![]() ![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this value set (human friendly) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
S | 1..1 | markdown | Natural language description of the value set | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this value set is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When the ValueSet was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the ValueSet was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the ValueSet is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the ValueSet | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the ValueSet | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the ValueSet | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the ValueSet | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Content logical definition of the value set (CLD) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | The system the codes come from | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Specific version of the code system referred to | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | A concept defined in the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Code or expression from system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text to display for this code for this value set in this valueset | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Additional representations for this concept vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..* | Coding | Additional ways how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | A property/filter defined by the code system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | A copyright statement for the specific code system included in the value set | |||||
![]() ![]() ![]() ![]() |
0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | |||||
![]() ![]() ![]() ![]() |
0..* | string | Property to return if client doesn't override | |||||
![]() ![]() ![]() |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identifies the value set expansion (business identifier) | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | Opaque urls for paging through expansion results | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Time ValueSet expansion happened | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Total number of codes in the expansion | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Offset at which this resource starts | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Parameter that controlled the expansion process | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Name as assigned by the client or server | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Value of the named parameter | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Additional information supplied about each concept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Identifies the property on the concepts, and when referred to in operations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Formal identifier for the property | |||||
![]() ![]() ![]() ![]() |
SC | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | uri | System value for the code | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | boolean | If user cannot select this entry | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If concept is inactive in the code system | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | Version in which this code/display is defined | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code - if blank, this is not a selectable code | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | User display for the concept | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | See designation (ValueSet) | Additional representations for this item | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Property value for the concept | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Reference to ValueSet.expansion.property.code | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Value of the property for this concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | SubProperty value for the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Reference to ValueSet.expansion.property.code | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Value of the subproperty for this concept | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | See contains (ValueSet) | Codes contained under this entry | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Criteria describing which concepts or codes should be included and why | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Criteria describing which concepts or codes should be excluded and why | |||||
![]() |
Path | Conformance | ValueSet | URI |
ValueSet.language | required | AllLanguages (a valid code from Tags for the Identification of Languages)http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ValueSet.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
ValueSet.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | |
ValueSet.compose.include.concept.designation.language | required | AllLanguages (a valid code from Tags for the Identification of Languages)http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.concept.designation.additionalUse | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ValueSet.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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 | SHALL have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | error | ValueSet.expansion.contains | SHALL have a system if a code is present : code.empty() or system.exists() | |
vsd-11 | error | ValueSet.compose.include.concept.designation | Must have a value for concept.designation.use if concept.designation.additionalUse is present : additionalUse.exists() implies use.exists() |
This structure is derived from ShareableValueSet
mustSupport When this profile has defined an element as mustSupport, the sender must provide the element value when available, and the receiver must accept the element value, persist the value and when appropriate, provide function as defined in the profile. When mustSupport is defined at a complex element level, all sub-elements inherit mustSupport.
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
C | 1..1 | ShareableValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |
![]() ![]() ![]() ![]() |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevel (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | Value of extension ele-1: All FHIR elements must have a @value or children Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the value set ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this value set (computer friendly) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this value set (human friendly) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!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 |
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
S | 1..1 | markdown | Natural language description of the value set ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" ele-1: All FHIR elements must have a @value or children evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identifies the value set expansion (business identifier) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Time ValueSet expansion happened ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Total number of codes in the expansion ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Offset at which this resource starts ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Parameter that controlled the expansion process ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Name as assigned by the client or server ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() |
SC | 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: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | uri | System value for the code ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | boolean | If user cannot select this entry ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If concept is inactive in the code system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | Version in which this code/display is defined ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code - if blank, this is not a selectable code ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | User display for the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Property value for the concept ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Reference to ValueSet.expansion.property.code ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Value of the property for this concept ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
code | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | See contains (ValueSet) | Codes contained under this entry ele-1: All FHIR elements must have a @value or children |
![]() |
Path | Conformance | ValueSet | URI |
ValueSet.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ValueSet.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
vsd-6 | error | ValueSet.expansion.contains | SHALL have a code or a display : code.exists() or display.exists() | |
vsd-9 | error | ValueSet.expansion.contains | SHALL have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | error | ValueSet.expansion.contains | SHALL have a system if a code is present : code.empty() or system.exists() |
Differential View
This structure is derived from ShareableValueSet
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
1..1 | ShareableValueSet | A set of codes drawn from one or more code systems | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. |
![]() ![]() ![]() |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. |
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identifies the value set expansion (business identifier) |
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Time ValueSet expansion happened |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Total number of codes in the expansion |
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Offset at which this resource starts |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Parameter that controlled the expansion process |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Codes in the value set |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | uri | System value for the code |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If user cannot select this entry |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If concept is inactive in the code system |
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | Version in which this code/display is defined |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Code - if blank, this is not a selectable code |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | User display for the concept |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Property value for the concept |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Reference to ValueSet.expansion.property.code |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code, Coding, string, integer, boolean, dateTime, decimal | Value of the property for this concept |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | Codes contained under this entry | |
![]() |
Id | Grade | Path(s) | Details | Requirements |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 1..1 | ShareableValueSet | A set of codes drawn from one or more code systems cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 0..* | code | narrative | semi-structured | structured | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeRepresentationLevel Binding: KnowledgeRepresentationLevel (required) | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Reference to the current trusted source of the ValueSet resource (metadata and definition) URL: http://hl7.org/fhir/StructureDefinition/valueset-authoritativeSource | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | (Complex) | Extra warning about the correct use of the value set URL: http://hl7.org/fhir/StructureDefinition/valueset-warning | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-warning" | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | markdown | Value of extension Fixed Value: This value set contains a point-in-time expansion enumerating the codes that meet the value set intent. As new versions of the code systems used by the value set are released, the contents of this expansion will need to be updated to incorporate newly defined codes that meet the value set intent. Before, and periodically during production use, the value set expansion contents SHOULD be updated. | ||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣC | 1..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) cnl-1: URL should not contain | or # - these characters make processing canonical references problematic | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Business version of the value set | ||||
![]() ![]() ![]() |
SΣ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
SΣC | 0..1 | string | Name for this value set (computer friendly) | ||||
![]() ![]() ![]() |
SΣ | 1..1 | string | Name for this value set (human friendly) | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() ![]() |
SΣ | 0..1 | string | Name of the publisher/steward (organization or individual) | ||||
![]() ![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() ![]() |
S | 1..1 | markdown | Natural language description of the value set | ||||
![]() ![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() ![]() |
Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | ||||
![]() ![]() ![]() |
0..1 | markdown | Why this value set is defined | |||||
![]() ![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() ![]() |
0..1 | string | Copyright holder and year(s) | |||||
![]() ![]() ![]() |
0..1 | date | When the ValueSet was approved by publisher | |||||
![]() ![]() ![]() |
0..1 | date | When the ValueSet was last reviewed by the publisher | |||||
![]() ![]() ![]() |
Σ | 0..1 | Period | When the ValueSet is expected to be used | ||||
![]() ![]() ![]() |
0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who authored the ValueSet | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who edited the ValueSet | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who reviewed the ValueSet | |||||
![]() ![]() ![]() |
0..* | ContactDetail | Who endorsed the ValueSet | |||||
![]() ![]() ![]() |
0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
![]() ![]() ![]() |
0..1 | BackboneElement | Content logical definition of the value set (CLD) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | date | Fixed date for references with no specified version (transitive) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | Whether inactive codes are in the value set | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) vsd-1: A value set include/exclude SHALL have a value set or a system vsd-2: A value set with concepts or filters SHALL include a system vsd-3: Cannot have both concept and filter | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | uri | The system the codes come from | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Specific version of the code system referred to | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | A concept defined in the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Code or expression from system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text to display for this code for this value set in this valueset | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..* | BackboneElement | Additional representations for this concept vsd-11: Must have a value for concept.designation.use if concept.designation.additionalUse is present | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | code | Human language of the designation Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Coding | Types of uses of designations Binding: DesignationUse (extensible): Details of how a designation would be used. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..* | Coding | Additional ways how this designation would be used Binding: DesignationUse (extensible): Details of how a designation would be used. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | The text value for this designation | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | A property/filter defined by the code system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | child-of | descendent-leaf | exists Binding: FilterOperator (required): The kind of operation to perform as a part of a property based filter. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..* | canonical(ValueSet) | Select the contents included in this value set | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | A copyright statement for the specific code system included in the value set | |||||
![]() ![]() ![]() ![]() |
0..* | See include (ValueSet) | Explicitly exclude codes from a code system or other value sets | |||||
![]() ![]() ![]() ![]() |
0..* | string | Property to return if client doesn't override | |||||
![]() ![]() ![]() |
SC | 1..1 | BackboneElement | Used when the value set is "expanded" evs-1: For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | uri | Identifies the value set expansion (business identifier) | ||||
![]() ![]() ![]() ![]() |
0..1 | uri | Opaque urls for paging through expansion results | |||||
![]() ![]() ![]() ![]() |
S | 1..1 | dateTime | Time ValueSet expansion happened | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Total number of codes in the expansion | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | integer | Offset at which this resource starts | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Parameter that controlled the expansion process | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Name as assigned by the client or server | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Value of the named parameter | ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
uri | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Additional information supplied about each concept | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Identifies the property on the concepts, and when referred to in operations | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Formal identifier for the property | |||||
![]() ![]() ![]() ![]() |
SC | 0..* | BackboneElement | Codes in the value set vsd-6: SHALL have a code or a display vsd-9: SHALL have a code if not abstract vsd-10: SHALL have a system if a code is present | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | uri | System value for the code | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | boolean | If user cannot select this entry | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | boolean | If concept is inactive in the code system | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | Version in which this code/display is defined | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 1..1 | code | Code - if blank, this is not a selectable code | ||||
![]() ![]() ![]() ![]() ![]() |
SC | 0..1 | string | User display for the concept | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | See designation (ValueSet) | Additional representations for this item | |||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Property value for the concept | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Reference to ValueSet.expansion.property.code | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Value of the property for this concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | SubProperty value for the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Reference to ValueSet.expansion.property.code | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Value of the subproperty for this concept | ||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
code | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
integer | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
boolean | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
dateTime | |||||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
decimal | |||||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | See contains (ValueSet) | Codes contained under this entry | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Criteria describing which concepts or codes should be included and why | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Criteria describing which concepts or codes should be excluded and why | |||||
![]() |
Path | Conformance | ValueSet | URI |
ValueSet.language | required | AllLanguages (a valid code from Tags for the Identification of Languages)http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.versionAlgorithm[x] | extensible | VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm from the FHIR Standard | |
ValueSet.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0 from the FHIR Standard | |
ValueSet.jurisdiction | extensible | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
ValueSet.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topic from the FHIR Standard | |
ValueSet.compose.include.concept.designation.language | required | AllLanguages (a valid code from Tags for the Identification of Languages)http://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
ValueSet.compose.include.concept.designation.use | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.concept.designation.additionalUse | extensible | DesignationUsehttp://hl7.org/fhir/ValueSet/designation-use from the FHIR Standard | |
ValueSet.compose.include.filter.op | required | FilterOperatorhttp://hl7.org/fhir/ValueSet/filter-operator|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
cnl-0 | warning | ValueSet | Name should be usable as an identifier for the module by machine processing applications such as code generation : name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$') | |
cnl-1 | warning | ValueSet.url | URL should not contain | or # - these characters make processing canonical references problematic : exists() implies matches('^[^|# ]+$') | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
evs-1 | error | ValueSet.expansion | For contains, a version SHALL be provided unless the parameters element has a "system-ve rsion" parameter corresponding to the system of the entry and the version matches the system-version parameter. : contains.version.exists() xor parameter.where(name = 'system-version').exists() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
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 | SHALL have a code if not abstract : code.exists() or abstract = true | |
vsd-10 | error | ValueSet.expansion.contains | SHALL have a system if a code is present : code.empty() or system.exists() | |
vsd-11 | error | ValueSet.compose.include.concept.designation | Must have a value for concept.designation.use if concept.designation.additionalUse is present : additionalUse.exists() implies use.exists() |
This structure is derived from ShareableValueSet
mustSupport When this profile has defined an element as mustSupport, the sender must provide the element value when available, and the receiver must accept the element value, persist the value and when appropriate, provide function as defined in the profile. When mustSupport is defined at a complex element level, all sub-elements inherit mustSupport.
Other representations of profile: CSV, Excel, Schematron