pub struct GoalBuilder { /* private fields */ }
Expand description
Builder for GoalInner
.
Implementations§
Source§impl GoalBuilder
impl GoalBuilder
Sourcepub fn id(self, value: String) -> GoalBuilder
pub fn id(self, value: String) -> GoalBuilder
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.
Sourcepub fn meta(self, value: Meta) -> GoalBuilder
pub fn meta(self, value: Meta) -> GoalBuilder
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.
Sourcepub fn implicit_rules(self, value: String) -> GoalBuilder
pub fn implicit_rules(self, value: String) -> GoalBuilder
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.
Sourcepub fn language(self, value: String) -> GoalBuilder
pub fn language(self, value: String) -> GoalBuilder
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).
Sourcepub fn text(self, value: Narrative) -> GoalBuilder
pub fn text(self, value: Narrative) -> GoalBuilder
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.
Sourcepub fn contained(self, value: Vec<Resource>) -> GoalBuilder
pub fn contained(self, value: Vec<Resource>) -> GoalBuilder
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.
Sourcepub fn extension(self, value: Vec<Extension>) -> GoalBuilder
pub fn extension(self, value: Vec<Extension>) -> GoalBuilder
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.
Sourcepub fn modifier_extension(self, value: Vec<Extension>) -> GoalBuilder
pub fn modifier_extension(self, value: Vec<Extension>) -> GoalBuilder
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.
Sourcepub fn identifier(self, value: Vec<Option<Identifier>>) -> GoalBuilder
pub fn identifier(self, value: Vec<Option<Identifier>>) -> GoalBuilder
External Ids for this goal
Business identifiers assigned to this goal by the performer or other systems which remain constant as the resource is updated and propagates from server to server.
This is a business identifier, not a resource identifier (see discussion). 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. For example, multiple Patient and a Person resource instance might share the same social insurance number.
Sourcepub fn identifier_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
pub fn identifier_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
Extension field.
Sourcepub fn lifecycle_status(self, value: GoalLifecycleStatus) -> GoalBuilder
pub fn lifecycle_status(self, value: GoalLifecycleStatus) -> GoalBuilder
GoalLifecycleStatus; proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected
The state of the goal throughout its lifecycle.
This element is labeled as a modifier because the lifecycleStatus contains codes that mark the resource as not currently valid.
Sourcepub fn lifecycle_status_ext(self, value: FieldExtension) -> GoalBuilder
pub fn lifecycle_status_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn achievement_status(self, value: CodeableConcept) -> GoalBuilder
pub fn achievement_status(self, value: CodeableConcept) -> GoalBuilder
GoalAchievementStatus; in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable
Describes the progression, or lack thereof, towards the goal against the target.
Sourcepub fn achievement_status_ext(self, value: FieldExtension) -> GoalBuilder
pub fn achievement_status_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn category(self, value: Vec<Option<CodeableConcept>>) -> GoalBuilder
pub fn category(self, value: Vec<Option<CodeableConcept>>) -> GoalBuilder
GoalCategory; E.g. Treatment, dietary, behavioral, etc
Indicates a category the goal falls within.
Sourcepub fn category_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
pub fn category_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
Extension field.
Sourcepub fn continuous(self, value: bool) -> GoalBuilder
pub fn continuous(self, value: bool) -> GoalBuilder
After meeting the goal, ongoing activity is needed to sustain the goal objective
After meeting the goal, ongoing activity is needed to sustain the goal objective.
For example, getting a yellow fever vaccination for a planned trip is a goal that is designed to be completed (continuous = false). A goal to sustain HbA1c levels would not be a one-time goal (continuous = true).
Sourcepub fn continuous_ext(self, value: FieldExtension) -> GoalBuilder
pub fn continuous_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn priority(self, value: CodeableConcept) -> GoalBuilder
pub fn priority(self, value: CodeableConcept) -> GoalBuilder
GoalPriority; high-priority | medium-priority | low-priority
Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
Extensions are available to track priorities as established by each participant (i.e. Priority from the patient’s perspective, different practitioners’ perspectives, family member’s perspectives)
The ordinal extension on Coding can be used to convey a numerically comparable ranking to priority. (Keep in mind that different coding systems may use a “low value=important”.
Sourcepub fn priority_ext(self, value: FieldExtension) -> GoalBuilder
pub fn priority_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn description(self, value: CodeableConcept) -> GoalBuilder
pub fn description(self, value: CodeableConcept) -> GoalBuilder
GoalDescription; Code or text describing goal
Human-readable and/or coded description of a specific desired objective of care, such as “control blood pressure” or “negotiate an obstacle course” or “dance with child at wedding”.
If no code is available, use CodeableConcept.text.
Sourcepub fn description_ext(self, value: FieldExtension) -> GoalBuilder
pub fn description_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn subject(self, value: Reference) -> GoalBuilder
pub fn subject(self, value: Reference) -> GoalBuilder
Who this goal is intended for
Identifies the patient, group or organization for whom the goal is being established.
Sourcepub fn subject_ext(self, value: FieldExtension) -> GoalBuilder
pub fn subject_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn start(self, value: GoalStart) -> GoalBuilder
pub fn start(self, value: GoalStart) -> GoalBuilder
When goal pursuit begins
The date or event after which the goal should begin being pursued.
Sourcepub fn start_ext(self, value: GoalStartExtension) -> GoalBuilder
pub fn start_ext(self, value: GoalStartExtension) -> GoalBuilder
Extension field.
Sourcepub fn target(self, value: Vec<Option<GoalTarget>>) -> GoalBuilder
pub fn target(self, value: Vec<Option<GoalTarget>>) -> GoalBuilder
Target outcome for the goal
Indicates what should be done by when.
When multiple targets are present for a single goal instance, all targets must be met for the overall goal to be met.
Sourcepub fn target_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
pub fn target_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
Extension field.
Sourcepub fn status_date(self, value: Date) -> GoalBuilder
pub fn status_date(self, value: Date) -> GoalBuilder
When goal status took effect
Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
To see the date for past statuses, query history.
Sourcepub fn status_date_ext(self, value: FieldExtension) -> GoalBuilder
pub fn status_date_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn status_reason(self, value: String) -> GoalBuilder
pub fn status_reason(self, value: String) -> GoalBuilder
Reason for current status
Captures the reason for the current status.
This will typically be captured for statuses such as rejected, on-hold or cancelled, but could be present for others.
Sourcepub fn status_reason_ext(self, value: FieldExtension) -> GoalBuilder
pub fn status_reason_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn source(self, value: Reference) -> GoalBuilder
pub fn source(self, value: Reference) -> GoalBuilder
Who’s responsible for creating Goal?
Indicates whose goal this is - patient goal, practitioner goal, etc.
This is the individual or team responsible for establishing the goal, not necessarily who recorded it. (For that, use the Provenance resource.).
Sourcepub fn source_ext(self, value: FieldExtension) -> GoalBuilder
pub fn source_ext(self, value: FieldExtension) -> GoalBuilder
Extension field.
Sourcepub fn addresses(self, value: Vec<Option<Reference>>) -> GoalBuilder
pub fn addresses(self, value: Vec<Option<Reference>>) -> GoalBuilder
Issues addressed by this goal
The identified conditions and other health record elements that are intended to be addressed by the goal.
Sourcepub fn addresses_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
pub fn addresses_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
Extension field.
Sourcepub fn note(self, value: Vec<Option<Annotation>>) -> GoalBuilder
pub fn note(self, value: Vec<Option<Annotation>>) -> GoalBuilder
Comments about the goal
Any comments related to the goal.
May be used for progress notes, concerns or other related information that doesn’t actually describe the goal itself.
Sourcepub fn note_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
pub fn note_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
Extension field.
Sourcepub fn outcome(self, value: Vec<Option<CodeableReference>>) -> GoalBuilder
pub fn outcome(self, value: Vec<Option<CodeableReference>>) -> GoalBuilder
GoalOutcome; What result was achieved regarding the goal?
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
Note that this should not duplicate the goal status; The goal outcome is independent of the outcome of the related activities. For example, if the Goal is to achieve a target body weight of 150 lb and a care plan activity is defined to diet, then the care plan’s activity outcome could be calories consumed whereas goal outcome is an observation for the actual body weight measured.
Sourcepub fn outcome_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
pub fn outcome_ext(self, value: Vec<Option<FieldExtension>>) -> GoalBuilder
Extension field.
Sourcepub fn build_inner(self) -> Result<GoalInner, BuilderError>
pub fn build_inner(self) -> Result<GoalInner, BuilderError>
Source§impl GoalBuilder
impl GoalBuilder
Sourcepub fn build(self) -> Result<Goal, BuilderError>
pub fn build(self) -> Result<Goal, BuilderError>
Finalize building Goal.