Struct TerminologyCapabilitiesBuilder 

pub struct TerminologyCapabilitiesBuilder { /* private fields */ }

Builder for TerminologyCapabilitiesInner.

Implementations

impl TerminologyCapabilitiesBuilder

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

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

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

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

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

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

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

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

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

Canonical identifier for this terminology capabilities, represented as a URI (globally unique)

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

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

Extension field.

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

Additional identifier for the terminology capabilities

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

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

Extension field.

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

Business version of the terminology capabilities

The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities 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 terminology capabilities 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 terminology capabilities with the format [url]|[version]. The version SHOULD NOT contain a ‘#’ - see Business Version.

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

Extension field.

pub fn version_algorithm( self, value: TerminologyCapabilitiesVersionAlgorithm, ) -> TerminologyCapabilitiesBuilder

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: TerminologyCapabilitiesVersionAlgorithmExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

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

Name for this terminology capabilities (computer friendly)

A natural language name identifying the terminology capabilities. 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) -> TerminologyCapabilitiesBuilder

Extension field.

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

Name for this terminology capabilities (human friendly)

A short, descriptive, user-friendly title for the terminology capabilities.

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

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

Extension field.

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

PublicationStatus; draft | active | retired | unknown

The status of this terminology capabilities. Enables tracking the life-cycle of the content.

Allows filtering of terminology capabilitiess that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.

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

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

Extension field.

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

For testing purposes, not real usage

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

Allows filtering of terminology capabilitiess that are appropriate for use versus not.

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

Extension field.

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

Date last changed

The date (and optionally time) when the terminology capabilities 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 terminology capabilities 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 terminology capabilities. 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) -> TerminologyCapabilitiesBuilder

Extension field.

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

Name of the publisher/steward (organization or individual)

The name of the organization or individual responsible for the release and ongoing maintenance of the terminology capabilities.

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

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

Extension field.

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

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

Extension field.

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

Natural language description of the terminology capabilities

A free text natural language description of the terminology capabilities from a consumer’s perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

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 terminology capabilities 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 terminology capabilities is presumed to be the predominant language in the place the terminology capabilities was created).This does not need to be populated if the description is adequately implied by the software or implementation details.

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

Extension field.

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

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 terminology capabilities 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>>, ) -> TerminologyCapabilitiesBuilder

Extension field.

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

Jurisdiction; Intended jurisdiction for terminology capabilities (if applicable)

A legal or geographic region in which the terminology capabilities is intended to be used.

It may be possible for the terminology capabilities 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>>, ) -> TerminologyCapabilitiesBuilder

Extension field.

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

Why this terminology capabilities is defined

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

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

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

Extension field.

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

Use and/or publishing restrictions

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

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

Extension field.

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

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

Extension field.

pub fn kind( self, value: CapabilityStatementKind, ) -> TerminologyCapabilitiesBuilder

CapabilityStatementKind; instance | capability | requirements

The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

pub fn kind_ext(self, value: FieldExtension) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn software( self, value: TerminologyCapabilitiesSoftware, ) -> TerminologyCapabilitiesBuilder

Software that is covered by this terminology capability statement

Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.

pub fn software_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn implementation( self, value: TerminologyCapabilitiesImplementation, ) -> TerminologyCapabilitiesBuilder

If this describes a specific instance

Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.

pub fn implementation_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn locked_date(self, value: bool) -> TerminologyCapabilitiesBuilder

Whether lockedDate is supported

Whether the server supports lockedDate.

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

Extension field.

pub fn code_system( self, value: Vec<Option<TerminologyCapabilitiesCodeSystem>>, ) -> TerminologyCapabilitiesBuilder

A code system supported by the server

Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.

The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.

pub fn code_system_ext( self, value: Vec<Option<FieldExtension>>, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn expansion( self, value: TerminologyCapabilitiesExpansion, ) -> TerminologyCapabilitiesBuilder

Information about the ValueSet/$expand operation

Information about the ValueSet/$expand operation.

pub fn expansion_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn code_search( self, value: CodeSearchSupport, ) -> TerminologyCapabilitiesBuilder

CodeSearchSupport; in-compose | in-expansion | in-compose-or-expansion

The degree to which the server supports the code search parameter on ValueSet, if it is supported.

See notes on the ValueSet resource.

pub fn code_search_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn validate_code( self, value: TerminologyCapabilitiesValidateCode, ) -> TerminologyCapabilitiesBuilder

Information about the ValueSet/$validate-code operation

Information about the ValueSet/$validate-code operation.

pub fn validate_code_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn translation( self, value: TerminologyCapabilitiesTranslation, ) -> TerminologyCapabilitiesBuilder

Information about the ConceptMap/$translate operation

Information about the ConceptMap/$translate operation.

pub fn translation_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

pub fn closure( self, value: TerminologyCapabilitiesClosure, ) -> TerminologyCapabilitiesBuilder

Information about the ConceptMap/$closure operation

Whether the $closure operation is supported.

pub fn closure_ext( self, value: FieldExtension, ) -> TerminologyCapabilitiesBuilder

Extension field.

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

Builds a new TerminologyCapabilitiesInner.

Errors

If a required field has not been initialized.

impl TerminologyCapabilitiesBuilder

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

Finalize building TerminologyCapabilities.

Trait Implementations

impl Default for TerminologyCapabilitiesBuilder

fn default() -> TerminologyCapabilitiesBuilder

Returns the “default value” for a type.