Struct ImplementationGuideBuilder

pub struct ImplementationGuideBuilder { /* private fields */ }

Builder for ImplementationGuideInner.

Implementations

impl ImplementationGuideBuilder

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

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

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

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

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

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

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

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

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

Canonical identifier for this implementation guide, represented as a URI (globally unique)

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

Extension field.

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

Additional identifier for the implementation guide (business identifier)

A formal identifier that is used to identify this implementation guide when it is represented in other formats, or referenced in a specification, model, design or an instance.

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

Extension field.

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

Business version of the implementation guide

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

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

Extension field.

pub fn version_algorithm( self, value: ImplementationGuideVersionAlgorithm, ) -> ImplementationGuideBuilder

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: ImplementationGuideVersionAlgorithmExtension, ) -> ImplementationGuideBuilder

Extension field.

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

Name for this implementation guide (computer friendly)

A natural language name identifying the implementation guide. 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) -> ImplementationGuideBuilder

Extension field.

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

Name for this implementation guide (human friendly)

A short, descriptive, user-friendly title for the implementation guide.

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

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

Extension field.

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

PublicationStatus; draft | active | retired | unknown

The status of this implementation guide. Enables tracking the life-cycle of the content.

Allows filtering of implementation guides that are appropriate for use versus not.

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

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

Extension field.

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

For testing purposes, not real usage

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

Allows filtering of implementation guides that are appropriate for use versus not.

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

Extension field.

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

Date last changed

The date (and optionally time) when the implementation guide 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 implementation guide 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 implementation guide. 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) -> ImplementationGuideBuilder

Extension field.

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

Name of the publisher/steward (organization or individual)

The name of the organization or individual responsible for the release and ongoing maintenance of the implementation guide.

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

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

Extension field.

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

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

Extension field.

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

Natural language description of the implementation guide

A free text natural language description of the implementation guide from a consumer’s perspective.

This description can be used to capture details such as why the implementation guide was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the implementation guide 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 implementation guide is presumed to be the predominant language in the place the implementation guide was created).

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

Extension field.

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

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 implementation guide 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>>, ) -> ImplementationGuideBuilder

Extension field.

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

Jurisdiction; Intended jurisdiction for implementation guide (if applicable)

A legal or geographic region in which the implementation guide is intended to be used.

It may be possible for the implementation guide 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>>, ) -> ImplementationGuideBuilder

Extension field.

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

Why this implementation guide is defined

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

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

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

Extension field.

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

Use and/or publishing restrictions

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

…

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

Extension field.

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

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

Extension field.

pub fn package_id(self, value: String) -> ImplementationGuideBuilder

NPM Package name for IG

The NPM package name for this Implementation Guide, used in the NPM package distribution, which is the primary mechanism by which FHIR based tooling manages IG dependencies. This value must be globally unique, and should be assigned with care.

Many (if not all) IG publishing tools will require that this element be present. For implementation guides published through HL7 or the FHIR foundation, the FHIR product director assigns package IDs.

pub fn package_id_ext(self, value: FieldExtension) -> ImplementationGuideBuilder

Extension field.

pub fn license(self, value: SPDXLicense) -> ImplementationGuideBuilder

SPDXLicense; SPDX license code for this IG (or not-open-source)

The license that applies to this Implementation Guide, using an SPDX license code, or ‘not-open-source’.

pub fn license_ext(self, value: FieldExtension) -> ImplementationGuideBuilder

Extension field.

pub fn fhir_version( self, value: Vec<Option<FHIRVersion>>, ) -> ImplementationGuideBuilder

FHIRVersion; FHIR Version(s) this Implementation Guide targets

The version(s) of the FHIR specification that this ImplementationGuide targets - e.g. describes how to use. The value of this element is the formal version of the specification, without the revision number, e.g. [publication].[major].[minor], which is 4.6.0. for this version.

Most implementation guides target a single version - e.g. they describe how to use a particular version, and the profiles and examples etc. are valid for that version. But some implementation guides describe how to use multiple different versions of FHIR to solve the same problem, or in concert with each other. Typically, the requirement to support multiple versions arises as implementation matures and different implementation communities are stuck at different versions by regulation or market dynamics.

pub fn fhir_version_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImplementationGuideBuilder

Extension field.

pub fn depends_on( self, value: Vec<Option<ImplementationGuideDependsOn>>, ) -> ImplementationGuideBuilder

Another Implementation guide this depends on

Another implementation guide that this implementation depends on. Typically, an implementation guide uses value sets, profiles etc.defined in other implementation guides.

pub fn depends_on_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImplementationGuideBuilder

Extension field.

pub fn global( self, value: Vec<Option<ImplementationGuideGlobal>>, ) -> ImplementationGuideBuilder

Profiles that apply globally

A set of profiles that all resources covered by this implementation guide must conform to.

See Default Profiles for a discussion of which resources are ‘covered’ by an implementation guide.

pub fn global_ext( self, value: Vec<Option<FieldExtension>>, ) -> ImplementationGuideBuilder

Extension field.

pub fn definition( self, value: ImplementationGuideDefinition, ) -> ImplementationGuideBuilder

Information needed to build the IG

The information needed by an IG publisher tool to publish the whole implementation guide.

Principally, this consists of information abuot source resource and file locations, and build parameters and templates.

pub fn definition_ext(self, value: FieldExtension) -> ImplementationGuideBuilder

Extension field.

pub fn manifest( self, value: ImplementationGuideManifest, ) -> ImplementationGuideBuilder

Information about an assembled IG

Information about an assembled implementation guide, created by the publication tooling.

pub fn manifest_ext(self, value: FieldExtension) -> ImplementationGuideBuilder

Extension field.

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

Builds a new ImplementationGuideInner.

Errors

If a required field has not been initialized.

impl ImplementationGuideBuilder

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

Finalize building ImplementationGuide.

Trait Implementations

impl Default for ImplementationGuideBuilder

fn default() -> ImplementationGuideBuilder

Returns the “default value” for a type.