Definitions for the ehealth-task Profile.
Task | |
Definition | A task to be performed. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) inv-1: Last modified date must be greater than or equal to authored-on date. (: lastModified.exists().not() or authoredOn.exists().not() or lastModified >= authoredOn) |
Task.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Task.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Task.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
Task.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Task.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may 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. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
Task.contained | |
Definition | 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. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Task.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Task.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-task-category]]) | |
Definition | An Extension |
Control | 1..1 |
Type | Extension(category) (Extension Type: Coding) |
Task.modifierExtension | |
Definition | 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. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.identifier | |
Definition | The business identifier for this task. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Task.definition[x] | |
Definition | A reference to a formal or informal definition of the task. For example, a protocol, a step within a defined workflow definition, etc. |
Control | 0..1 |
Type | Choice of: uri, Reference(ehealth-activitydefinition) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Enables a formal definition of how he task is to be performed (e.g. using BPMN, BPEL, XPDL or other formal notation) to be associated with a task, enabling automation. |
Task.basedOn | |
Definition | 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. |
Control | 0..* |
Type | Reference(Resource) |
Task.groupIdentifier | |
Definition | An identifier that links together multiple tasks and other requests that were created in the same context. |
Control | 0..1 |
Type | Identifier |
Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. |
Task.partOf | |
Definition | Task that this particular task is part of. |
Control | 0..* |
Type | Reference(ehealth-task) |
Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). |
Comments | This should usually be 0..1. |
Task.status | |
Definition | The current status of the task. |
Control | 1..1 |
Binding | The current status of the task. The codes SHALL be taken from TaskStatus |
Type | code |
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
Task.statusReason | |
Definition | An explanation as to why this task is held, failed, was refused, etc. |
Control | 0..1 |
Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. |
Type | CodeableConcept |
Comments | This applies to the current status. Look at the history of the task to see reasons for past statuses. |
Task.businessStatus | |
Definition | Contains business-specific nuances of the business state. |
Control | 0..1 |
Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. |
Type | CodeableConcept |
Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. |
Task.intent | |
Definition | Indicates the "level" of actionability associated with the Task. I.e. Is this a proposed task, a planned task, an actionable task, etc. |
Control | 1..1 |
Binding | Distinguishes whether the task is a proposal, plan or full order The codes SHALL be taken from RequestIntent |
Type | code |
Must Support | true |
Comments | This element is immutable. Proposed tasks, planned tasks, etc. must be distinct instances. In most cases, Tasks will have an intent of "order". |
Task.priority | |
Definition | Indicates how quickly the Task should be addressed with respect to other requests. |
Control | 1..1 |
Binding | The task's priority The codes SHALL be taken from RequestPriority |
Type | code |
Must Support | true |
Requirements | Used to identify the service level expected while performing a task. |
Meaning if Missing | If missing, this task should be performed with normal priority |
Task.code | |
Definition | A name or code (or both) briefly describing what the task involves. |
Control | 0..1 |
Binding | Codes to identify what the task involves. These will typically be specific to a particular workflow. |
Type | CodeableConcept |
Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. |
Task.description | |
Definition | A free-text description of what is to be performed. |
Control | 0..1 |
Type | string |
Task.focus | |
Definition | The request being actioned or the resource being manipulated by this task. |
Control | 0..1 |
Type | Reference(Resource) |
Requirements | Used to identify the thing to be done. |
Comments | If multiple resources need to be manipulated, use sub-tasks. (This ensures that status can be tracked independently for each referenced resource.). |
Task.for | |
Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
Control | 0..1 |
Type | Reference(Resource) |
Requirements | Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively). This can also affect access control. |
Alternate Names | Patient |
Task.context | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
Control | 1..1 |
Type | Reference(Encounter | ehealth-episodeofcare) |
Requirements | For some tasks it may be important to know the link between the task or episode of care the task originated within. |
Task.executionPeriod | |
Definition | 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). |
Control | 0..1 |
Type | Period |
Task.authoredOn | |
Definition | The date and time this task was created. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | dateTime |
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. |
Alternate Names | Created Date |
Task.lastModified | |
Definition | The date and time of last modification to this task. |
Control | 0..1 This element is affected by the following invariants: inv-1 |
Type | dateTime |
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. |
Alternate Names | Update Date |
Task.requester | |
Definition | The creator of the task. |
Control | 0..1 |
Type | BackboneElement |
Requirements | Identifies who created this task. May be used by access control mechanisms (e.g., to ensure that only the creator can cancel a task). |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Task.requester.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Task.requester.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.requester.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.requester.agent | |
Definition | The device, practitioner, etc. who initiated the task. |
Control | 1..1 |
Type | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
Alternate Names | Initiator, Author |
Task.requester.onBehalfOf | |
Definition | The organization the device or practitioner was acting on behalf of when they initiated the task. |
Control | 0..1 |
Type | Reference(Organization) |
Requirements | Practitioners and Devices can be associated with multiple organizations. This element indicates which organization they were acting on behalf of when authoring the request. |
Task.performerType | |
Definition | The type of participant that can execute the task. |
Control | 0..* |
Binding | The type(s) of task performers allowed The codes SHOULD be taken from TaskPerformerType |
Type | CodeableConcept |
Requirements | Use to distinguish tasks on different activity queues. |
Task.owner | |
Definition | Individual organization or Device currently responsible for task execution. |
Control | 1..1 |
Type | Reference(ehealth-organization | ehealth-patient | ehealth-practitioner | ehealth-relatedperson | ehealth-careteam) |
Requirements | Identifies who is expected to perform this task. |
Alternate Names | Performer, Executer |
Comments | Tasks may be created with an owner not yet identified. |
Task.reason | |
Definition | A description or code indicating why this task needs to be performed. |
Control | 0..1 |
Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. |
Type | CodeableConcept |
Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. |
Task.note | |
Definition | Free-text information captured about the task as it progresses. |
Control | 0..* |
Type | Annotation |
Task.relevantHistory | |
Definition | 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. |
Control | 0..* |
Type | Reference(ehealth-provenance) |
Alternate Names | Status History |
Comments | This element does not point to the Provenance associated with the current version of the resource - as it would be created after this version existed. The Provenance for the current version can be retrieved with a _revinclude. |
Task.restriction | |
Definition | 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. |
Control | 0..1 |
Type | BackboneElement |
Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Task.restriction.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Task.restriction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.restriction.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.restriction.repetitions | |
Definition | Indicates the number of times the requested action should occur. |
Control | 0..1 |
Type | positiveInt |
Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. |
Task.restriction.period | |
Definition | Over what time-period is fulfillment sought. |
Control | 0..1 |
Type | Period |
Requirements | E.g. order that authorizes 1 year's services. Fulfillment is sought for next 3 months. |
Comments | Note that period.high is the due date representing the time by which the task should be completed. |
Task.restriction.recipient | |
Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? |
Control | 0..* |
Type | Reference(Patient | Practitioner | RelatedPerson | Group | Organization) |
Task.input | |
Definition | Additional information that may be needed in the execution of the task. |
Control | 0..* |
Type | BackboneElement |
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. |
Alternate Names | Supporting Information |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Task.input.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Task.input.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.input.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.input.type | |
Definition | A code or description indicating how the input is intended to be used as part of the task execution. |
Control | 1..1 |
Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concommitent Medications", etc. |
Type | CodeableConcept |
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. |
Alternate Names | Name |
Comments | If referencing a BPMN workflow or Protocol, the "system" is the URL for the workflow definition and the code is the "name" of the required input. |
Task.input.value[x] | |
Definition | The value of the input parameter as a basic type. |
Control | 1..1 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Task.output | |
Definition | Outputs produced by the Task. |
Control | 0..* |
Type | BackboneElement |
Requirements | Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count())) |
Task.output.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
Task.output.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.output.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Task.output.type | |
Definition | The name of the Output parameter. |
Control | 1..1 |
Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Identified issues", "Preliminary results", "Filler order", "Final results", etc. |
Type | CodeableConcept |
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. |
Alternate Names | Name |
Task.output.value[x] | |
Definition | The value of the Output parameter as a basic type. |
Control | 1..1 |
Type | Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Task outputs can take any form. |