Skip to main content

HS.FHIR.DTL.vSTU3.Model.Element.PlanDefinition.goal

class HS.FHIR.DTL.vSTU3.Model.Element.PlanDefinition.goal extends HS.FHIR.DTL.vSTU3.Model.Base.BackboneElement

What the plan is trying to accomplish.

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 = PlanDefinition.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 = PlanDefinition.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.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "addresses", XMLPROJECTION = "ELEMENT");
CodeableConcept

What does the goal address.

any FHIR3 code may be used; condition-code shows EXAMPLE codes, but you may use codes from any ValueSet.

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

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

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

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property description as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "description", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

Code or text describing the goal.

any FHIR3 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 documentation as list of HS.FHIR.DTL.vSTU3.Model.Datatype.RelatedArtifact (XMLNAME = "documentation", XMLPROJECTION = "ELEMENT");
RelatedArtifact

Supporting documentation for the goal.

Property methods: documentationBuildValueArray(), documentationCollectionToDisplay(), documentationCollectionToOdbc(), documentationDisplayToCollection(), documentationGet(), documentationGetObject(), documentationGetObjectId(), documentationGetSwizzled(), documentationIsValid(), documentationOdbcToCollection(), documentationSet(), documentationSetObject(), documentationSetObjectId()
property priority as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
CodeableConcept

high-priority | medium-priority | low-priority

goal-priority is the PREFERRED FHIR3 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 start as HS.FHIR.DTL.vSTU3.Model.Datatype.CodeableConcept (XMLNAME = "start", XMLPROJECTION = "ELEMENT");
CodeableConcept

When goal pursuit begins.

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

Property methods: startGet(), startGetSwizzled(), startIsValid(), startNewObject(), startSet()
property target as list of HS.FHIR.DTL.vSTU3.Model.Element.PlanDefinition.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