Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.Goal

class HS.FHIR.DTL.vDSTU2.Model.Resource.Goal extends HS.FHIR.DTL.vDSTU2.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 addresses as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "addresses", XMLPROJECTION = "ELEMENT");
Reference

Issues addressed by this goal.

Condition | Observation | MedicationStatement | NutritionOrder | ProcedureRequest | RiskAssessment

Property methods: addressesBuildValueArray(), addressesCollectionToDisplay(), addressesCollectionToOdbc(), addressesDisplayToCollection(), addressesGet(), addressesGetObject(), addressesGetObjectId(), addressesGetSwizzled(), addressesIsValid(), addressesOdbcToCollection(), addressesSet(), addressesSetObject(), addressesSetObjectId()
property author as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "author", XMLPROJECTION = "ELEMENT");
Reference

Who's responsible for creating Goal?

Patient | Practitioner | RelatedPerson

Property methods: authorGet(), authorGetSwizzled(), authorIsValid(), authorNewObject(), authorSet()
property category as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

any FHIR2 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 %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE") [ Required ];
string

What's the desired outcome?

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.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 note as list of HS.FHIR.DTL.vDSTU2.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 outcome as list of HS.FHIR.DTL.vDSTU2.Model.Element.Goal.outcome (XMLNAME = "outcome", XMLPROJECTION = "ELEMENT");
BackboneElement

What was end result of goal?

Property methods: outcomeBuildValueArray(), outcomeCollectionToDisplay(), outcomeCollectionToOdbc(), outcomeDisplayToCollection(), outcomeGet(), outcomeGetObject(), outcomeGetObjectId(), outcomeGetSwizzled(), outcomeIsValid(), outcomeOdbcToCollection(), outcomeSet(), outcomeSetObject(), outcomeSetObjectId()
property priority as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
CodeableConcept

high | medium |low

goal-priority is the PREFERRED FHIR2 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.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "startCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

When goal pursuit begins.

any FHIR2 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 status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

proposed | planned | accepted | rejected | in-progress | achieved | sustaining | on-hold | cancelled

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

Property methods: statusDateDisplayToLogical(), statusDateGet(), statusDateIsValid(), statusDateLogicalToDisplay(), statusDateLogicalToOdbc(), statusDateNormalize(), statusDateSet(), statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
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 HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

any FHIR2 code may be used; goal-status-reason shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT");
Reference

Who this goal is intended for.

Patient | Group | Organization

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property targetDate as %String (MAXLEN = 1000000, XMLNAME = "targetDate", XMLPROJECTION = "ATTRIBUTE");
date

Reach goal on or before.

Property methods: targetDateDisplayToLogical(), targetDateGet(), targetDateIsValid(), targetDateLogicalToDisplay(), targetDateLogicalToOdbc(), targetDateNormalize(), targetDateSet()
property targetQuantity as HS.FHIR.DTL.vDSTU2.Model.Datatype.Quantity (XMLNAME = "targetQuantity", XMLPROJECTION = "ELEMENT");
Quantity

Reach goal on or before.

Property methods: targetQuantityGet(), targetQuantityGetSwizzled(), targetQuantityIsValid(), targetQuantityNewObject(), targetQuantitySet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab