NameFlagsCard.TypeDescription & Constraintsdoco
.. ValueSet IDomainResourceA set of codes drawn from one or more code systems
A defined code system (if present) SHALL have a different url than the value set url
Value set SHALL contain at least one of a codeSystem, a compose, or an expansion element
A value set with only one import SHALL also have an include and/or an exclude unless the value set includes and inline code system
... url Σ0..1uriGlobally unique logical identifier for value set
... identifier Σ0..1IdentifierAdditional identifier for the value set (e.g. HL7 v2 / CDA)
... version Σ0..1stringLogical identifier for this version of the value set
... name Σ0..1stringInformal name for this value set
... status ?! Σ1..1codedraft | active | retired
ConformanceResourceStatus (Required)
... experimental Σ0..1booleanIf for testing purposes, not real usage
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*BackboneElementContact details of the publisher
.... name Σ0..1stringName of an individual to contact
.... telecom Σ0..*ContactPointContact details for individual or publisher
... date Σ0..1dateTimeDate for given status
... lockedDate Σ0..1dateFixed date for all referenced code systems and value sets
... description Σ0..1stringHuman language description of the value set
... useContext Σ0..*CodeableConceptContent intends to support these contexts
Context of Use ValueSet (Extensible)
... immutable Σ0..1booleanIndicates whether or not any change to the content logical definition may occur
... requirements 0..1stringWhy needed
... copyright 0..1stringUse and/or publishing restrictions
... extensible Σ0..1booleanWhether this is intended to be used with an extensible binding
... codeSystem Σ I0..1BackboneElementAn inline code system, which is part of this value set
Codes must be unique
Within a code system definition, all the codes SHALL be unique
.... system Σ1..1uriURI to identify the code system (e.g. in Coding.system)
.... version Σ0..1stringVersion (for use in Coding.version)
.... caseSensitive Σ0..1booleanIf code comparison is case sensitive
.... concept 1..*BackboneElementConcepts in the code system
..... code 1..1codeCode that identifies concept
..... abstract 0..1booleanIf this code is not for use as a real concept
..... display 0..1stringText to display to the user
..... definition 0..1stringFormal definition
..... designation 0..*BackboneElementAdditional representations for the concept
...... language 0..1codeHuman language of the designation
Language (Required)
...... use 0..1CodingDetails how this designation would be used
Designation Use (Extensible)
...... value 1..1stringThe text value for this designation
..... concept 0..*see conceptChild Concepts (is-a/contains/categorizes)
... compose I0..1BackboneElementWhen value set includes codes from elsewhere
A value set composition SHALL have an include or an import
.... import Σ I0..*uriImport the contents of another value set
.... include Σ I0..*BackboneElementInclude one or more codes from a code system
Cannot have both concept and filter
..... system Σ1..1uriThe system the codes come from
..... version Σ0..1stringSpecific version of the code system referred to
..... concept I0..*BackboneElementA concept defined in the system
...... code 1..1codeCode or expression from system
...... display 0..1stringTest to display for this code for this value set
...... designation 0..*see designationAdditional representations for this valueset
..... filter I0..*BackboneElementSelect codes/concepts by their properties (including relationships)
...... property 1..1codeA property defined by the code system
...... op 1..1code= | is-a | is-not-a | regex | in | not-in
FilterOperator (Required)
...... value 1..1codeCode from the system, or regex criteria
.... exclude I0..*see includeExplicitly exclude codes
... expansion I0..1BackboneElementUsed when the value set is "expanded"
.... identifier 1..1uriUniquely identifies this expansion
.... timestamp 1..1dateTimeTime ValueSet expansion happened
.... total 0..1integerTotal number of codes in the expansion
.... offset 0..1integerOffset at which this resource starts
.... parameter 0..*BackboneElementParameter that controlled the expansion process
..... name 1..1stringName as assigned by the server
..... value[x] 0..1Value of the named parameter
...... valueStringstring
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueUriuri
...... valueCodecode
.... contains I0..*BackboneElementCodes in the value set
Must have a code if not abstract
SHALL have a code or a display
Must have a system if a code is present
..... system 0..1uriSystem value for the code
..... abstract 0..1booleanIf user cannot select this entry
..... version 0..1stringVersion in which this code/display is defined
..... code I0..1codeCode - if blank, this is not a selectable code
..... display I0..1stringUser display for the concept
..... contains 0..*see containsCodes contained under this entry

doco Documentation for this format