Curated Value Set Profile¶
| Canonical | ../StructureDefinition/nexus-valueset |
|---|---|
| Status | draft · 1.26.0 |
| Base | ValueSet (constraint) |
| Source | FSH · JSON |
A curated pick-list as this estate stores one: the coded options a clinician chooses from in the chart, held per tenant and fetched by the application at the point of use.
Elements / Key elements
The working view: must-support, required, modifier and sliced elements from the effective (snapshot) definition.
| Element | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ValueSet | 0..* | A set of codes drawn from one or more code systems Invariants: dom-2, dom-3, dom-4, dom-5, dom-6, vsd-0 |
||
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| url | S | 1..1 | uri | Canonical identity of this list -- the only stable handle on it i Invariants: ele-1 |
| name | S | 0..1 | string | Name for this value set (computer friendly) i Invariants: ele-1 |
| status | S ?! | 1..1 | code | Lifecycle of the list itself, not of its members i Binding: publication-status ( required)Invariants: ele-1 |
| compose | 0..1 | BackboneElement | Content logical definition of the value set (CLD) Invariants: ele-1 |
|
| include | 1..* | BackboneElement | Include one or more codes from a code system or other value set(s) i Invariants: ele-1, vsd-1, vsd-2, vsd-3 |
|
| concept | 0..* | BackboneElement | A concept defined in the system i Invariants: ele-1 |
|
| code | 1..1 | code | Code or expression from system i Invariants: ele-1 |
|
| designation | 0..* | BackboneElement | Additional representations for this concept i Invariants: ele-1 |
|
| value | 1..1 | string | The text value for this designation Invariants: ele-1 |
|
| filter | 0..* | BackboneElement | Select codes/concepts by their properties (including relationships) i Invariants: ele-1 |
|
| property | 1..1 | code | A property/filter defined by the code system Invariants: ele-1 |
|
| op | 1..1 | code | = | is-a | descendent-of | is-not-a | regex | in | not-in | generalizes | exists i Binding: filter-operator ( required)Invariants: ele-1 |
|
| value | 1..1 | string | Code from the system, or regex criteria, or boolean value for exists i Invariants: ele-1 |
|
| expansion | S | 1..1 | BackboneElement | The resolved members -- REQUIRED, because a consumer builds the picker from it i Invariants: ele-1 |
| timestamp | S | 1..1 | dateTime | When these members were resolved i Invariants: ele-1 |
| total | S | 0..1 | integer | Member count, where the producer states it i Invariants: ele-1 |
| parameter | 0..* | BackboneElement | Parameter that controlled the expansion process i Invariants: ele-1 |
|
| name | 1..1 | string | Name as assigned by the client or server i Invariants: ele-1 |
|
| contains | S | 1..* | BackboneElement | The selectable members, in display order i Invariants: ele-1, vsd-6, vsd-9, vsd-10 |
| extension:secondaryCoding | 0..* | Extension(ValueSet Secondary Coding Extension) | An additional code for the same member i Invariants: ele-1, ext-1 |
|
| system | S | 1..1 | uri | The code system this member's code belongs to Invariants: ele-1 |
| code | S | 1..1 | code | The code stored when this member is chosen Invariants: ele-1 |
| display | S | 1..1 | string | What the clinician reads -- REQUIRED, an absent one renders blank i Invariants: ele-1 |