Struct ValueSetBuilder

Source

pub struct ValueSetBuilder { /* private fields */ }

Expand description

Builder for ValueSetInner.

Implementations§

Source §

impl ValueSetBuilder

Source

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

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.

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Source

pub fn meta(self, value: Meta) -> ValueSetBuilder

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.

Source

pub fn implicit_rules(self, value: String) -> ValueSetBuilder

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.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Source

pub fn language(self, value: String) -> ValueSetBuilder

Language; Language of the resource content

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Source

pub fn text(self, value: Narrative) -> ValueSetBuilder

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 resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a “text blob” or where text is additionally entered raw or narrated and encoded information is added later.

Source

pub fn contained(self, value: Vec<Resource>) -> ValueSetBuilder

Contained, inline Resources

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Source

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

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 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.

Source

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

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 managable, 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).

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.

Source

pub fn url(self, value: String) -> ValueSetBuilder

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 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.

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Source

pub fn url_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn identifier(self, value: Vec<Option<Identifier>>) -> ValueSetBuilder

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.

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this value set outside of FHIR, where it is not possible to use the logical URI.

Source

pub fn identifier_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetBuilder

Extension field.

Source

pub fn version(self, value: String) -> ValueSetBuilder

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.

There may be different value set instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the value set with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.

Source

pub fn version_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn version_algorithm( self, value: ValueSetVersionAlgorithm, ) -> ValueSetBuilder

How to compare versions

Indicates the mechanism used to compare versions to determine which ValueSet is more current.

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can’t be successfully be determined.

Source

pub fn version_algorithm_ext( self, value: ValueSetVersionAlgorithmExtension, ) -> ValueSetBuilder

Extension field.

Source

pub fn name(self, value: String) -> ValueSetBuilder

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.

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.A name 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 name.

Source

pub fn name_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn title(self, value: String) -> ValueSetBuilder

Name for this value set (human friendly)

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

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Source

pub fn title_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn status(self, value: PublicationStatus) -> ValueSetBuilder

PublicationStatus; 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.

Allows filtering of value sets that are appropriate for use versus not.See also the http://hl7.org/fhir/StructureDefinition/valueset-workflowStatusDescription extension for additional status information related to the editorial process.

See guidance around (not) making local changes to elements here.

Source

pub fn status_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn experimental(self, value: bool) -> ValueSetBuilder

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.

Allows filtering of value sets that are appropriate for use versus not.

Source

pub fn experimental_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn date(self, value: DateTime) -> ValueSetBuilder

Date last changed

The date (and optionally time) when the value set metadata or content logical definition (.compose) was created or revised.

Note that this is not the same as the meta.lastUpdated which is specific to an instance of a value set resource on a server. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Source

pub fn date_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn publisher(self, value: String) -> ValueSetBuilder

Name of the publisher/steward (organization or individual)

The name of the organization or individual responsible for the release and ongoing maintenance of the value set.

Usually an organization but may be an individual. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the value set. This item SHOULD be populated unless the information is available from context.

Source

pub fn publisher_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn contact(self, value: Vec<Option<ContactDetail>>) -> ValueSetBuilder

Contact details for the publisher

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

May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Source

pub fn contact_ext(self, value: Vec<Option<FieldExtension>>) -> ValueSetBuilder

Extension field.

Source

pub fn description(self, value: String) -> ValueSetBuilder

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.

Description SHOULD contain instructions for clinical or administrative use and interpretation and information about misuse. Description SHOULD be populated unless the information is available from context. Description SHOULD be populated unless the value set is a contained resource (e.g. a value set defined solely in the context of a profile).

Source

pub fn description_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn use_context(self, value: Vec<Option<UsageContext>>) -> ValueSetBuilder

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.

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Source

pub fn use_context_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetBuilder

Extension field.

Source

pub fn jurisdiction( self, value: Vec<Option<CodeableConcept>>, ) -> ValueSetBuilder

Jurisdiction; Intended jurisdiction for value set (if applicable)

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

It may be possible for the value set to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new ‘jurisdiction’ code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Source

pub fn jurisdiction_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetBuilder

Extension field.

Source

pub fn immutable(self, value: bool) -> ValueSetBuilder

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.

Normally immutability is set to ‘false’, which is the default assumption if it is not populated. Note that the implication is that if this is set to ‘true’, there may be only one ValueSet version for this definition. Immutability tends to be set to ‘true’ in one of two cases: - Where the value set, by the nature of its usage, cannot change. For example “All specializations of ACT in ActClassCode” - Where there’s no safe way to express the “Purpose” such that someone else could safely make changes to the value set definition. Source workflow control must guarantee that the same URI always yields the same definition.

