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

HS.FHIR.DTL.vR4.Model.Resource.Task

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

A task to be performed.

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 = 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 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 = 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 %String (MAXLEN = 1000000, XMLNAME = "authoredOn", XMLPROJECTION = "ATTRIBUTE");
dateTime

Task Creation Date.

Property methods: authoredOnDisplayToLogical(), authoredOnGet(), authoredOnIsValid(), authoredOnLogicalToDisplay(), authoredOnLogicalToOdbc(), authoredOnNormalize(), authoredOnSet()
property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Request fulfilled by this task.

Any FHIR4 Resource may be indicated by this Reference

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property businessStatus as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "businessStatus", XMLPROJECTION = "ELEMENT");
CodeableConcept

E.g. \"Specimen collected\", \"IV prepped\"

any FHIR4 code from any ValueSet may be used.

Property methods: businessStatusGet(), businessStatusGetSwizzled(), businessStatusIsValid(), businessStatusNewObject(), businessStatusSet()
property code as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "code", XMLPROJECTION = "ELEMENT");
CodeableConcept

Task Type.

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

Property methods: codeGet(), codeGetSwizzled(), codeIsValid(), codeNewObject(), codeSet()
property description as %String (MAXLEN = 1000000, XMLNAME = "description", XMLPROJECTION = "ATTRIBUTE");
string

Human-readable explanation of task.

Property methods: descriptionDisplayToLogical(), descriptionGet(), descriptionIsValid(), descriptionLogicalToDisplay(), descriptionLogicalToOdbc(), descriptionNormalize(), descriptionSet()
property encounter as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Healthcare event during which this task originated.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property executionPeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "executionPeriod", XMLPROJECTION = "ELEMENT");
Period

Start and end time of execution.

Property methods: executionPeriodGet(), executionPeriodGetSwizzled(), executionPeriodIsValid(), executionPeriodNewObject(), executionPeriodSet()
property focus as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "focus", XMLPROJECTION = "ELEMENT");
Reference

What task is acting on.

Any FHIR4 Resource may be indicated by this Reference

Property methods: focusGet(), focusGetSwizzled(), focusIsValid(), focusNewObject(), focusSet()
property for as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "for", XMLPROJECTION = "ELEMENT");
Reference

Beneficiary of the Task.

Any FHIR4 Resource may be indicated by this Reference

Property methods: forGet(), forGetSwizzled(), forIsValid(), forNewObject(), forSet()
property groupIdentifier as HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "groupIdentifier", XMLPROJECTION = "ELEMENT");
Identifier

Requisition or grouper id.

Property methods: groupIdentifierGet(), groupIdentifierGetSwizzled(), groupIdentifierIsValid(), groupIdentifierNewObject(), groupIdentifierSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

Task Instance Identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property input as list of HS.FHIR.DTL.vR4.Model.Element.Task.input (XMLNAME = "input", XMLPROJECTION = "ELEMENT");
BackboneElement

Information used to perform task.

Property methods: inputBuildValueArray(), inputCollectionToDisplay(), inputCollectionToOdbc(), inputDisplayToCollection(), inputGet(), inputGetObject(), inputGetObjectId(), inputGetSwizzled(), inputIsValid(), inputOdbcToCollection(), inputSet(), inputSetObject(), inputSetObjectId()
property instantiatesCanonical as %String (MAXLEN = 1000000, XMLNAME = "instantiatesCanonical", XMLPROJECTION = "ATTRIBUTE");
canonical

Formal definition of task.

TO DO: Unrecognized value type for the FHIR4 model

Property methods: instantiatesCanonicalDisplayToLogical(), instantiatesCanonicalGet(), instantiatesCanonicalIsValid(), instantiatesCanonicalLogicalToDisplay(), instantiatesCanonicalLogicalToOdbc(), instantiatesCanonicalNormalize(), instantiatesCanonicalSet()
property instantiatesUri as %String (MAXLEN = 1000000, XMLNAME = "instantiatesUri", XMLPROJECTION = "ATTRIBUTE");
uri

Formal definition of task.

Property methods: instantiatesUriDisplayToLogical(), instantiatesUriGet(), instantiatesUriIsValid(), instantiatesUriLogicalToDisplay(), instantiatesUriLogicalToOdbc(), instantiatesUriNormalize(), instantiatesUriSet()
property insurance as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "insurance", XMLPROJECTION = "ELEMENT");
Reference

Associated insurance coverage.

