Struct PlanDefinitionBuilder 

pub struct PlanDefinitionBuilder { /* private fields */ }

Builder for PlanDefinitionInner.

Implementations

impl PlanDefinitionBuilder

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

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

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

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

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

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

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

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

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

Canonical identifier for this plan definition, represented as a URI (globally unique)

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

Extension field.

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

Additional identifier for the plan definition

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

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

Extension field.

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

Business version of the plan definition

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

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

Extension field.

pub fn version_algorithm( self, value: PlanDefinitionVersionAlgorithm, ) -> PlanDefinitionBuilder

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: PlanDefinitionVersionAlgorithmExtension, ) -> PlanDefinitionBuilder

Extension field.

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

Name for this plan definition (computer friendly)

A natural language name identifying the plan definition. 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) -> PlanDefinitionBuilder

Extension field.

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

Name for this plan definition (human friendly)

A short, descriptive, user-friendly title for the plan definition.

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

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

Extension field.

pub fn subtitle(self, value: String) -> PlanDefinitionBuilder

Subordinate title of the plan definition

An explanatory or alternate title for the plan definition giving additional information about its content.

pub fn subtitle_ext(self, value: FieldExtension) -> PlanDefinitionBuilder

Extension field.

pub fn type(self, value: CodeableConcept) -> PlanDefinitionBuilder

PlanDefinitionType; order-set | clinical-protocol | eca-rule | workflow-definition

A high-level category for the plan definition that distinguishes the kinds of systems that would be interested in the plan definition.

pub fn type_ext(self, value: FieldExtension) -> PlanDefinitionBuilder

Extension field.

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

PublicationStatus; draft | active | retired | unknown

The status of this plan definition. Enables tracking the life-cycle of the content.

Allows filtering of plan definitions that are appropriate for use versus not.

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

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

Extension field.

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

For testing purposes, not real usage

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

Allows filtering of plan definitions that are appropriate for use versus not.

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

Extension field.

pub fn subject(self, value: PlanDefinitionSubject) -> PlanDefinitionBuilder

Type of individual the plan definition is focused on

A code, group definition, or canonical reference that describes or identifies the intended subject of the plan definition. Canonical references are allowed to support the definition of protocols for drug and substance quality specifications, and is allowed to reference a MedicinalProductDefinition, SubstanceDefinition, AdministrableProductDefinition, ManufacturedItemDefinition, or PackagedProductDefinition resource.

Note that the choice of canonical for the subject element was introduced in R4B to support pharmaceutical quality use cases. To ensure as much backwards-compatibility as possible, it is recommended to only use the new canonical type with these use cases.

pub fn subject_ext( self, value: PlanDefinitionSubjectExtension, ) -> PlanDefinitionBuilder

Extension field.

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

Date last changed

The date (and optionally time) when the plan definition 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 plan definition 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 plan definition. 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) -> PlanDefinitionBuilder

Extension field.

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

Name of the publisher/steward (organization or individual)

The name of the organization or individual responsible for the release and ongoing maintenance of the plan definition.

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

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

Extension field.

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

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

Extension field.

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

Natural language description of the plan definition

A free text natural language description of the plan definition 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 plan definition 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 plan definition is presumed to be the predominant language in the place the plan definition was created).

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

Extension field.

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

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 plan definition 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>>, ) -> PlanDefinitionBuilder

Extension field.

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

Jurisdiction; Intended jurisdiction for plan definition (if applicable)

A legal or geographic region in which the plan definition is intended to be used.

It may be possible for the plan definition 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>>, ) -> PlanDefinitionBuilder

Extension field.

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

Why this plan definition is defined

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

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

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

Extension field.

pub fn usage(self, value: String) -> PlanDefinitionBuilder

Describes the clinical usage of the plan

A detailed description of how the plan definition is used from a clinical perspective.

pub fn usage_ext(self, value: FieldExtension) -> PlanDefinitionBuilder

Extension field.

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

Use and/or publishing restrictions

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

The short copyright declaration (e.g. (c) ‘2015+ xyz organization’ should be sent in the copyrightLabel element.

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

Extension field.

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

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

Extension field.

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

When the plan definition was approved by publisher

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

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

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

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

Extension field.

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

When the plan definition 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, ) -> PlanDefinitionBuilder

Extension field.

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

When the plan definition is expected to be used

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

The effective period for a plan definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a plan definition 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, ) -> PlanDefinitionBuilder

Extension field.

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

DefinitionTopic; E.g. Education, Treatment, Assessment

Descriptive topics related to the content of the plan definition. Topics provide a high-level categorization of the definition that can be useful for filtering and searching.

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

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

Extension field.

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

Who authored the content

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

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

Extension field.

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

Who edited the content

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

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

Extension field.

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

Who reviewed the content

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

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

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

Extension field.

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

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.

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

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

Extension field.

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

Additional documentation, citations

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

Extension field.

pub fn library(self, value: Vec<Option<String>>) -> PlanDefinitionBuilder

Logic used by the plan definition

A reference to a Library resource containing any formal logic used by the plan definition.

pub fn library_ext( self, value: Vec<Option<FieldExtension>>, ) -> PlanDefinitionBuilder

Extension field.

pub fn goal( self, value: Vec<Option<PlanDefinitionGoal>>, ) -> PlanDefinitionBuilder

What the plan is trying to accomplish

A goal describes an expected outcome that activities within the plan are intended to achieve. For example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, meeting the acceptance criteria for a test as specified by a quality specification, etc.

pub fn goal_ext( self, value: Vec<Option<FieldExtension>>, ) -> PlanDefinitionBuilder

Extension field.

pub fn actor( self, value: Vec<Option<PlanDefinitionActor>>, ) -> PlanDefinitionBuilder

Actors within the plan

Actors represent the individuals or groups involved in the execution of the defined set of activities.

pub fn actor_ext( self, value: Vec<Option<FieldExtension>>, ) -> PlanDefinitionBuilder

Extension field.

pub fn action( self, value: Vec<Option<PlanDefinitionAction>>, ) -> PlanDefinitionBuilder

Action defined by the plan

An action or group of actions to be taken as part of the plan. For example, in clinical care, an action would be to prescribe a particular indicated medication, or perform a particular test as appropriate. In pharmaceutical quality, an action would be the test that needs to be performed on a drug product as defined in the quality specification.

Note that there is overlap between many of the elements defined here and the ActivityDefinition resource. When an ActivityDefinition is referenced (using the definition element), the overlapping elements in the plan override the content of the referenced ActivityDefinition unless otherwise documented in the specific elements. See the PlanDefinition resource for more detailed information.

pub fn action_ext( self, value: Vec<Option<FieldExtension>>, ) -> PlanDefinitionBuilder

Extension field.

pub fn as_needed(self, value: PlanDefinitionAsNeeded) -> PlanDefinitionBuilder

Preconditions for service

If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example “pain”, “on flare-up”, etc.

pub fn as_needed_ext( self, value: PlanDefinitionAsNeededExtension, ) -> PlanDefinitionBuilder

Extension field.

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

Builds a new PlanDefinitionInner.

Errors

If a required field has not been initialized.

impl PlanDefinitionBuilder

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

Finalize building PlanDefinition.

Trait Implementations

impl Default for PlanDefinitionBuilder

fn default() -> PlanDefinitionBuilder

Returns the “default value” for a type.