Skip to main content

HS.FHIR.vSTU3.Model.Resource.Goal

deprecated class HS.FHIR.vSTU3.Model.Resource.Goal extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
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.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = Goal;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.

Properties

property addresses as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "addresses", XMLPROJECTION = "ELEMENT");
The identified conditions and other health record elements that are intended to be addressed by the goal.
Property methods: addressesBuildValueArray(), addressesCollectionToDisplay(), addressesCollectionToOdbc(), addressesDisplayToCollection(), addressesGet(), addressesGetObject(), addressesGetObjectId(), addressesGetSwizzled(), addressesIsValid(), addressesOdbcToCollection(), addressesSet(), addressesSetObject(), addressesSetObjectId()
property category as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
Indicates a category the goal falls within.
Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property description as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "description", XMLPROJECTION = "ELEMENT") [ 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.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "expressedBy", XMLPROJECTION = "ELEMENT");
Indicates whose goal this is - patient goal, practitioner goal, etc.
Property methods: expressedByGet(), expressedByGetSwizzled(), expressedByIsValid(), expressedByNewObject(), expressedBySet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
This records identifiers associated with this care plan that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Any comments related to the goal.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property outcomeCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "outcomeCode", XMLPROJECTION = "ELEMENT");
Identifies the change (or lack of change) at the point when the status of the goal is assessed.
Property methods: outcomeCodeBuildValueArray(), outcomeCodeCollectionToDisplay(), outcomeCodeCollectionToOdbc(), outcomeCodeDisplayToCollection(), outcomeCodeGet(), outcomeCodeGetObject(), outcomeCodeGetObjectId(), outcomeCodeGetSwizzled(), outcomeCodeIsValid(), outcomeCodeOdbcToCollection(), outcomeCodeSet(), outcomeCodeSetObject(), outcomeCodeSetObjectId()
property outcomeReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "outcomeReference", XMLPROJECTION = "ELEMENT");
Details of what's changed (or not changed).
Property methods: outcomeReferenceBuildValueArray(), outcomeReferenceCollectionToDisplay(), outcomeReferenceCollectionToOdbc(), outcomeReferenceDisplayToCollection(), outcomeReferenceGet(), outcomeReferenceGetObject(), outcomeReferenceGetObjectId(), outcomeReferenceGetSwizzled(), outcomeReferenceIsValid(), outcomeReferenceOdbcToCollection(), outcomeReferenceSet(), outcomeReferenceSetObject(), outcomeReferenceSetObjectId()
property priority as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
Identifies the mutually agreed level of importance associated with reaching/sustaining the goal.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property startCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "startCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: startCodeableConceptGet(), startCodeableConceptGetSwizzled(), startCodeableConceptIsValid(), startCodeableConceptNewObject(), startCodeableConceptSet()
property startDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "startDate", XMLPROJECTION = "ELEMENT");
Property methods: startDateGet(), startDateGetSwizzled(), startDateIsValid(), startDateNewObject(), startDateSet()
property status as HS.FHIR.vSTU3.Model.Base.GoalStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates whether the goal has been reached and is still considered relevant.
Property methods: statusDateGet(), statusDateGetSwizzled(), statusDateIsValid(), statusDateNewObject(), statusDateSet(), statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusDate as HS.FHIR.vSTU3.Model.Datatype.Date (XMLNAME = "statusDate", XMLPROJECTION = "ELEMENT");
Identifies when the current status. I.e. When initially created, when achieved, when cancelled, etc.
Property methods: statusDateGet(), statusDateGetSwizzled(), statusDateIsValid(), statusDateNewObject(), statusDateSet()
property statusReason as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
Captures the reason for the current status.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Identifies the patient, group or organization for whom the goal is being established.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property target as HS.FHIR.vSTU3.Model.Resource.Goal.Target (XMLNAME = "target", XMLPROJECTION = "ELEMENT");
Indicates what should be done by when.
Property methods: targetGet(), targetGetSwizzled(), targetIsValid(), targetNewObject(), targetSet()

Methods

deprecated method SetAddresses(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "addresses" property.
deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "category" property.
deprecated method SetDescription(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "description" property.
deprecated method SetExpressedBy(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "expressedBy" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetOutcomeCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "outcomeCode" property.
deprecated method SetOutcomeReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "outcomeReference" property.
deprecated method SetPriority(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "priority" property.
deprecated method SetStartCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "startCodeableConcept" property.
deprecated method SetStartDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "startDate" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetStatusDate(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "statusDate" property.
deprecated method SetStatusReason(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "statusReason" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab