Skip to main content

HS.FHIRModel.R4.Goal

class HS.FHIRModel.R4.Goal extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Goal generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_GOAL;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type.

The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lifecycleStatus as HS.FHIRModel.R4.Element;
Extensions for lifecycleStatus
Property methods: _lifecycleStatusGet(), _lifecycleStatusGetSwizzled(), _lifecycleStatusIsValid(), _lifecycleStatusNewObject(), _lifecycleStatusSet()
property _startDate as HS.FHIRModel.R4.Element;
Extensions for startDate
Property methods: _startDateGet(), _startDateGetSwizzled(), _startDateIsValid(), _startDateNewObject(), _startDateSet()
property _statusDate as HS.FHIRModel.R4.Element;
Extensions for statusDate
Property methods: _statusDateGet(), _statusDateGetSwizzled(), _statusDateIsValid(), _statusDateNewObject(), _statusDateSet()
property _statusReason as HS.FHIRModel.R4.Element;
Extensions for statusReason
Property methods: _statusReasonGet(), _statusReasonGetSwizzled(), _statusReasonIsValid(), _statusReasonNewObject(), _statusReasonSet()
property achievementStatus as HS.FHIRModel.R4.CodeableConcept;
Describes the progression, or lack thereof, towards the goal against the target.
Property methods: achievementStatusGet(), achievementStatusGetSwizzled(), achievementStatusIsValid(), achievementStatusNewObject(), achievementStatusSet()
property addresses as HS.FHIRModel.R4.SeqOfReference;
The identified conditions and other health record elements that are intended to be addressed by the goal.
Property methods: addressesGet(), addressesGetSwizzled(), addressesIsValid(), addressesNewObject(), addressesSet()
property category as HS.FHIRModel.R4.SeqOfCodeableConcept;
Indicates a category the goal falls within.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
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.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property description as HS.FHIRModel.R4.CodeableConcept [ Required ];
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".
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property expressedBy as HS.FHIRModel.R4.Reference;
Indicates whose goal this is - patient goal, practitioner goal, etc.
Property methods: expressedByGet(), expressedByGetSwizzled(), expressedByIsValid(), expressedByNewObject(), expressedBySet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
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.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
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.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
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.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property lifecycleStatus as %String (VALUELIST = ",proposed,planned,accepted,active,on-hold,completed,cancelled,entered-in-error,rejected");
The state of the goal throughout its lifecycle.
Property methods: lifecycleStatusDisplayToLogical(), lifecycleStatusGet(), lifecycleStatusIsValid(), lifecycleStatusLogicalToDisplay(), lifecycleStatusLogicalToOdbc(), lifecycleStatusNormalize(), lifecycleStatusSet()
property meta as HS.FHIRModel.R4.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.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
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).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Any comments related to the goal.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property outcomeCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
Property methods: outcomeCodeGet(), outcomeCodeGetSwizzled(), outcomeCodeIsValid(), outcomeCodeNewObject(), outcomeCodeSet()
property outcomeReference as HS.FHIRModel.R4.SeqOfReference;
Details of what's changed (or not changed).
Property methods: outcomeReferenceGet(), outcomeReferenceGetSwizzled(), outcomeReferenceIsValid(), outcomeReferenceNewObject(), outcomeReferenceSet()
property priority as HS.FHIRModel.R4.CodeableConcept;
Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property resourceType as %String [ InitialExpression = "Goal" , Required ];
This is a Goal resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property startCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
The date or event after which the goal should begin being pursued.
Property methods: startCodeableConceptGet(), startCodeableConceptGetSwizzled(), startCodeableConceptIsValid(), startCodeableConceptNewObject(), startCodeableConceptSet()
property startDate as %String;
The date or event after which the goal should begin being pursued.
Property methods: startDateDisplayToLogical(), startDateGet(), startDateIsValid(), startDateLogicalToDisplay(), startDateLogicalToOdbc(), startDateNormalize(), startDateSet()
property statusDate as %String;
Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
Property methods: statusDateDisplayToLogical(), statusDateGet(), statusDateIsValid(), statusDateLogicalToDisplay(), statusDateLogicalToOdbc(), statusDateNormalize(), statusDateSet()
property statusReason as %String;
Captures the reason for the current status.
Property methods: statusReasonDisplayToLogical(), statusReasonGet(), statusReasonIsValid(), statusReasonLogicalToDisplay(), statusReasonLogicalToOdbc(), statusReasonNormalize(), statusReasonSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
Identifies the patient, group or organization for whom the goal is being established.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
Indicates what should be done by when.
Property methods: targetGet(), targetGetSwizzled(), targetIsValid(), targetNewObject(), targetSet()
property text as HS.FHIRModel.R4.Narrative;
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.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeAchievementStatus()
method IncludeAddresses()
method IncludeCategory()
method IncludeContained()
method IncludeDescription()
method IncludeExpressedBy()
method IncludeExtension()
method IncludeIdentifier()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOutcomeCode()
method IncludeOutcomeReference()
method IncludePriority()
method IncludeStartCodeableConcept()
method IncludeSubject()
method IncludeTarget()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Goal
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab