Struct EvidenceVariableBuilder

pub struct EvidenceVariableBuilder { /* private fields */ }

Builder for EvidenceVariableInner.

Implementations

impl EvidenceVariableBuilder

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

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.

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

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.

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

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.

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

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

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

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.

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

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.

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

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.

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

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.

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

Canonical identifier for this evidence variable, represented as a URI (globally unique)

An absolute URI that is used to identify this evidence variable 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 evidence variable is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the evidence variable is stored on different servers.

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.

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

Extension field.

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

Additional identifier for the evidence variable

A formal identifier that is used to identify this evidence variable 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 evidence variable outside of FHIR, where it is not possible to use the logical URI.

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

Extension field.

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

Business version of the evidence variable

The identifier that is used to identify this version of the evidence variable when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the evidence variable 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. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

There may be different evidence variable 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 evidence variable with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.

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

Extension field.

pub fn version_algorithm( self, value: EvidenceVariableVersionAlgorithm, ) -> EvidenceVariableBuilder

How to compare versions

Indicates the mechanism used to compare versions to determine which 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 is newer, and a 0 if the version ordering can’t successfully be determined.

pub fn version_algorithm_ext( self, value: EvidenceVariableVersionAlgorithmExtension, ) -> EvidenceVariableBuilder

Extension field.

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

Name for this evidence variable (computer friendly)

A natural language name identifying the evidence variable. 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.

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

Extension field.

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

Name for this evidence variable (human friendly)

A short, descriptive, user-friendly title for the evidence variable.

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

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

Extension field.

pub fn short_title(self, value: String) -> EvidenceVariableBuilder

Title for use in informal contexts

The short title provides an alternate title for use in informal descriptive contexts where the full, formal title is not necessary.

pub fn short_title_ext(self, value: FieldExtension) -> EvidenceVariableBuilder

Extension field.

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

PublicationStatus; draft | active | retired | unknown

The status of this evidence variable. Enables tracking the life-cycle of the content.

Allows filtering of evidence variables that are appropriate for use versus not.

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

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

Extension field.

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

For testing purposes, not real usage

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

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

Extension field.

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

Date last changed

The date (and optionally time) when the evidence variable was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the evidence variable changes.

The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the evidence variable. 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.

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

Extension field.

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

Name of the publisher/steward (organization or individual)

The name of the organization or individual responsible for the release and ongoing maintenance of the evidence variable.

Usually an organization but may be an individual. The publisher (or steward) of the evidence variable is the organization or individual primarily responsible for the maintenance and upkeep of the evidence variable. 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 evidence variable. This item SHOULD be populated unless the information is available from context.

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

Extension field.

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

Contact details for the publisher

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

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

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

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

Extension field.

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

Natural language description of the evidence variable

A free text natural language description of the evidence variable from a consumer’s perspective.

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the evidence variable as conveyed in the ‘text’ field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the evidence variable is presumed to be the predominant language in the place the evidence variable was created).

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

Extension field.

pub fn note(self, value: Vec<Option<Annotation>>) -> EvidenceVariableBuilder

Used for footnotes or explanatory notes

A human-readable string to clarify or explain concepts about the resource.

pub fn note_ext( self, value: Vec<Option<FieldExtension>>, ) -> EvidenceVariableBuilder

Extension field.

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

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 evidence variable instances.

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

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

Extension field.

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

Why this EvidenceVariable is defined

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

This element does not describe the usage of the EvidenceVariable. 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 EvidenceVariable.

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

Extension field.

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

Use and/or publishing restrictions

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

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

Extension field.

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

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.

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

Extension field.

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

When the resource 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.

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

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

Extension field.

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

When the resource 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.

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

Extension field.

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

When the resource is expected to be used

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

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

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

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

Extension field.

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

Who authored the content

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

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

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

Extension field.

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

Who edited the content

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

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

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

Extension field.

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

Who reviewed the content

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

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

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

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

Extension field.

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

Who endorsed the content

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

Extensions to ContactDetail include: contactReference, contactAddress, and contributionTime (see Clinical Reasoning Module).

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

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

Extension field.

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

Additional documentation, citations, etc

Related artifacts such as additional documentation, justification, or bibliographic references.

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

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

Extension field.

pub fn actual(self, value: bool) -> EvidenceVariableBuilder

Actual or conceptual

True if the actual variable measured, false if a conceptual representation of the intended variable.

pub fn actual_ext(self, value: FieldExtension) -> EvidenceVariableBuilder

Extension field.

pub fn characteristic( self, value: Vec<Option<EvidenceVariableCharacteristic>>, ) -> EvidenceVariableBuilder

A defining factor of the EvidenceVariable

A defining factor of the EvidenceVariable. Multiple characteristics are applied with “and” semantics.

Characteristics can be defined flexibly to accommodate different use cases for membership criteria, ranging from simple codes, all the way to using an expression language to express the criteria.

pub fn characteristic_ext( self, value: Vec<Option<FieldExtension>>, ) -> EvidenceVariableBuilder

Extension field.

pub fn handling( self, value: EvidenceVariableHandling, ) -> EvidenceVariableBuilder

EvidenceVariableHandling; continuous | dichotomous | ordinal | polychotomous

The method of handling in statistical analysis.

pub fn handling_ext(self, value: FieldExtension) -> EvidenceVariableBuilder

Extension field.

pub fn category( self, value: Vec<Option<EvidenceVariableCategory>>, ) -> EvidenceVariableBuilder

A grouping for ordinal or polychotomous variables

A grouping for ordinal or polychotomous variables.

pub fn category_ext( self, value: Vec<Option<FieldExtension>>, ) -> EvidenceVariableBuilder

Extension field.

pub fn build_inner(self) -> Result<EvidenceVariableInner, BuilderError>

Builds a new EvidenceVariableInner.

Errors

If a required field has not been initialized.

impl EvidenceVariableBuilder

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

Finalize building EvidenceVariable.

Trait Implementations

impl Default for EvidenceVariableBuilder

fn default() -> EvidenceVariableBuilder

Returns the “default value” for a type.