Source

pub fn immutable_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn purpose(self, value: String) -> ValueSetBuilder

Why this value set is defined

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

This element does not describe the usage of the value set. Instead, it provides traceability of ’‘why’’ the resource is either needed or ’‘why’’ it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this value set.

Source

pub fn purpose_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn copyright(self, value: String) -> ValueSetBuilder

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.

Frequently, the copyright differs between the value set and the codes that are included. The copyright statement should clearly differentiate between these when required.

Source

pub fn copyright_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn copyright_label(self, value: String) -> ValueSetBuilder

Copyright holder and year(s)

A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. ‘All rights reserved’, ‘Some rights reserved’).

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general ‘copyright’ element.

Source

pub fn copyright_label_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn approval_date(self, value: Date) -> ValueSetBuilder

When the ValueSet was approved by publisher

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

The ‘date’ element may be more recent than the approval date because of minor changes or editorial corrections.

See guidance around (not) making local changes to elements here.

Source

pub fn approval_date_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn last_review_date(self, value: Date) -> ValueSetBuilder

When the ValueSet was last reviewed by the publisher

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

If specified, this date follows the original approval date.

See guidance around (not) making local changes to elements here.

Source

pub fn last_review_date_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn effective_period(self, value: Period) -> ValueSetBuilder

When the ValueSet is expected to be used

The period during which the ValueSet content was or is planned to be in active use.

The effective period for a ValueSet determines when the content is applicable for usage and is independent of publication and review dates. For example, a valueset intended to be used for the year 2016 might be published in 2015.

See guidance around (not) making local changes to elements here.

Source

pub fn effective_period_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn topic(self, value: Vec<Option<CodeableConcept>>) -> ValueSetBuilder

DefinitionTopic; E.g. Education, Treatment, Assessment, etc

Descriptions related to the content of the ValueSet. Topics provide a high-level categorization as well as keywords for the ValueSet that can be useful for filtering and searching.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new ‘topic’ code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

Source

pub fn topic_ext(self, value: Vec<Option<FieldExtension>>) -> ValueSetBuilder

Extension field.

Source

pub fn author(self, value: Vec<Option<ContactDetail>>) -> ValueSetBuilder

Who authored the ValueSet

An individiual or organization primarily involved in the creation and maintenance of the ValueSet.

Source

pub fn author_ext(self, value: Vec<Option<FieldExtension>>) -> ValueSetBuilder

Extension field.

Source

pub fn editor(self, value: Vec<Option<ContactDetail>>) -> ValueSetBuilder

Who edited the ValueSet

An individual or organization primarily responsible for internal coherence of the ValueSet.

Source

pub fn editor_ext(self, value: Vec<Option<FieldExtension>>) -> ValueSetBuilder

Extension field.

Source

pub fn reviewer(self, value: Vec<Option<ContactDetail>>) -> ValueSetBuilder

Who reviewed the ValueSet

An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ValueSet.

See guidance around (not) making local changes to elements here.

Source

pub fn reviewer_ext(self, value: Vec<Option<FieldExtension>>) -> ValueSetBuilder

Extension field.

Source

pub fn endorser(self, value: Vec<Option<ContactDetail>>) -> ValueSetBuilder

Who endorsed the ValueSet

An individual or organization asserted by the publisher to be responsible for officially endorsing the ValueSet for use in some setting.

See guidance around (not) making local changes to elements here.

Source

pub fn endorser_ext(self, value: Vec<Option<FieldExtension>>) -> ValueSetBuilder

Extension field.

Source

pub fn related_artifact( self, value: Vec<Option<RelatedArtifact>>, ) -> ValueSetBuilder

Additional documentation, citations, etc

Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

Each related artifact is either an attachment, or a reference to another resource, but not both.

Source

pub fn related_artifact_ext( self, value: Vec<Option<FieldExtension>>, ) -> ValueSetBuilder

Extension field.

Source

pub fn compose(self, value: ValueSetCompose) -> ValueSetBuilder

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).

Source

pub fn compose_ext(self, value: FieldExtension) -> ValueSetBuilder

Extension field.

Source

pub fn expansion(self, value: ValueSetExpansion) -> ValueSetBuilder

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.

Expansion is performed to produce a collection of codes that are ready to use for data entry or validation. Value set expansions are always considered to be stateless - they are a record of the set of codes in the value set at a point in time under a given set of conditions, and are not subject to ongoing maintenance.

Expansion.parameter is a simplified list of parameters - a subset of the features of the Parameters resource.

Source