Skip to main content

HS.FHIR.vSTU3.Model.Resource.Task

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
A task to be performed.
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 = Task;
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 authoredOn as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "authoredOn", XMLPROJECTION = "ELEMENT");
The date and time this task was created.
Property methods: authoredOnGet(), authoredOnGetSwizzled(), authoredOnIsValid(), authoredOnNewObject(), authoredOnSet()
property basedOn as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ProcedureRequest, MedicationRequest, ProcedureRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfil. This latter resource is referenced by FocusOn. For example, based on a ProcedureRequest (= BasedOn), a task is created to fulfil a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property businessStatus as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "businessStatus", XMLPROJECTION = "ELEMENT");
Contains business-specific nuances of the business state.
Property methods: businessStatusGet(), businessStatusGetSwizzled(), businessStatusIsValid(), businessStatusNewObject(), businessStatusSet()
property code as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
A name or code (or both) briefly describing what the task involves.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definitionReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definitionReference", XMLPROJECTION = "ELEMENT");
Property methods: definitionReferenceGet(), definitionReferenceGetSwizzled(), definitionReferenceIsValid(), definitionReferenceNewObject(), definitionReferenceSet()
property definitionUri as HS.FHIR.vSTU3.Model.Datatype.Uri (XMLNAME = "definitionUri", XMLPROJECTION = "ELEMENT");
Property methods: definitionUriGet(), definitionUriGetSwizzled(), definitionUriIsValid(), definitionUriNewObject(), definitionUriSet()
property description as HS.FHIR.vSTU3.Model.Datatype.String (XMLNAME = "description", XMLPROJECTION = "ELEMENT");
A free-text description of what is to be performed.
Property methods: descriptionGet(), descriptionGetSwizzled(), descriptionIsValid(), descriptionNewObject(), descriptionSet()
property executionPeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "executionPeriod", XMLPROJECTION = "ELEMENT");
Identifies the time action was first taken against the task (start) and/or the time final action was taken against the task prior to marking it as completed (end).
Property methods: executionPeriodGet(), executionPeriodGetSwizzled(), executionPeriodIsValid(), executionPeriodNewObject(), executionPeriodSet()
property focus as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");
The request being actioned or the resource being manipulated by this task.
Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property for as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "for", XMLPROJECTION = "ELEMENT");
The entity who benefits from the performance of the service specified in the task (e.g., the patient).
Property methods: forGet(), forGetSwizzled(), forIsValid(), forNewObject(), forSet()
property groupIdentifier as HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");
An identifier that links together multiple tasks and other requests that were created in the same context.
Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
The business identifier for this task.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property input as list of HS.FHIR.vSTU3.Model.Resource.Task.Input (XMLNAME = "input", XMLPROJECTION = "ELEMENT");
Additional information that may be needed in the execution of the task.
Property methods: inputBuildValueArray(), inputCollectionToDisplay(), inputCollectionToOdbc(), inputDisplayToCollection(), inputGet(), inputGetObject(), inputGetObjectId(), inputGetSwizzled(), inputIsValid(), inputOdbcToCollection(), inputSet(), inputSetObject(), inputSetObjectId()
property intent as HS.FHIR.vSTU3.Model.Base.RequestIntent (XMLNAME = "intent", XMLPROJECTION = "ELEMENT") [ Required ];
Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc.
Property methods: intentGet(), intentGetSwizzled(), intentIsValid(), intentNewObject(), intentSet()
property lastModified as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "lastModified", XMLPROJECTION = "ELEMENT");
The date and time of last modification to this task.
Property methods: lastModifiedGet(), lastModifiedGetSwizzled(), lastModifiedIsValid(), lastModifiedNewObject(), lastModifiedSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Free-text information captured about the task as it progresses.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property output as list of HS.FHIR.vSTU3.Model.Resource.Task.Output (XMLNAME = "output", XMLPROJECTION = "ELEMENT");
Outputs produced by the Task.
Property methods: outputBuildValueArray(), outputCollectionToDisplay(), outputCollectionToOdbc(), outputDisplayToCollection(), outputGet(), outputGetObject(), outputGetObjectId(), outputGetSwizzled(), outputIsValid(), outputOdbcToCollection(), outputSet(), outputSetObject(), outputSetObjectId()
property owner as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "owner", XMLPROJECTION = "ELEMENT");
Individual organization or Device currently responsible for task execution.
Property methods: ownerGet(), ownerGetSwizzled(), ownerIsValid(), ownerNewObject(), ownerSet()
property partOf as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Task that this particular task is part of.
Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performerType as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
The type of participant that can execute the task.
Property methods: performerTypeBuildValueArray(), performerTypeCollectionToDisplay(), performerTypeCollectionToOdbc(), performerTypeDisplayToCollection(), performerTypeGet(), performerTypeGetObject(), performerTypeGetObjectId(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeOdbcToCollection(), performerTypeSet(), performerTypeSetObject(), performerTypeSetObjectId()
property priority as HS.FHIR.vSTU3.Model.Base.RequestPriority (XMLNAME = "priority", XMLPROJECTION = "ELEMENT");
Indicates how quickly the Task should be addressed with respect to other requests.
Property methods: priorityGet(), priorityGetSwizzled(), priorityIsValid(), priorityNewObject(), prioritySet()
property reason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reason", XMLPROJECTION = "ELEMENT");
A description or code indicating why this task needs to be performed.
Property methods: reasonGet(), reasonGetSwizzled(), reasonIsValid(), reasonNewObject(), reasonSet()
property relevantHistory as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "relevantHistory", XMLPROJECTION = "ELEMENT");
Links to Provenance records for past versions of this Task that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the task.
Property methods: relevantHistoryBuildValueArray(), relevantHistoryCollectionToDisplay(), relevantHistoryCollectionToOdbc(), relevantHistoryDisplayToCollection(), relevantHistoryGet(), relevantHistoryGetObject(), relevantHistoryGetObjectId(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryOdbcToCollection(), relevantHistorySet(), relevantHistorySetObject(), relevantHistorySetObjectId()
property requester as HS.FHIR.vSTU3.Model.Resource.Task.Requester (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
The creator of the task.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property restriction as HS.FHIR.vSTU3.Model.Resource.Task.Restriction (XMLNAME = "restriction", XMLPROJECTION = "ELEMENT");
If the Task.focus is a request resource and the task is seeking fulfillment (i.e is asking for the request to be actioned), this element identifies any limitations on what parts of the referenced request should be actioned.
Property methods: restrictionGet(), restrictionGetSwizzled(), restrictionIsValid(), restrictionNewObject(), restrictionSet()
property status as HS.FHIR.vSTU3.Model.Base.TaskStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
The current status of the task.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet(), statusSet()
property statusReason as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
An explanation as to why this task is held, failed, was refused, etc.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()

Methods

deprecated method SetAuthoredOn(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 "authoredOn" property.
deprecated method SetBasedOn(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 "basedOn" property.
deprecated method SetBusinessStatus(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 "businessStatus" property.
deprecated method SetCode(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 "code" property.
deprecated method SetContext(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 "context" property.
deprecated method SetDefinitionReference(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 "definitionReference" property.
deprecated method SetDefinitionUri(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 "definitionUri" property.
deprecated method SetDescription(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 "description" property.
deprecated method SetExecutionPeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "executionPeriod" property.
deprecated method SetFocus(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 "focus" property.
deprecated method SetFor(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 "for" property.
deprecated method SetGroupIdentifier(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.
Set method for the "groupIdentifier" 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 SetIntent(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 "intent" property.
deprecated method SetLastModified(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 "lastModified" property.
deprecated method SetOwner(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 "owner" property.
deprecated method SetPartOf(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 "partOf" property.
deprecated method SetPerformerType(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 "performerType" property.
deprecated method SetPriority(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 "priority" property.
deprecated method SetReason(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 "reason" property.
deprecated method SetRelevantHistory(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 "relevantHistory" 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 SetStatusReason(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 "statusReason" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab