| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| N | DomainResource | A set of codes drawn from one or more code systems + Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension Interfaces Implemented: MetadataResource | ||||||
| ΣC | 0..1 | uri | Canonical identifier for this value set, represented as a URI (globally unique) + Warning: URL should not contain | or # - these characters make processing canonical references problematic | |||||
| Σ | 0..* | Identifier | Additional identifier for the value set (business identifier) | |||||
| Σ | 0..1 | string | Business version of the value set | |||||
| ΣTU | 0..1 | How to compare versions Binding: Version Algorithm (Extensible) | ||||||
| string | ||||||||
| Coding | ||||||||
| ΣC | 0..1 | string | Name for this value set (computer friendly) | |||||
| ΣT | 0..1 | string | Name for this value set (human friendly) | |||||
| ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (Required) | |||||
| Σ | 0..1 | boolean | For testing purposes, not real usage | |||||
| Σ | 0..1 | dateTime | Date last changed | |||||
| ΣT | 0..1 | string | Name of the publisher/steward (organization or individual) | |||||
| Σ | 0..* | ContactDetail | Contact details for the publisher | |||||
| T | 0..1 | markdown | Natural language description of the value set | |||||
| ΣTU | 0..* | UsageContext | The context that the content is intended to support | |||||
| ΣXD | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) Binding: Jurisdiction ValueSet (Extensible) | |||||
| Σ | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur | |||||
| T | 0..1 | markdown | Why this value set is defined | |||||
| T | 0..1 | markdown | Use and/or publishing restrictions | |||||
| TTU | 0..1 | string | Copyright holder and year(s) | |||||
| TU | 0..1 | date | When the ValueSet was approved by publisher | |||||
| TU | 0..1 | date | When the ValueSet was last reviewed by the publisher | |||||
| ΣTU | 0..1 | Period | When the ValueSet is expected to be used | |||||
| XD | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: Definition Topic (Example) | |||||
| TU | 0..* | ContactDetail | Who authored the ValueSet | |||||
| TU | 0..* | ContactDetail | Who edited the ValueSet | |||||
| TU | 0..* | ContactDetail | Who reviewed the ValueSet | |||||
| TU | 0..* | ContactDetail | Who endorsed the ValueSet | |||||
| TU | 0..* | RelatedArtifact | Additional documentation, citations, etc | |||||
| 0..1 | BackboneElement | Content logical definition of the value set (CLD) | ||||||
| Σ | 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) + Rule: A value set include/exclude SHALL have a value set or a system + Rule: A value set with concepts or filters SHALL include a system + Rule: Cannot have both concept and filter | |||||
| Σ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 | |||||
| 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 + Rule: Must have a value for concept.designation.use if concept.designation.additionalUse is present | |||||
| 0..1 | code | Human language of the designation Binding: All Languages (Required)
| ||||||
| C | 0..1 | Coding | Types of uses of designations Binding: Designation Use (Extensible) | |||||
| CTU | 0..* | Coding | Additional ways how this designation would be used Binding: Designation Use (Extensible) | |||||
| 1..1 | string | The text value for this designation | ||||||
| ΣC | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) | |||||
| Σ | 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: Filter Operator (Required) | |||||
| Σ | 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 | |||||
| TU | 0..1 | string | A copyright statement for the specific code system included in the value set | |||||
| 0..* | see include | Explicitly exclude codes from a code system or other value sets | ||||||
| TU | 0..* | string | Property to return if client doesn't override | |||||
| 0..1 | BackboneElement | Used when the value set is "expanded" | ||||||
| 0..1 | uri | Identifies the value set expansion (business identifier) | ||||||
| TU | 0..1 | uri | Opaque urls for paging through expansion results | |||||
| 1..1 | dateTime | Time ValueSet expansion happened | ||||||
| 0..1 | integer | Total number of codes in the expansion | ||||||
| 0..1 | integer | Offset at which this resource starts | ||||||
| 0..* | BackboneElement | Parameter that controlled the expansion process | ||||||
| 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 | ||||||||
| TU | 0..* | BackboneElement | Additional information supplied about each concept | |||||
| 1..1 | code | Identifies the property on the concepts, and when referred to in operations | ||||||
| 0..1 | uri | Formal identifier for the property | ||||||
| C | 0..* | BackboneElement | Codes in the value set + Rule: SHALL have a code or a display + Rule: SHALL have a code if not abstract + Rule: SHALL have a system if a code is present | |||||
| C | 0..1 | uri | System value for the code | |||||
| C | 0..1 | boolean | If user cannot select this entry | |||||
| 0..1 | boolean | If concept is inactive in the code system | ||||||
| 0..1 | string | Version in which this code/display is defined | ||||||
| C | 0..1 | code | Code - if blank, this is not a selectable code | |||||
| C | 0..1 | string | User display for the concept | |||||
| 0..* | see designation | Additional representations for this item | ||||||
| TU | 0..* | BackboneElement | Property value for the concept | |||||
| 1..1 | code | Reference to ValueSet.expansion.property.code | ||||||
| 1..1 | Value of the property for this concept | |||||||
| code | ||||||||
| Coding | ||||||||
| string | ||||||||
| integer | ||||||||
| boolean | ||||||||
| dateTime | ||||||||
| decimal | ||||||||
| 0..* | BackboneElement | SubProperty value for the concept | ||||||
| 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 | ||||||||
| 0..* | see contains | Codes contained under this entry | ||||||
| TU | 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 | 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 | ||||||