eRS-Specialty-ValueSet-1
ValueSet | |
Definition |
A value set specifies a set of codes drawn from one or more code systems. |
Control | 1..1 |
Type | ValueSet |
Comments | |
ValueSet.status | |
Definition |
The status of the value set. |
Control | 1..1 |
Binding |
The lifecycle status of a Value Set or Concept Map. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/conformance-resource-status |
Type | Code |
Is Modifier | True |
Requirements |
Identify when/if the value set should be used. |
Comments |
Allows filtering of value set instances that are appropriate (or not) for use. |
ValueSet.publisher | |
Definition |
The name of the individual or organization that published the value set. |
Control | 0..1 |
Type | String |
Requirements |
Helps establish the "authority/credibility" of the value set. May also allow for contact. |
Comments |
Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context. |
Fixed Value | NHS Digital |
ValueSet.date | |
Definition |
The date that the value set status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the implementation guide changes (e.g. the 'content logical definition'). |
Control | 0..1 |
Type | DateTime |
Requirements |
Need to know when a value set was first legal for use or became withdrawn or replaced. |
Comments |
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the value set. Additional specific dates may be added as extensions. |
ValueSet.description | |
Definition |
A set of codes to reflect the Specialty for e-RS |
Control | 0..1 |
Type | String |
Requirements |
Human understandability. |
Aliases | Scope, Purpose |
Comments |
The description is not intended to describe the semantics of the Value Set - there are no intrinsic semantics separate from the codes contained in its expansion. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes. A description should be provided unless the value set is a contained resource (e.g. an anonymous value set in a profile). Most registries will require a description. |
ValueSet.codeSystem | |
Definition |
A definition of a code system, inlined into the value set (as a packaging convenience). Note that the inline code system may be used from other value sets by referring to it's (codeSystem.system) directly. |
Control | 0..1 ? |
Type | BackboneElement |
Comments |
All code systems defined as part of a FHIR value set have an implicit valueset that includes all the code in the code system - the value set in which they are defined. |
ValueSet.codeSystem.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ValueSet.codeSystem.system | |
Definition |
An absolute URI that is used to reference this code system, including in [Coding]{datatypes.html#Coding}.system. |
Control | 1..1 |
Type | Uri |
Comments |
The reference is not required to point to any specific kind of definition, but the more information that can be provided, the more useful it is for implementers. Best practice is to resolve to a computable definition of the code system (either a value set, or some other format). Terminology Servers MAY validate this reference (e.g. when accepting PUT/POST), and MAY make additional rules about what kind of content it refers to. |
Fixed Value | http://fhir.nhs.net/ValueSet/ers-specialty-1 |
ValueSet.codeSystem.concept(concept) | |
Definition |
Concepts that are in the code system. The concept definitions are inherently hierarchical, but the definitions must be consulted to determine what the meaning of the hierarchical relationships are. |
Control | 1..* |
Type | BackboneElement |
Comments | |
ValueSet.codeSystem.concept.extension(effectiveToDate) | |
Definition |
The value set concept effective to date. |
Control | 0..1 |
Type | Extension |
Requirements |
The ability to add extensions in a structured way is what keeps FHIR resources simple. |
Comments | |
ValueSet.codeSystem.concept.extension(effectiveFromDate) | |
Definition |
The value set concept effective from date |
Control | 0..1 |
Type | Extension |
Requirements |
The ability to add extensions in a structured way is what keeps FHIR resources simple. |
Comments | |
ValueSet.codeSystem.concept.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ValueSet.codeSystem.concept.code | |
Definition |
A code - a text symbol - that uniquely identifies the concept within the code system. |
Control | 1..1 |
Type | Code |
Comments | |
Example | 2WW |
ValueSet.codeSystem.concept.display | |
Definition |
A human readable string that is the recommended default way to present this concept to a user. |
Control | 1..1 |
Type | String |
Comments | |
Example | 2WW |
ValueSet.codeSystem.concept.designation(designation) | |
Definition |
Additional representations for the concept - other languages, aliases, specialized purposes, used for particular purposes, etc. |
Control | 1..1 |
Type | BackboneElement |
Requirements |
Many concept definition systems support multiple representations, in multiple languages, and for multiple purposes. |
Comments | |
ValueSet.codeSystem.concept.designation.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
Comments |
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
ValueSet.codeSystem.concept.designation.value | |
Definition |
The text value for this designation. |
Control | 1..1 |
Type | String |
Comments | |
Example | 9901 |