Coverage | ClaimResponse

Property methods: insuranceBuildValueArray(), insuranceCollectionToDisplay(), insuranceCollectionToOdbc(), insuranceDisplayToCollection(), insuranceGet(), insuranceGetObject(), insuranceGetObjectId(), insuranceGetSwizzled(), insuranceIsValid(), insuranceOdbcToCollection(), insuranceSet(), insuranceSetObject(), insuranceSetObjectId()
property intent as %String (MAXLEN = 1000000, XMLNAME = "intent", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option

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

Property methods: intentDisplayToLogical(), intentGet(), intentIsValid(), intentLogicalToDisplay(), intentLogicalToOdbc(), intentNormalize(), intentSet()
property lastModified as %String (MAXLEN = 1000000, XMLNAME = "lastModified", XMLPROJECTION = "ATTRIBUTE");
dateTime

Task Last Modified Date.

Property methods: lastModifiedDisplayToLogical(), lastModifiedGet(), lastModifiedIsValid(), lastModifiedLogicalToDisplay(), lastModifiedLogicalToOdbc(), lastModifiedNormalize(), lastModifiedSet()
property location as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "location", XMLPROJECTION = "ELEMENT");
Reference

Where task occurs.

Location

Property methods: locationGet(), locationGetSwizzled(), locationIsValid(), locationNewObject(), locationSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Comments made about the task.

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

Information produced as part of task.

Property methods: outputBuildValueArray(), outputCollectionToDisplay(), outputCollectionToOdbc(), outputDisplayToCollection(), outputGet(), outputGetObject(), outputGetObjectId(), outputGetSwizzled(), outputIsValid(), outputOdbcToCollection(), outputSet(), outputSetObject(), outputSetObjectId()
property owner as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "owner", XMLPROJECTION = "ELEMENT");
Reference

Responsible individual.

Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson

Property methods: ownerGet(), ownerGetSwizzled(), ownerIsValid(), ownerNewObject(), ownerSet()
property partOf as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Composite task.

Task

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performerType as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "performerType", XMLPROJECTION = "ELEMENT");
CodeableConcept

Requested performer.

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

Property methods: performerTypeBuildValueArray(), performerTypeCollectionToDisplay(), performerTypeCollectionToOdbc(), performerTypeDisplayToCollection(), performerTypeGet(), performerTypeGetObject(), performerTypeGetObjectId(), performerTypeGetSwizzled(), performerTypeIsValid(), performerTypeOdbcToCollection(), performerTypeSet(), performerTypeSetObject(), performerTypeSetObjectId()
property priority as %String (MAXLEN = 1000000, XMLNAME = "priority", XMLPROJECTION = "ATTRIBUTE");
code

routine | urgent | asap | stat

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

Property methods: priorityDisplayToLogical(), priorityGet(), priorityIsValid(), priorityLogicalToDisplay(), priorityLogicalToOdbc(), priorityNormalize(), prioritySet()
property reasonCode as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Why task is needed.

any FHIR4 code from any ValueSet may be used.

Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Why task is needed.

Any FHIR4 Resource may be indicated by this Reference

Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property relevantHistory as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "relevantHistory", XMLPROJECTION = "ELEMENT");
Reference

Key events in history of the Task.

Provenance

Property methods: relevantHistoryBuildValueArray(), relevantHistoryCollectionToDisplay(), relevantHistoryCollectionToOdbc(), relevantHistoryDisplayToCollection(), relevantHistoryGet(), relevantHistoryGetObject(), relevantHistoryGetObjectId(), relevantHistoryGetSwizzled(), relevantHistoryIsValid(), relevantHistoryOdbcToCollection(), relevantHistorySet(), relevantHistorySetObject(), relevantHistorySetObjectId()
property requester as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "requester", XMLPROJECTION = "ELEMENT");
Reference

Who is asking for task to be done.

Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson

Property methods: requesterGet(), requesterGetSwizzled(), requesterIsValid(), requesterNewObject(), requesterSet()
property restriction as HS.FHIR.DTL.vR4.Model.Element.Task.restriction (XMLNAME = "restriction", XMLPROJECTION = "ELEMENT");
BackboneElement

Constraints on fulfillment tasks.

Property methods: restrictionGet(), restrictionGetSwizzled(), restrictionIsValid(), restrictionNewObject(), restrictionSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

draft | requested | received | accepted | +

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

any FHIR4 code from any ValueSet may be used.

Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab