Skip to main content
AskMe (beta)
Loading icon
Responses may be inaccurate. Learn more about AskMe.

HS.FHIR.DTL.vR4.Model.Resource.Goal

class HS.FHIR.DTL.vR4.Model.Resource.Goal extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Describes the intended objective(s) for a patient, group or organization.

Property 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 XMLPROJECTION = ELEMENT;
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.
parameter XMLTYPE = 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 achievementStatus as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "achievementStatus", XMLPROJECTION = "ELEMENT");
CodeableConcept

in-progress | improving | worsening | no-change | achieved | sustaining | not-achieved | no-progress | not-attainable

goal-achievement is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in goal-achievement, you may use codes from any ValueSet.

Property methods: achievementStatusGet(), achievementStatusGetSwizzled(), achievementStatusIsValid(), achievementStatusNewObject(), achievementStatusSet()
property addresses as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "addresses", XMLPROJECTION = "ELEMENT");
Reference

Issues addressed by this goal.

Condition | Observation | MedicationStatement | NutritionOrder | ServiceRequest | RiskAssessment

Property methods: addressesBuildValueArray(), addressesCollectionToDisplay(), addressesCollectionToOdbc(), addressesDisplayToCollection(), addressesGet(), addressesGetObject(), addressesGetObjectId(), addressesGetSwizzled(), addressesIsValid(), addressesOdbcToCollection(), addressesSet(), addressesSetObject(), addressesSetObjectId()
property category as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

E.g. Treatment, dietary, behavioral, etc.

any FHIR4 code may be used; goal-category shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: categoryBuildValueArray(), categoryCollectionToDisplay(), categoryCollectionToOdbc(), categoryDisplayToCollection(), categoryGet(), categoryGetObject(), categoryGetObjectId(), categoryGetSwizzled(), categoryIsValid(), categoryOdbcToCollection(), categorySet(), categorySetObject(), categorySetObjectId()
property description as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "description", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Code or text describing goal.

any FHIR4 code may be used; clinical-findings shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property expressedBy as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "expressedBy", XMLPROJECTION = "ELEMENT");
Reference

Who's responsible for creating Goal?

Patient | Practitioner | PractitionerRole | RelatedPerson

Property methods: expressedByGet(), expressedByGetSwizzled(), expressedByIsValid(), expressedByNewObject(), expressedBySet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External Ids for this goal.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property lifecycleStatus as %String (MAXLEN = 1000000, XMLNAME = "lifecycleStatus", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposed | planned | accepted | active | on-hold | completed | cancelled | entered-in-error | rejected

goal-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend goal-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: lifecycleStatusDisplayToLogical(), lifecycleStatusGet(), lifecycleStatusIsValid(), lifecycleStatusLogicalToDisplay(), lifecycleStatusLogicalToOdbc(), lifecycleStatusNormalize(), lifecycleStatusSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments about the goal.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property outcomeCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "outcomeCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

What result was achieved regarding the goal?

any FHIR4 code may be used; clinical-findings shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: outcomeCodeBuildValueArray(), outcomeCodeCollectionToDisplay(), outcomeCodeCollectionToOdbc(), outcomeCodeDisplayToCollection(), outcomeCodeGet(), outcomeCodeGetObject(), outcomeCodeGetObjectId(), outcomeCodeGetSwizzled(), outcomeCodeIsValid(), outcomeCodeOdbcToCollection(), outcomeCodeSet(), outcomeCodeSetObject(), outcomeCodeSetObjectId()
property outcomeReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "outcomeReference", XMLPROJECTION = "ELEMENT");
Reference

Observation that resulted from goal.

Observation

Property methods: outcomeReferenceBuildValueArray(), outcomeReferenceCollectionToDisplay(), outcomeReferenceCollectionToOdbc(), outcomeReferenceDisplayToCollection(), outcomeReferenceGet(), outcomeReferenceGetObject(), outcomeReferenceGetObjectId(), outcomeReferenceGetSwizzled(), outcomeReferenceIsValid(), outcomeReferenceOdbcToCollection(), outcomeReferenceSet(), outcomeReferenceSetObject(), outcomeReferenceSetObjectId()
property priority as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
CodeableConcept

high-priority | medium-priority | low-priority

goal-priority is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in goal-priority, you may use codes from any ValueSet.

Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property startCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "startCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

When goal pursuit begins.

any FHIR4 code may be used; goal-start-event shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: startCodeableConceptGet(), startCodeableConceptGetSwizzled(), startCodeableConceptIsValid(), startCodeableConceptNewObject(), startCodeableConceptSet()
property startDate as %String (MAXLEN = 1000000, XMLNAME = "startDate", XMLPROJECTION = "ATTRIBUTE");
date

When goal pursuit begins.

Property methods: startDateDisplayToLogical(), startDateGet(), startDateIsValid(), startDateLogicalToDisplay(), startDateLogicalToOdbc(), startDateNormalize(), startDateSet()
property statusDate as %String (MAXLEN = 1000000, XMLNAME = "statusDate", XMLPROJECTION = "ATTRIBUTE");
date

When goal status took effect.

Property methods: statusDateDisplayToLogical(), statusDateGet(), statusDateIsValid(), statusDateLogicalToDisplay(), statusDateLogicalToOdbc(), statusDateNormalize(), statusDateSet()
property statusReason as %String (MAXLEN = 1000000, XMLNAME = "statusReason", XMLPROJECTION = "ATTRIBUTE");
string

Reason for current status.

Property methods: statusReasonDisplayToLogical(), statusReasonGet(), statusReasonIsValid(), statusReasonLogicalToDisplay(), statusReasonLogicalToOdbc(), statusReasonNormalize(), statusReasonSet()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who this goal is intended for.

Patient | Group | Organization

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property target as list of HS.FHIR.DTL.vR4.Model.Element.Goal.target (XMLNAME = "target", XMLPROJECTION = "ELEMENT");
BackboneElement

Target outcome for the goal.

Property methods: targetBuildValueArray(), targetCollectionToDisplay(), targetCollectionToOdbc(), targetDisplayToCollection(), targetGet(), targetGetObject(), targetGetObjectId(), targetGetSwizzled(), targetIsValid(), targetOdbcToCollection(), targetSet(), targetSetObject(), targetSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab