Skip to main content

ValueSet

Struct ValueSet 

Source
pub struct ValueSet {
Show 26 fields pub id: Option<String>, pub meta: Option<Meta>, pub implicit_rules: Option<Uri>, pub language: Option<Code>, pub text: Option<Narrative>, pub contained: Vec<Resource>, pub extension: Vec<Extension>, pub modifier_extension: Vec<Extension>, pub url: Option<Uri>, pub identifier: Vec<Identifier>, pub version: Option<String>, pub name: Option<String>, pub title: Option<String>, pub status: Code, pub experimental: Option<Boolean>, pub date: Option<DateTime>, pub publisher: Option<String>, pub contact: Vec<ContactDetail>, pub description: Option<Markdown>, pub use_context: Vec<UsageContext>, pub jurisdiction: Vec<CodeableConcept>, pub immutable: Option<Boolean>, pub purpose: Option<Markdown>, pub copyright: Option<Markdown>, pub compose: Option<ValueSetCompose>, pub expansion: Option<ValueSetExpansion>,
}
Expand description

A set of codes drawn from one or more code systems

A ValueSet resource instance specifies a set of codes drawn from one or more code systems, intended for use in a particular context. Value sets link between [CodeSystem](codesystem.html) definitions and their use in [coded elements](terminologies.html).

Fields§

§id: Option<String>

Logical id of this artifact

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

§meta: Option<Meta>

Metadata about the resource

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

§implicit_rules: Option<Uri>

A set of rules under which this content was created

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

§language: Option<Code>

Language of the resource content

The base language in which the resource is written.

§text: Option<Narrative>

Text summary of the resource, for human interpretation

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it “clinically safe” for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

§contained: Vec<Resource>

Contained, inline Resources

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

§extension: Vec<Extension>

Additional content defined by implementations

May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

§modifier_extension: Vec<Extension>

Extensions that cannot be ignored

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element’s descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

§url: Option<Uri>

Canonical identifier for this value set, represented as a URI (globally unique)

An absolute URI that is used to identify this value set when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this value set is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the value set is stored on different servers.

§identifier: Vec<Identifier>

Additional identifier for the value set (business identifier)

A formal identifier that is used to identify this value set when it is represented in other formats, or referenced in a specification, model, design or an instance.

§version: Option<String>

Business version of the value set

The identifier that is used to identify this version of the value set when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

§name: Option<String>

Name for this value set (computer friendly)

A natural language name identifying the value set. This name should be usable as an identifier for the module by machine processing applications such as code generation.

§title: Option<String>

Name for this value set (human friendly)

A short, descriptive, user-friendly title for the value set.

§status: Code

draft | active | retired | unknown

The status of this value set. Enables tracking the life-cycle of the content. The status of the value set applies to the value set definition (ValueSet.compose) and the associated ValueSet metadata. Expansions do not have a state.

§experimental: Option<Boolean>

For testing purposes, not real usage

A Boolean value to indicate that this value set is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

§date: Option<DateTime>

Date last changed

The date (and optionally time) when the value set was created or revised (e.g. the ‘content logical definition’).

§publisher: Option<String>

Name of the publisher (organization or individual)

The name of the organization or individual that published the value set.

§contact: Vec<ContactDetail>

Contact details for the publisher

Contact details to assist a user in finding and communicating with the publisher.

§description: Option<Markdown>

Natural language description of the value set

A free text natural language description of the value set from a consumer’s perspective. The textual description specifies the span of meanings for concepts to be included within the Value Set Expansion, and also may specify the intended use and limitations of the Value Set.

§use_context: Vec<UsageContext>

The context that the content is intended to support

The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, …) or may be references to specific programs (insurance plans, studies, …) and may be used to assist with indexing and searching for appropriate value set instances.

§jurisdiction: Vec<CodeableConcept>

Intended jurisdiction for value set (if applicable)

A legal or geographic region in which the value set is intended to be used.

§immutable: Option<Boolean>

Indicates whether or not any change to the content logical definition may occur

If this is set to ‘true’, then no new versions of the content logical definition can be created. Note: Other metadata might still change.

§purpose: Option<Markdown>

Why this value set is defined

Explanation of why this value set is needed and why it has been designed as it has.

§copyright: Option<Markdown>

Use and/or publishing restrictions

A copyright statement relating to the value set and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the value set.

§compose: Option<ValueSetCompose>

Content logical definition of the value set (CLD)

A set of criteria that define the contents of the value set by including or excluding codes selected from the specified code system(s) that the value set draws from. This is also known as the Content Logical Definition (CLD).

§expansion: Option<ValueSetExpansion>

Used when the value set is “expanded”

A value set can also be “expanded”, where the value set is turned into a simple collection of enumerated codes. This element holds the expansion, if it has been performed.

Trait Implementations§

Source§

impl Clone for ValueSet

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for ValueSet

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for ValueSet

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ValueSet

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ValueSet

Source§

impl Json for ValueSet

Source§

fn to_json(&self) -> Result<Object, EncodeError>

The JSON object. Read more
Source§

fn from_json(object: &Object, path: &mut Path) -> Result<Self, DecodeError>

Decodes object, refusing unknown properties. Read more
Source§

impl PartialEq for ValueSet

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for ValueSet

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ValueSet

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.