Skip to main content

HS.FHIRModel.R4.Task

class HS.FHIRModel.R4.Task extends HS.FHIRModel.FHIRClassSuper

*****************************************
** Task generated class schema
*****************************************
A task to be performed.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_TASK;
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 _authoredOn as HS.FHIRModel.R4.Element;
Extensions for authoredOn
Property methods: _authoredOnGet(), _authoredOnGetSwizzled(), _authoredOnIsValid(), _authoredOnNewObject(), _authoredOnSet()
property _description as HS.FHIRModel.R4.Element;
Extensions for description
Property methods: _descriptionGet(), _descriptionGetSwizzled(), _descriptionIsValid(), _descriptionNewObject(), _descriptionSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiatesUri as HS.FHIRModel.R4.Element;
Extensions for instantiatesUri
Property methods: _instantiatesUriGet(), _instantiatesUriGetSwizzled(), _instantiatesUriIsValid(), _instantiatesUriNewObject(), _instantiatesUriSet()
property _intent as HS.FHIRModel.R4.Element;
Extensions for intent
Property methods: _intentGet(), _intentGetSwizzled(), _intentIsValid(), _intentNewObject(), _intentSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _lastModified as HS.FHIRModel.R4.Element;
Extensions for lastModified
Property methods: _lastModifiedGet(), _lastModifiedGetSwizzled(), _lastModifiedIsValid(), _lastModifiedNewObject(), _lastModifiedSet()
property _priority as HS.FHIRModel.R4.Element;
Extensions for priority
Property methods: _priorityGet(), _priorityGetSwizzled(), _priorityIsValid(), _priorityNewObject(), _prioritySet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property authoredOn as %String;
The date and time this task was created.
Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as HS.FHIRModel.R4.SeqOfReference;
BasedOn refers to a higher-level authorization that triggered the creation of the task. It references a "request" resource such as a ServiceRequest, MedicationRequest, ServiceRequest, CarePlan, etc. which is distinct from the "request" resource the task is seeking to fulfill. This latter resource is referenced by FocusOn. For example, based on a ServiceRequest (= BasedOn), a task is created to fulfill a procedureRequest ( = FocusOn ) to collect a specimen from a patient.
Property methods: basedOnGet(), basedOnGetSwizzled(), basedOnIsValid(), basedOnNewObject(), basedOnSet()
property businessStatus as HS.FHIRModel.R4.CodeableConcept;
Contains business-specific nuances of the business state.
Property methods: businessStatusGet(), businessStatusGetSwizzled(), businessStatusIsValid(), businessStatusNewObject(), businessStatusSet()
A name or code (or both) briefly describing what the task involves.
Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property description as %String;
A free-text description of what is to be performed.
Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property encounter as HS.FHIRModel.R4.Reference;
The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property executionPeriod as HS.FHIRModel.R4.Period;
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 extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property focus as HS.FHIRModel.R4.Reference;
The request being actioned or the resource being manipulated by this task.
Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property for as HS.FHIRModel.R4.Reference;
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.FHIRModel.R4.Identifier;
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 HS.FHIRModel.R4.SeqOfIdentifier;
The business identifier for this task.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
Additional information that may be needed in the execution of the task.
Property methods: inputGet(), inputGetSwizzled(), inputIsValid(), inputNewObject(), inputSet()
property instantiatesCanonical as %String;
The URL pointing to a *FHIR*-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Property methods: instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalSet()
property instantiatesUri as %String;
The URL pointing to an *externally* maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Task.
Property methods: instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriSet()
property insurance as HS.FHIRModel.R4.SeqOfReference;
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task.
Property methods: insuranceGet(), insuranceGetSwizzled(), insuranceIsValid(), insuranceNewObject(), insuranceSet()
property intent as %String (VALUELIST = ",unknown,proposal,plan,order,original-order,reflex-order,filler-order,instance-order,option");
Indicates the "level" of actionability associated with the Task, i.e. i+R[9]Cs this a proposed task, a planned task, an actionable task, etc.
Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property lastModified as %String;
The date and time of last modification to this task.
Property methods: lastModifiedDisplayToLogical(), lastModifiedGet(), lastModifiedIsValid(), lastModifiedLogicalToDisplay(), lastModifiedLogicalToOdbc(), lastModifiedNormalize(), lastModifiedSet()
property location as HS.FHIRModel.R4.Reference;
Principal physical location where the this task is performed.
Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Free-text information captured about the task as it progresses.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
Outputs produced by the Task.
Property methods: outputGet(), outputGetSwizzled(), outputIsValid(), outputNewObject(), outputSet()
property owner as HS.FHIRModel.R4.Reference;
Individual organization or Device currently responsible for task execution.
Property methods: ownerGet(), ownerGetSwizzled(), ownerIsValid(), ownerNewObject(), ownerSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
Task that this particular task is part of.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
property performerType as HS.FHIRModel.R4.SeqOfCodeableConcept;
The kind of participant that should perform the task.
Property methods: performerTypeGet(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeNewObject(), performerTypeSet()
property priority as %String;
Indicates how quickly the Task should be addressed with respect to other requests.
Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as HS.FHIRModel.R4.CodeableConcept;
A description or code indicating why this task needs to be performed.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.Reference;
A resource reference indicating why this task needs to be performed.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property relevantHistory as HS.FHIRModel.R4.SeqOfReference;
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: relevantHistoryGet(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryNewObject(), relevantHistorySet()
property requester as HS.FHIRModel.R4.Reference;
The creator of the task.
Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property resourceType as %String [ InitialExpression = "Task" , Required ];
This is a Task resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property restriction as HS.FHIRModel.R4.TaskX.Restriction;
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 %String (VALUELIST = ",draft,requested,received,accepted,rejected,ready,cancelled,in-progress,on-hold,failed,completed,entered-in-error");
The current status of the task.
Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.CodeableConcept;
An explanation as to why this task is held, failed, was refused, etc.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeBasedOn()
method IncludeBusinessStatus()
method IncludeCode()
method IncludeContained()
method IncludeEncounter()
method IncludeExecutionPeriod()
method IncludeExtension()
method IncludeFocus()
method IncludeFor()
method IncludeGroupIdentifier()
method IncludeIdentifier()
method IncludeInput()
method IncludeInsurance()
method IncludeLocation()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludeOutput()
method IncludeOwner()
method IncludePartOf()
method IncludePerformerType()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRelevantHistory()
method IncludeRequester()
method IncludeRestriction()
method IncludeStatusReason()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
classmethod fromDao(dao As %Library.DynamicAbstractObject) as HS.FHIRModel.R4.Task
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab