Struct ValueSetComposeBuilder

pub struct ValueSetComposeBuilder { /* private fields */ }

Builder for ValueSetCompose.

Implementations

impl ValueSetComposeBuilder

pub fn id(self, value: String) -> ValueSetComposeBuilder

Unique id for inter-element referencing

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

pub fn extension(self, value: Vec<Extension>) -> ValueSetComposeBuilder

Additional content defined by implementations

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, 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.

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.

pub fn modifier_extension(self, value: Vec<Extension>) -> ValueSetComposeBuilder

Extensions that cannot be ignored even if unrecognized

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 in which it is contained 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 managable, 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. 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).

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.

pub fn locked_date(self, value: Date) -> ValueSetComposeBuilder

Fixed date for references with no specified version (transitive)

The Locked Date is the effective date that is used to determine the version of all referenced Code Systems and Value Set Definitions included in the compose that are not already tied to a specific version.

With a defined lockedDate the value set is considered “Locked”. Otherwise, the value set may have different expansions as underlying code systems and/or value sets evolve. The interpretation of lockedDate is often dependent on the context - e.g. a SNOMED CT derived value set with a lockedDate will have a different expansion in USA than in UK. If a value set specifies a version for include and exclude statements, and also specifies a locked date, the specified versions need to be available that date, or the value set will not be usable.

pub fn locked_date_ext(self, value: FieldExtension) -> ValueSetComposeBuilder

Extension field.

pub fn inactive(self, value: bool) -> ValueSetComposeBuilder

Whether inactive codes are in the value set

Whether inactive codes - codes that are not approved for current use - are in the value set. If inactive = true, inactive codes are to be included in the expansion, if inactive = false, the inactive codes will not be included in the expansion. If absent, the behavior is determined by the implementation, or by the applicable $expand parameters (but generally, inactive codes would be expected to be included).

Note that in the FHIR terminology framework, “deprecated” does not mean inactive, but in some code systems, e.g. LOINC, “deprecated” does mean inactive. Code systems should define what codes are considered to be inactive. If this is not clearly defined (including in the FHIR code system resource), then all codes are assumed to be active.

The Value Set Definition specification defines an ActiveOnly element, which is the reverse of this element e.g. (ValueSet.compose.inactive=FALSE) is the same as (VSD.ActiveOnly=TRUE).

pub fn inactive_ext(self, value: FieldExtension) -> ValueSetComposeBuilder

Extension field.

pub fn include( self, value: Vec<Option<ValueSetComposeInclude>>, ) -> ValueSetComposeBuilder

Include one or more codes from a code system or other value set(s)

Include one or more codes from a code system or other value set(s).

All the conditions in an include must be true. If a system is listed, all the codes from the system are listed. If one or more filters are listed, all of the filters must apply. If one or more value sets are listed, the codes must be in all the value sets. E.g. each include is ‘include all the codes that meet all these conditions’.

pub fn include_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetComposeBuilder

Extension field.

pub fn exclude( self, value: Vec<Option<ValueSetComposeInclude>>, ) -> ValueSetComposeBuilder

Explicitly exclude codes from a code system or other value sets

Exclude one or more codes from the value set based on code system filters and/or other value sets.

Usually this is used to selectively exclude codes that were included by subsumption in the inclusions. Any display names specified for the codes are ignored.

pub fn exclude_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetComposeBuilder

Extension field.

pub fn property(self, value: Vec<Option<String>>) -> ValueSetComposeBuilder

Property to return if client doesn’t override

A property to return in the expansion, if the client doesn’t ask for any particular properties. May be either a code from the code system definition (convenient) or a the formal URI that refers to the property. The special value ‘*’ means all properties known to the server.

Note that property names can clash, so using a URI is recommended.

pub fn property_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetComposeBuilder

Extension field.

pub fn build(self) -> Result<ValueSetCompose, BuilderError>

Builds a new ValueSetCompose.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for ValueSetComposeBuilder

fn default() -> ValueSetComposeBuilder

Returns the “default value” for a type.