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 / Snapshot
The full effective definition: base ValueSet with this profile's constraints applied.
| 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 |
||
| id | 0..1 | http://hl7.org/fhirpath/System.String | Logical id of this artifact i | |
| meta | 0..1 | Meta | Metadata about the resource Invariants: ele-1 |
|
| implicitRules | ?! | 0..1 | uri | A set of rules under which this content was created i Invariants: ele-1 |
| language | 0..1 | code | Language of the resource content i Binding: languages ( preferred)Invariants: ele-1 |
|
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation i Invariants: ele-1 |
|
| contained | 0..* | Resource | Contained, inline Resources i | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored i Invariants: ele-1, ext-1 |
| url | S | 1..1 | uri | Canonical identity of this list -- the only stable handle on it i Invariants: ele-1 |
| identifier | 0..* | Identifier | Additional identifier for the value set (business identifier) i Invariants: ele-1 |
|
| version | 0..1 | string | Business version of the value set i Invariants: ele-1 |
|
| name | S | 0..1 | string | Name for this value set (computer friendly) i Invariants: ele-1 |
| title | 0..1 | string | Name for this value set (human 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 |
| experimental | 0..1 | boolean | For testing purposes, not real usage i Invariants: ele-1 |
|
| date | 0..1 | dateTime | Date last changed i Invariants: ele-1 |
|
| publisher | 0..1 | string | Name of the publisher (organization or individual) i Invariants: ele-1 |
|
| contact | 0..* | ContactDetail | Contact details for the publisher i Invariants: ele-1 |
|
| description | 0..1 | markdown | Natural language description of the value set i Invariants: ele-1 |
|
| useContext | 0..* | UsageContext | The context that the content is intended to support i Invariants: ele-1 |
|
| jurisdiction | 0..* | CodeableConcept | Intended jurisdiction for value set (if applicable) i Binding: jurisdiction ( extensible)Invariants: ele-1 |
|
| immutable | 0..1 | boolean | Indicates whether or not any change to the content logical definition may occur i Invariants: ele-1 |
|
| purpose | 0..1 | markdown | Why this value set is defined i Invariants: ele-1 |
|
| copyright | 0..1 | markdown | Use and/or publishing restrictions i Invariants: ele-1 |
|
| compose | 0..1 | BackboneElement | Content logical definition of the value set (CLD) Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| lockedDate | 0..1 | date | Fixed date for references with no specified version (transitive) i Invariants: ele-1 |
|
| inactive | 0..1 | boolean | Whether inactive codes are in the value set i 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 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| system | 0..1 | uri | The system the codes come from i Invariants: ele-1 |
|
| version | 0..1 | string | Specific version of the code system referred to i Invariants: ele-1 |
|
| concept | 0..* | BackboneElement | A concept defined in the system i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| code | 1..1 | code | Code or expression from system i Invariants: ele-1 |
|
| display | 0..1 | string | Text to display for this code for this value set in this valueset i Invariants: ele-1 |
|
| designation | 0..* | BackboneElement | Additional representations for this concept i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| language | 0..1 | code | Human language of the designation i Binding: languages ( preferred)Invariants: ele-1 |
|
| use | 0..1 | Coding | Types of uses of designations i Binding: designation-use ( extensible)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 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-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 |
|
| valueSet | 0..* | canonical | Select the contents included in this value set i Invariants: ele-1 |
|
| exclude | 0..* | Explicitly exclude codes from a code system or other value sets 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 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| identifier | 0..1 | uri | Identifies the value set expansion (business identifier) 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 |
| offset | 0..1 | integer | Offset at which this resource starts i Invariants: ele-1 |
|
| parameter | 0..* | BackboneElement | Parameter that controlled the expansion process i Invariants: ele-1 |
|
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| name | 1..1 | string | Name as assigned by the client or server i Invariants: ele-1 |
|
| value[x] | 0..1 | string, boolean, integer, decimal, uri, code, dateTime | Value of the named parameter Invariants: ele-1 |
|
| contains | S | 1..* | BackboneElement | The selectable members, in display order i Invariants: ele-1, vsd-6, vsd-9, vsd-10 |
| id | 0..1 | http://hl7.org/fhirpath/System.String | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations i Slicing: value:url (open) Invariants: ele-1, ext-1 |
|
| extension:secondaryCoding | 0..* | Extension(ValueSet Secondary Coding Extension) | An additional code for the same member i Invariants: ele-1, ext-1 |
|
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored even if unrecognized i Invariants: ele-1, ext-1 |
| system | S | 1..1 | uri | The code system this member's code belongs to Invariants: ele-1 |
| abstract | 0..1 | boolean | If user cannot select this entry i Invariants: ele-1 |
|
| inactive | 0..1 | boolean | If concept is inactive in the code system i Invariants: ele-1 |
|
| version | 0..1 | string | Version in which this code/display is defined i 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 |
| designation | 0..* | Additional representations for this item i Invariants: ele-1 |
||
| contains | 0..* | Codes contained under this entry i Invariants: ele-1 |