Private OptionalidentifierTask.identifier Element
Private OptionalinstantiatesTask.instantiatesCanonical Element
FHIR Specification
canonical
Private OptionalinstantiatesTask.instantiatesUri Element
FHIR Specification
uriPrivate OptionalbasedTask.basedOn Element
FHIR Specification
focus, never basedOn. However, authorization may be needed to perform other types of Task actions. As an example of when both would be present, a Task seeking suspension of a prescription might have a Task.basedOn pointing to the ServiceRequest ordering surgery (which is the driver for suspending the MedicationRequest - which would be the Task.focus).Reference
Private OptionalgroupTask.groupIdentifier Element
FHIR Specification
IdentifierPrivate OptionalpartTask.partOf Element
FHIR Specification
Reference
Private ReadonlytaskFHIR CodeSystem: TaskStatus
PrivatestatusTask.status Element
FHIR Specification
codeCodeSystem Enumeration: TaskStatusEnum
Private OptionalstatusTask.statusReason Element
FHIR Specification
CodeableReferencePrivate OptionalbusinessTask.businessStatus Element
FHIR Specification
CodeableConceptPrivateintentTask.intent Element
FHIR Specification
codePrivate ReadonlyrequestFHIR CodeSystem: RequestPriority
Private OptionalpriorityTask.priority Element
FHIR Specification
codeCodeSystem Enumeration: RequestPriorityEnum
Private OptionaldoTask.doNotPerform Element
FHIR Specification
booleanPrivate OptionalcodeTask.code Element
Private OptionaldescriptionTask.description Element
Private OptionalfocusTask.focus Element
FHIR Specification
Reference
Private Optionalfor_Task.for Element
FHIR Specification
Reference
Private OptionalencounterTask.encounter Element
FHIR Specification
Reference
Private OptionalrequestedTask.requestedPeriod Element
FHIR Specification
PeriodPrivate OptionalexecutionTask.executionPeriod Element
FHIR Specification
PeriodPrivate OptionalauthoredTask.authoredOn Element
Private OptionallastTask.lastModified Element
FHIR Specification
dateTimePrivate OptionalrequesterTask.requester Element
FHIR Specification
Reference
Private OptionalrequestedTask.requestedPerformer Element
FHIR Specification
CodeableReference
Private OptionalownerTask.owner Element
FHIR Specification
Reference
Private OptionalperformerTask.performer Element
Private OptionallocationTask.location Element
FHIR Specification
Reference
Private OptionalreasonTask.reason Element
FHIR Specification
CodeableReferencePrivate OptionalinsuranceTask.insurance Element
FHIR Specification
Reference
Private OptionalnoteTask.note Element
Private OptionalrelevantTask.relevantHistory Element
FHIR Specification
Reference
Private OptionalrestrictionTask.restriction Element
FHIR Specification
BackboneElementPrivate OptionalinputTask.input Element
FHIR Specification
BackboneElementPrivate OptionaloutputTask.output Element
FHIR Specification
BackboneElementStaticparseParse the provided Task JSON to instantiate the Task data model.
JSON representing FHIR Task
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Task
Task data model or undefined for Task
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the instantiatesCanonical property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the instantiatesCanonical property.
the instantiatesCanonical value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instantiatesCanonical property exists and has a value; false otherwise
the instantiatesCanonical property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the instantiatesCanonical property.
the instantiatesCanonical value
this
PrimitiveTypeError for invalid primitive types
true if the instantiatesCanonical property exists and has a value; false otherwise
the instantiatesUri property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the instantiatesUri property.
the instantiatesUri value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instantiatesUri property exists and has a value; false otherwise
the instantiatesUri property value as a fhirUri if defined; else undefined
Assigns the provided primitive value to the instantiatesUri property.
the instantiatesUri value
this
PrimitiveTypeError for invalid primitive types
true if the instantiatesUri property exists and has a value; false otherwise
the basedOn property value as a Reference array
Assigns the provided Reference array value to the basedOn property.
the basedOn array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the basedOn array property.
the basedOn value
this
InvalidTypeError for invalid data type or reference value
true if the basedOn property exists and has a value; false otherwise
the groupIdentifier property value as a Identifier object if defined; else an empty Identifier object
Assigns the provided GroupIdentifier object value to the groupIdentifier property.
the groupIdentifier object value
this
InvalidTypeError for invalid data types
true if the groupIdentifier property exists and has a value; false otherwise
the partOf property value as a Reference array
Assigns the provided Reference array value to the partOf property.
the partOf array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the partOf array property.
the partOf value
this
InvalidTypeError for invalid data type or reference value
true if the partOf property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: TaskStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: TaskStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: TaskStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: TaskStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: TaskStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: TaskStatusEnum
true if the status property exists and has a value; false otherwise
the statusReason property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided StatusReason object value to the statusReason property.
the statusReason object value
this
InvalidTypeError for invalid data types
true if the statusReason property exists and has a value; false otherwise
the businessStatus property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided BusinessStatus object value to the businessStatus property.
the businessStatus object value
this
InvalidTypeError for invalid data types
true if the businessStatus property exists and has a value; false otherwise
the intent property value as a CodeType object if defined; else an empty CodeType object
Assigns the provided PrimitiveType value to the intent property.
the intent value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the intent property exists and has a value; false otherwise
the intent property value as a fhirCode if defined; else null
Assigns the provided primitive value to the intent property.
the intent value
this
PrimitiveTypeError for invalid primitive types
true if the intent property exists and has a value; false otherwise
the priority property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided EnumCodeType value to the priority property.
the priority value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the priority property value as a CodeType if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided PrimitiveType value to the priority property.
the priority value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the priority property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: RequestPriorityEnum
Assigns the provided primitive value to the priority property.
the priority value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: RequestPriorityEnum
true if the priority property exists and has a value; false otherwise
the doNotPerform property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the doNotPerform property.
the doNotPerform value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the doNotPerform property exists and has a value; false otherwise
the doNotPerform property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the doNotPerform property.
the doNotPerform value
this
PrimitiveTypeError for invalid primitive types
true if the doNotPerform property exists and has a value; false otherwise
the code property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Code object value to the code property.
the code object value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the description property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the focus property value as a Reference object; else an empty Reference object
Assigns the provided Focus object value to the focus property.
the focus object value
this
InvalidTypeError for invalid data type or reference value
true if the focus property exists and has a value; false otherwise
the for_ property value as a Reference object; else an empty Reference object
Assigns the provided For object value to the for_ property.
the for_ object value
this
InvalidTypeError for invalid data type or reference value
true if the for_ property exists and has a value; false otherwise
the encounter property value as a Reference object; else an empty Reference object
Assigns the provided Encounter object value to the encounter property.
the encounter object value
this
InvalidTypeError for invalid data type or reference value
true if the encounter property exists and has a value; false otherwise
the requestedPeriod property value as a Period object if defined; else an empty Period object
Assigns the provided RequestedPeriod object value to the requestedPeriod property.
the requestedPeriod object value
this
InvalidTypeError for invalid data types
true if the requestedPeriod property exists and has a value; false otherwise
the executionPeriod property value as a Period object if defined; else an empty Period object
Assigns the provided ExecutionPeriod object value to the executionPeriod property.
the executionPeriod object value
this
InvalidTypeError for invalid data types
true if the executionPeriod property exists and has a value; false otherwise
the authoredOn property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the authoredOn property.
the authoredOn value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the authoredOn property exists and has a value; false otherwise
the authoredOn property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the authoredOn property.
the authoredOn value
this
PrimitiveTypeError for invalid primitive types
true if the authoredOn property exists and has a value; false otherwise
the lastModified property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the lastModified property.
the lastModified value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the lastModified property exists and has a value; false otherwise
the lastModified property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the lastModified property.
the lastModified value
this
PrimitiveTypeError for invalid primitive types
true if the lastModified property exists and has a value; false otherwise
the requester property value as a Reference object; else an empty Reference object
Assigns the provided Requester object value to the requester property.
the requester object value
this
@ReferenceTargets('Task.requester', ['Device','Organization','Patient','Practitioner','PractitionerRole','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the requester property exists and has a value; false otherwise
the requestedPerformer property value as a CodeableReference array
Assigns the provided CodeableReference array value to the requestedPerformer property.
the requestedPerformer array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the requestedPerformer array property.
the requestedPerformer value
this
InvalidTypeError for invalid data types
true if the requestedPerformer property exists and has a value; false otherwise
the owner property value as a Reference object; else an empty Reference object
Assigns the provided Owner object value to the owner property.
the owner object value
this
@ReferenceTargets('Task.owner', ['Practitioner','PractitionerRole','Organization','CareTeam','Patient','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the owner property exists and has a value; false otherwise
the performer property value as a TaskPerformerComponent array
Assigns the provided TaskPerformerComponent array value to the performer property.
the performer array value
this
InvalidTypeError for invalid data types
Add the provided TaskPerformerComponent value to the performer array property.
the performer value
this
InvalidTypeError for invalid data types
true if the performer property exists and has a value; false otherwise
the location property value as a Reference object; else an empty Reference object
Assigns the provided Location object value to the location property.
the location object value
this
InvalidTypeError for invalid data type or reference value
true if the location property exists and has a value; false otherwise
the reason property value as a CodeableReference array
Assigns the provided CodeableReference array value to the reason property.
the reason array value
this
InvalidTypeError for invalid data types
Add the provided CodeableReference value to the reason array property.
the reason value
this
InvalidTypeError for invalid data types
true if the reason property exists and has a value; false otherwise
the insurance property value as a Reference array
Assigns the provided Reference array value to the insurance property.
the insurance array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the insurance array property.
the insurance value
this
InvalidTypeError for invalid data type or reference value
true if the insurance property exists and has a value; false otherwise
the note property value as a Annotation array
Assigns the provided Annotation array value to the note property.
the note array value
this
InvalidTypeError for invalid data types
Add the provided Annotation value to the note array property.
the note value
this
InvalidTypeError for invalid data types
true if the note property exists and has a value; false otherwise
the relevantHistory property value as a Reference array
Assigns the provided Reference array value to the relevantHistory property.
the relevantHistory array value
this
InvalidTypeError for invalid data type or reference value
Add the provided Reference value to the relevantHistory array property.
the relevantHistory value
this
InvalidTypeError for invalid data type or reference value
true if the relevantHistory property exists and has a value; false otherwise
the restriction property value as a TaskRestrictionComponent object if defined; else an empty TaskRestrictionComponent object
Assigns the provided Restriction object value to the restriction property.
the restriction object value
this
InvalidTypeError for invalid data types
true if the restriction property exists and has a value; false otherwise
the input property value as a TaskInputComponent array
Assigns the provided TaskInputComponent array value to the input property.
the input array value
this
InvalidTypeError for invalid data types
Add the provided TaskInputComponent value to the input array property.
the input value
this
InvalidTypeError for invalid data types
true if the input property exists and has a value; false otherwise
the output property value as a TaskOutputComponent array
Assigns the provided TaskOutputComponent array value to the output property.
the output array value
this
InvalidTypeError for invalid data types
Add the provided TaskOutputComponent value to the output array property.
the output value
this
InvalidTypeError for invalid data types
true if the output property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the basedOn property
PrivateinitInitialize the partOf property
PrivateinitInitialize the requestedPerformer property
PrivateinitInitialize the performer property
PrivateinitInitialize the reason property
PrivateinitInitialize the insurance property
PrivateinitInitialize the note property
PrivateinitInitialize the relevantHistory property
PrivateinitInitialize the input property
PrivateinitInitialize the output property
Task Class
Remarks
A task to be performed.
FHIR Specification
See
FHIR Task