Goal constructor

const Goal({
  1. @Default(R4ResourceType.Goal) @JsonKey(unknownEnumValue: R4ResourceType.Goal) R4ResourceType resourceType,
  2. @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,
  3. @JsonKey(name: 'id') String? fhirId,
  4. FhirMeta? meta,
  5. FhirUri? implicitRules,
  6. @JsonKey(name: '_implicitRules') Element? implicitRulesElement,
  7. FhirCode? language,
  8. @JsonKey(name: '_language') Element? languageElement,
  9. Narrative? text,
  10. List<Resource>? contained,
  11. @JsonKey(name: 'extension') List<FhirExtension>? extension_,
  12. List<FhirExtension>? modifierExtension,
  13. List<Identifier>? identifier,
  14. FhirCode? lifecycleStatus,
  15. @JsonKey(name: '_lifecycleStatus') Element? lifecycleStatusElement,
  16. CodeableConcept? achievementStatus,
  17. List<CodeableConcept>? category,
  18. CodeableConcept? priority,
  19. required CodeableConcept description,
  20. required Reference subject,
  21. FhirDate? startDate,
  22. @JsonKey(name: '_startDate') Element? startDateElement,
  23. CodeableConcept? startCodeableConcept,
  24. List<GoalTarget>? target,
  25. FhirDate? statusDate,
  26. @JsonKey(name: '_statusDate') Element? statusDateElement,
  27. String? statusReason,
  28. @JsonKey(name: '_statusReason') Element? statusReasonElement,
  29. Reference? expressedBy,
  30. List<Reference>? addresses,
  31. List<Annotation>? note,
  32. List<CodeableConcept>? outcomeCode,
  33. List<Reference>? outcomeReference,
})

Goal Describes the intended objective(s) for a patient, group or organization care, for example, weight loss, restoring an activity of daily living, obtaining herd immunity via immunization, meeting a process improvement objective, etc.

resourceType This is a Goal resource

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

meta 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.

implicitRules 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.

implicitRulesElement Extensions for implicitRules

language The base language in which the resource is written.

languageElement Extensions for language

text 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 These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

extension_ 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 manageable, 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.

modifierExtension 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 manageable, 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).

identifier 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.

lifecycleStatus The state of the goal throughout its lifecycle.

lifecycleStatusElement Extensions for lifecycleStatus

achievementStatus Describes the progression, or lack thereof, towards the goal against the target.

category Indicates a category the goal falls within.

priority Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.

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".

subject Identifies the patient, group or organization for whom the goal is being established.

startDate The date or event after which the goal should begin being pursued.

startDateElement Extensions for startDate

startCodeableConcept The date or event after which the goal should begin being pursued.

target Indicates what should be done by when.

statusDate Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.

statusDateElement Extensions for statusDate

statusReason Captures the reason for the current status.

statusReasonElement Extensions for statusReason

expressedBy Indicates whose goal this is - patient goal, practitioner goal, etc.

addresses The identified conditions and other health record elements that are intended to be addressed by the goal.

note Any comments related to the goal.

outcomeCode Identifies the change (or lack of change) at the point when the status of the goal is assessed.

outcomeReference Details of what's changed (or not changed).

Implementation

const factory Goal({
  @Default(R4ResourceType.Goal)
  @JsonKey(unknownEnumValue: R4ResourceType.Goal)

  /// [resourceType] This is a Goal resource
  R4ResourceType resourceType,
  @JsonKey(includeFromJson: true, includeToJson: false) int? dbId,

  /// [id] The logical id of the resource, as used in the URL for the resource.
  ///  Once assigned, this value never changes.
  @JsonKey(name: 'id') String? fhirId,

  /// [meta] 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.
  FhirMeta? meta,

  /// [implicitRules] 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.
  FhirUri? implicitRules,

  /// [implicitRulesElement] Extensions for implicitRules
  @JsonKey(name: '_implicitRules') Element? implicitRulesElement,

  /// [language] The base language in which the resource is written.
  FhirCode? language,

  /// [languageElement] Extensions for language
  @JsonKey(name: '_language') Element? languageElement,

  /// [text] 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.
  Narrative? text,

  /// [contained] These resources do not have an independent existence apart
  /// from the resource that contains them - they cannot be identified
  /// independently, and nor can they have their own independent transaction
  ///  scope.
  List<Resource>? contained,

  /// [extension_] 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 manageable, 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [modifierExtension] 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
  /// manageable, 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).
  List<FhirExtension>? modifierExtension,

  /// [identifier] 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.
  List<Identifier>? identifier,

  /// [lifecycleStatus] The state of the goal throughout its lifecycle.
  FhirCode? lifecycleStatus,

  /// [lifecycleStatusElement] Extensions for lifecycleStatus
  @JsonKey(name: '_lifecycleStatus') Element? lifecycleStatusElement,

  /// [achievementStatus] Describes the progression, or lack thereof, towards
  ///  the goal against the target.
  CodeableConcept? achievementStatus,

  /// [category] Indicates a category the goal falls within.
  List<CodeableConcept>? category,

  /// [priority] Identifies the mutually agreed level of importance associated
  ///  with reaching/sustaining the goal.
  CodeableConcept? priority,

  /// [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".
  required CodeableConcept description,

  /// [subject] Identifies the patient, group or organization for whom the goal
  ///  is being established.
  required Reference subject,

  /// [startDate] The date or event after which the goal should begin being
  ///  pursued.
  FhirDate? startDate,

  /// [startDateElement] Extensions for startDate
  @JsonKey(name: '_startDate') Element? startDateElement,

  /// [startCodeableConcept] The date or event after which the goal should
  ///  begin being pursued.
  CodeableConcept? startCodeableConcept,

  /// [target] Indicates what should be done by when.
  List<GoalTarget>? target,

  /// [statusDate] Identifies when the current status.  I.e. When initially
  ///  created, when achieved, when cancelled, etc.
  FhirDate? statusDate,

  /// [statusDateElement] Extensions for statusDate
  @JsonKey(name: '_statusDate') Element? statusDateElement,

  /// [statusReason] Captures the reason for the current status.
  String? statusReason,

  /// [statusReasonElement] Extensions for statusReason
  @JsonKey(name: '_statusReason') Element? statusReasonElement,

  /// [expressedBy] Indicates whose goal this is - patient goal, practitioner
  ///  goal, etc.
  Reference? expressedBy,

  /// [addresses] The identified conditions and other health record elements
  ///  that are intended to be addressed by the goal.
  List<Reference>? addresses,

  /// [note] Any comments related to the goal.
  List<Annotation>? note,

  /// [outcomeCode] Identifies the change (or lack of change) at the point when
  ///  the status of the goal is assessed.
  List<CodeableConcept>? outcomeCode,

  /// [outcomeReference] Details of what's changed (or not changed).
  List<Reference>? outcomeReference,
}) = _Goal;