PlanDefinitionGoal class
PlanDefinitionGoal 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.
- Inheritance
-
- Object
- FhirBase
- Element
- DataType
- BackboneElement
- PlanDefinitionGoal
- Available extensions
Constructors
-
PlanDefinitionGoal({FhirString? id, List<
FhirExtension> ? extension_, List<FhirExtension> ? modifierExtension, CodeableConcept? category, required CodeableConcept description, CodeableConcept? priority, CodeableConcept? start, List<CodeableConcept> ? addresses, List<RelatedArtifact> ? documentation, List<PlanDefinitionTarget> ? target, bool? disallowExtensions = false}) -
Primary constructor for
PlanDefinitionGoal
const
-
PlanDefinitionGoal.fromJson(Map<
String, dynamic> json) -
Factory constructor that accepts Map<String, dynamic> as an argument
factory
- PlanDefinitionGoal.fromJsonString(String source)
-
Factory constructor for
PlanDefinitionGoal
that takes in a String
Convenience method to avoid the json Encoding/Decoding normally required
to get data from a String
factory
- PlanDefinitionGoal.fromYaml(dynamic yaml)
-
Deserialize PlanDefinitionGoal
from a String or
YamlMap
objectfactory
Properties
-
addresses
→ List<
CodeableConcept> ? -
addresses
Identifies problems, conditions, issues, or concerns the goal is
intended to address.
final
- category → CodeableConcept?
-
category
Indicates a category the goal falls within.
final
-
copyWith
→ $PlanDefinitionGoalCopyWith<
PlanDefinitionGoal> -
Copy function for PlanDefinitionGoal
Returns a copy of the current instance with the provided fields modified.
If a field is not provided, it will retain its original value.
If a null is provided, this will clearn the field, unless the
field is required, in which case it will keep its current value.
no setteroverride
-
copyWith
→ $PlanDefinitionGoalCopyWith<
PlanDefinitionGoal> -
Available on PlanDefinitionGoal, provided by the PlanDefinitionGoalCopyWithExtension extension
no setter - description → CodeableConcept
-
description
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".
final
- disallowExtensions → bool?
-
This is used in the FHIRPath engine to record that no extensions are
allowed for this item in the context in which it is used.
to do: enforce this....
finalinherited
-
documentation
→ List<
RelatedArtifact> ? -
documentation
Didactic or other informational resources associated with the goal that
provide further supporting information about the goal. Information
resources can include inline text commentary and links to web
resources.
final
-
extension_
→ List<
FhirExtension> ? -
List of extensions for additional information.
finalinherited
- fhirType → String
-
Returns the FHIR type of the object.
no setteroverride
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasId → bool
-
Getter for checking if the element has an id.
no setterinherited
- hasPrimitiveValue → bool
-
Checks if the object has a primitive value.
no setterinherited
- id → FhirString?
-
Unique id for the element within a resource.
finalinherited
- isMetadataBased → bool
-
All Elements are metadata based.
no setterinherited
- isPrimitive → bool
-
Checks if the object is primitive.
no setterinherited
-
modifierExtension
→ List<
FhirExtension> ? -
List of modifier extensions for additional, non-core information
finalinherited
- primitiveValue → String?
-
Retrieves the primitive value of the object.
no setterinherited
- priority → CodeableConcept?
-
priority
Identifies the expected level of importance associated with
reaching/sustaining the defined goal.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- start → CodeableConcept?
-
start
The event after which the goal should begin being pursued.
final
-
target
→ List<
PlanDefinitionTarget> ? -
target
Indicates what should be done and within what timeframe.
final
Methods
-
addExtension(
FhirExtension ext) → void -
Method to add an extension.
inherited
-
addModifierExtension(
FhirExtension ext) → void -
Adds a modifier extension
inherited
-
clone(
) → PlanDefinitionGoal -
Subclasses must implement the clone method.
override
-
compareDeepStrings(
String? s1, String? s2, bool allowNull) → bool -
Checks if the object is equal to another object.
inherited
-
equalsDeep(
FhirBase? o) → bool -
Performs a deep comparison between two instances.
override
-
equalsShallow(
Element other) → bool -
Method to compare shallow equality of two elements.
inherited
-
getChildByName(
String name) → FhirBase? -
Retrieves a single field value by its name.
override
-
getChildrenByName(
String fieldName, [bool checkValid = false]) → List< FhirBase> -
Retrieves all matching child fields by name.
Optionally validates the name.
override
-
getExtensionFirstRep(
) → FhirExtension -
Getter for the first extension.
inherited
-
getExtensionsByUrl(
String url) → List< FhirExtension> -
Getter for the first extension by url.
inherited
-
getModifierExtensionFirstRep(
) → FhirExtension -
Gets the first repetition of modifier extensions
inherited
-
getModifierExtensionsByUrl(
String url) → List< FhirExtension> -
Retrieves all modifier extensions by URL
inherited
-
hasExtension(
) → bool -
Extension handling methods.
inherited
-
hasExtensionByUrl(
String url) → bool -
Method to check if an extension exists by url.
inherited
-
hasModifierExtension(
) → bool -
Method to check if there are any modifier extensions
inherited
-
hasType(
List< String> names) → bool -
Checks if the object has a given type.
inherited
-
hasValues(
) → bool -
Checks if the object has values.
inherited
-
isAs<
T extends FhirBase> () → T? -
Returns an Object cast as a Type if it is that type.
inherited
-
isEmpty(
) → bool -
Checks if the object is empty.
inherited
-
listChildrenNames(
) → List< String> -
Lists the JSON keys for the object.
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
prettyPrint(
) → String -
Converts the object to a pretty JSON string.
inherited
-
removeExtension(
String url) → void -
Method to remove an extension by url.
inherited
-
removeModifierExtension(
String url) → void -
Removes modifier extensions by URL
inherited
-
toJson(
) → Map< String, dynamic> -
Converts the object to a JSON representation.
override
-
toJsonString(
) → String -
Converts the object to a JSON string.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toYaml(
) → String -
Converts the object to a YAML string.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited