Struct ObservationDefinitionBuilder 

pub struct ObservationDefinitionBuilder { /* private fields */ }

Builder for ObservationDefinitionInner.

Implementations

impl ObservationDefinitionBuilder

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

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

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

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

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

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

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

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>, ) -> ObservationDefinitionBuilder

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

Logical canonical URL to reference this ObservationDefinition (globally unique)

An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. This is the URI that will be used when making canonical references to this resource.

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

Extension field.

pub fn identifier(self, value: Identifier) -> ObservationDefinitionBuilder

Business identifier of the ObservationDefinition

Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

This is a business identifier, not a resource identifier. It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types.

pub fn identifier_ext( self, value: FieldExtension, ) -> ObservationDefinitionBuilder

Extension field.

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

Business version of the ObservationDefinition

The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition 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 are orderable.

There may be multiple different instances of an observationDefinition that have the same identifier but different versions.

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

Extension field.

pub fn version_algorithm( self, value: ObservationDefinitionVersionAlgorithm, ) -> ObservationDefinitionBuilder

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 and a 0 if the version ordering can’t be successfully be determined.

pub fn version_algorithm_ext( self, value: ObservationDefinitionVersionAlgorithmExtension, ) -> ObservationDefinitionBuilder

Extension field.

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

Name for this ObservationDefinition (computer friendly)

A natural language name identifying the ObservationDefinition. 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) -> ObservationDefinitionBuilder

Extension field.

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

Name for this ObservationDefinition (human friendly)

A short, descriptive, user-friendly title for the ObservationDefinition.

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

Extension field.

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

PublicationStatus; draft | active | retired | unknown

The current state of the ObservationDefinition.

A nominal state-transition diagram can be found in the Definition pattern documentation Unknown does not represent “other” - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

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

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

Extension field.

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

If for testing purposes, not real usage

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

Allows filtering of ObservationDefinition that are appropriate for use vs. not.

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

Extension field.

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

Date last changed

The date (and optionally time) when the ObservationDefinition 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 ObservationDefinition 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 ObservationDefinition. 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) -> ObservationDefinitionBuilder

Extension field.

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

The name of the individual or organization that published the ObservationDefinition

Helps establish the “authority/credibility” of the ObservationDefinition. May also allow for contact.

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

Extension field.

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

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.

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

Extension field.

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

Natural language description of the ObservationDefinition

A free text natural language description of the ObservationDefinition from the 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 module as conveyed in the text field of the resource itself. This item SHOULD be populated unless the information is available from context.

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

Extension field.

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

Content intends to support these contexts

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

When multiple usageContexts are specified, there is no expectation for whether all or any of the contexts apply.

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

Extension field.

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

Jurisdiction; Intended jurisdiction for this ObservationDefinition (if applicable)

A jurisdiction in which the ObservationDefinition is intended to be used.

It may be possible for the ObservationDefinition 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.)

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

Extension field.

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

Why this ObservationDefinition is defined

Explains why this ObservationDefinition is needed and why it has been designed as it has.

This element does not describe the usage of the ObservationDefinition. Rather it is for 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 ObservationDefinition.

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

Extension field.

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

Use and/or publishing restrictions

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

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

Extension field.

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

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, ) -> ObservationDefinitionBuilder

Extension field.

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

When ObservationDefinition was approved by publisher

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

The date may be more recent than the approval date because of minor changes / editorial corrections.

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

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

Extension field.

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

Date on which the asset content was last reviewed by the publisher

The date on which the asset content was last reviewed. Review happens periodically after that, but doesn’t change the original approval date.

If specified, this is usually after the approval date.

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

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

Extension field.

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

The effective date range for the ObservationDefinition

The period during which the ObservationDefinition content was or is planned to be effective.

The effective period for an ObservationDefinition determines when the content is applicable for usage and is independent of publication and review dates. For example, an observation definition intended to be used for the year 2021 might be published in 2020.

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

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

Extension field.

pub fn derived_from_canonical( self, value: Vec<Option<String>>, ) -> ObservationDefinitionBuilder

Based on FHIR definition of another observation

The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.

pub fn derived_from_canonical_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn derived_from_uri( self, value: Vec<Option<String>>, ) -> ObservationDefinitionBuilder

Based on external definition

The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.

pub fn derived_from_uri_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn subject( self, value: Vec<Option<CodeableConcept>>, ) -> ObservationDefinitionBuilder

Type of subject for the defined observation

A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.

Examples: person, animal, device, air, surface ….

pub fn subject_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn performer_type( self, value: CodeableConcept, ) -> ObservationDefinitionBuilder

Desired kind of performer for such kind of observation

The type of individual/organization/device that is expected to act upon instances of this definition.

pub fn performer_type_ext( self, value: FieldExtension, ) -> ObservationDefinitionBuilder

Extension field.

pub fn category( self, value: Vec<Option<CodeableConcept>>, ) -> ObservationDefinitionBuilder

ObservationCategory; General type of observation

A code that classifies the general type of observation.

This element allows various categorization schemes based on the owner’s definition of the category and effectively multiple categories can be used for one instance of ObservationDefinition. The level of granularity is defined by the category concepts in the value set.

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

Extension field.

pub fn code(self, value: CodeableConcept) -> ObservationDefinitionBuilder

ObservationCode; Type of observation

Describes what will be observed. Sometimes this is called the observation “name”.

pub fn code_ext(self, value: FieldExtension) -> ObservationDefinitionBuilder

Extension field.

pub fn permitted_data_type( self, value: Vec<Option<ObservationDataType>>, ) -> ObservationDefinitionBuilder

ObservationDataType; Quantity | CodeableConcept | string | boolean | integer | Range | Ratio | SampledData | time | dateTime | Period

The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

pub fn permitted_data_type_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn multiple_results_allowed( self, value: bool, ) -> ObservationDefinitionBuilder

Multiple results allowed for conforming observations

Multiple results allowed for observations conforming to this ObservationDefinition.

An example of observation allowing multiple results is “bacteria identified by culture”. Conversely, the measurement of a potassium level allows a single result.

pub fn multiple_results_allowed_ext( self, value: FieldExtension, ) -> ObservationDefinitionBuilder

Extension field.

pub fn body_site(self, value: CodeableConcept) -> ObservationDefinitionBuilder

ObservationBodySite; Body part to be observed

The site on the subject’s body where the observation is to be made.

Only used if the defined observation is to be made directly on a body part and if this body part is not implied by code found in ObservationDefinition.code. Not used for in vitro diagnostic observations. Example: 14975008 |Forearm structure|.

pub fn body_site_ext( self, value: FieldExtension, ) -> ObservationDefinitionBuilder

Extension field.

pub fn method(self, value: CodeableConcept) -> ObservationDefinitionBuilder

ObservationMethod; Method used to produce the observation

The method or technique used to perform the observation.

Only used if not implicit in observation code Example: 702659008 |Automated count technique|.

pub fn method_ext(self, value: FieldExtension) -> ObservationDefinitionBuilder

Extension field.

pub fn specimen( self, value: Vec<Option<Reference>>, ) -> ObservationDefinitionBuilder

Kind of specimen used by this type of observation

The kind of specimen that this type of observation is produced on.

Only used for in vitro observations. When multiple occurrences of specimen are present, they are to be combined with a logical AND: all specified specimens are needed for the observation.

pub fn specimen_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn device( self, value: Vec<Option<Reference>>, ) -> ObservationDefinitionBuilder

Measurement device or model of device

The measurement model of device or actual device used to produce observations of this type.

When multiple occurrences of device are present, they are to be combined with a logical OR: at least one of the specified devices is used to produce the observation.

pub fn device_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn preferred_report_name( self, value: String, ) -> ObservationDefinitionBuilder

The preferred name to be used when reporting the observation results

The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

pub fn preferred_report_name_ext( self, value: FieldExtension, ) -> ObservationDefinitionBuilder

Extension field.

pub fn permitted_unit( self, value: Vec<Option<Coding>>, ) -> ObservationDefinitionBuilder

ObservationUnit; Unit for quantitative results

Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.

pub fn permitted_unit_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn qualified_value( self, value: Vec<Option<ObservationDefinitionQualifiedValue>>, ) -> ObservationDefinitionBuilder

Set of qualified values for observation results

A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

pub fn qualified_value_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn has_member( self, value: Vec<Option<Reference>>, ) -> ObservationDefinitionBuilder

Definitions of related resources belonging to this kind of observation group

This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

pub fn has_member_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

pub fn component( self, value: Vec<Option<ObservationDefinitionComponent>>, ) -> ObservationDefinitionBuilder

Component results

Some observations have multiple component observations, expressed as separate code value pairs.

pub fn component_ext( self, value: Vec<Option<FieldExtension>>, ) -> ObservationDefinitionBuilder

Extension field.

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

Builds a new ObservationDefinitionInner.

Errors

If a required field has not been initialized.

impl ObservationDefinitionBuilder

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

Finalize building ObservationDefinition.

Trait Implementations

impl Default for ObservationDefinitionBuilder

fn default() -> ObservationDefinitionBuilder

Returns the “default value” for a type.