- This is an Implementation Guide for UK Core FHIR Assets in Development.
- There will be disruption as the content will be updated on an ad-hoc basis and with links not working.
- Therefore this Implementation Guide must not be implemented.
- Please follow the guidance on the "Contact Us" page if you need any assistance.
StructureDefinition-UKCore-Task
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task | draft | 1.2.0 | 2023-12-12 | This profile defines the UK constraints and extensions on the International FHIR resource Task. |
Profile_Purpose |
---|
A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity. Note that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details. |
Detailed Descriptions
Task | |
Definition | A task to be performed. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Task.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | System.String |
Summary | True |
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 might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Mappings |
|
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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | 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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Mappings |
|
Task.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. CommonLanguages (preferred) |
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). |
Invariants |
|
Mappings |
|
Task.text | |
Definition | 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | 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 information is added later. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...* |
Type | Resource |
Alias | 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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Task.extension | |
Definition | 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. |
Cardinality | 0...* |
Type | Extension |
Alias | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Task.identifier | |
Definition | The business identifier for this task. |
Cardinality | 0...* |
Type | Identifier |
Invariants |
|
Mappings |
|
Task.instantiatesCanonical | |
Definition | 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. |
Cardinality | 0...1 |
Type | canonical(ActivityDefinition) |
Summary | True |
Requirements | Enables a formal definition of how he task is to be performed, enabling automation. |
Comments | |
Invariants |
|
Mappings |
|
Task.instantiatesUri | |
Definition | 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. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
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. |
Comments | see http://en.wikipedia.org/wiki/Uniform_resource_identifier |
Invariants |
|
Mappings |
|
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 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. |
Cardinality | 0...* |
Type | Reference(Resource) |
Summary | True |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Task.groupIdentifier | |
Definition | An identifier that links together multiple tasks and other requests that were created in the same context. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | Billing and/or reporting can be linked to whether multiple requests were created as a single unit. |
Invariants |
|
Mappings |
|
Task.partOf | |
Definition | Task that this particular task is part of. |
Cardinality | 0...* |
Type | Reference(Task) |
Summary | True |
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. |
Invariants |
|
Mappings |
|
Task.status | |
Definition | The current status of the task. |
Cardinality | 1...1 |
Type | code |
Binding | The current status of the task. TaskStatus (required) |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Task.statusReason | |
Definition | An explanation as to why this task is held, failed, was refused, etc. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes to identify the reason for current status. These will typically be specific to a particular workflow. (unbound) (example) |
Summary | True |
Comments | This applies to the current status. Look at the history of the task to see reasons for past statuses. |
Invariants |
|
Mappings |
|
Task.businessStatus | |
Definition | Contains business-specific nuances of the business state. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The domain-specific business-contextual sub-state of the task. For example: "Blood drawn", "IV inserted", "Awaiting physician signature", etc. (unbound) (example) |
Summary | True |
Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Task.intent | |
Definition | 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. |
Cardinality | 1...1 |
Type | code |
Binding | Distinguishes whether the task is a proposal, plan or full order. TaskIntent (required) |
Must Support | True |
Summary | 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". |
Invariants |
|
Mappings |
|
Task.priority | |
Definition | Indicates how quickly the Task should be addressed with respect to other requests. |
Cardinality | 0...1 |
Type | code |
Binding | The task's priority. RequestPriority (required) |
Requirements | Used to identify the service level expected while performing a task. |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Task.code | |
Definition | A name or code (or both) briefly describing what the task involves. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Codes to identify what the task involves. These will typically be specific to a particular workflow. TaskCode (example) |
Must Support | True |
Summary | True |
Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. |
Invariants |
|
Mappings |
|
Task.description | |
Definition | A free-text description of what is to be performed. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Note that FHIR strings SHALL NOT exceed 1MB in size |
Invariants |
|
Mappings |
|
Task.focus | |
Definition | The request being actioned or the resource being manipulated by this task. |
Cardinality | 0...1 |
Type | Reference(Resource) |
Must Support | True |
Summary | True |
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.). |
Invariants |
|
Mappings |
|
Task.for | |
Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
Cardinality | 0...1 |
Type | Reference(Resource) |
Must Support | True |
Summary | True |
Alias | Patient |
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. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Task.encounter | |
Definition | The healthcare event (e.g. a patient and healthcare provider interaction) during which this task was created. |
Cardinality | 0...1 |
Type | Reference(Encounter) |
Summary | True |
Requirements | For some tasks it may be important to know the link between the encounter the task originated within. |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
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). |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Comments | A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration. |
Invariants |
|
Mappings |
|
Task.authoredOn | |
Definition | The date and time this task was created. |
Cardinality | 0...1 |
Type | dateTime |
Must Support | True |
Alias | Created Date |
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. |
Invariants |
|
Mappings |
|
Task.lastModified | |
Definition | The date and time of last modification to this task. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | Update Date |
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. |
Invariants |
|
Mappings |
|
Task.requester | |
Definition | The creator of the task. |
Cardinality | 0...1 |
Type | Reference(Device | Organization | Patient | Practitioner | PractitionerRole | RelatedPerson) |
Must Support | True |
Summary | True |
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). |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Task.performerType | |
Definition | The kind of participant that should perform the task. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The type(s) of task performers allowed. ProcedurePerformerRoleCodes (preferred) |
Requirements | Use to distinguish tasks on different activity queues. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Task.owner | |
Definition | Individual organization or Device currently responsible for task execution. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
Must Support | True |
Summary | True |
Alias | Performer, Executer |
Requirements | Identifies who is expected to perform this task. |
Comments | Tasks may be created with an owner not yet identified. |
Invariants |
|
Mappings |
|
Task.location | |
Definition | Principal physical location where the this task is performed. |
Cardinality | 0...1 |
Type | Reference(Location) |
Summary | True |
Requirements | Ties the event to where the records are likely kept and provides context around the event occurrence (e.g. if it occurred inside or outside a dedicated healthcare setting). |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Task.reasonCode | |
Definition | A description or code indicating why this task needs to be performed. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Indicates why the task is needed. E.g. Suspended because patient admitted to hospital. (unbound) (example) |
Must Support | True |
Comments | This should only be included if there is no focus or if it differs from the reason indicated on the focus. |
Invariants |
|
Mappings |
|
Task.reasonReference | |
Definition | A resource reference indicating why this task needs to be performed. |
Cardinality | 0...1 |
Type | Reference(Resource) |
Must Support | True |
Comments | Tasks might be justified based on an Observation, a Condition, a past or planned procedure, etc. This should only be included if there is no focus or if it differs from the reason indicated on the focus. Use the CodeableConcept text element in |
Invariants |
|
Mappings |
|
Task.insurance | |
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. |
Cardinality | 0...* |
Type | Reference(Coverage | ClaimResponse) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Task.note | |
Definition | Free-text information captured about the task as it progresses. |
Cardinality | 0...* |
Type | Annotation |
Comments | For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible). |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Alias | 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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | BackboneElement |
Must Support | True |
Requirements | Sometimes when fulfillment is sought, you don't want full fulfillment. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Task.restriction.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0...* |
Type | Extension |
Alias | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 in which it is contained 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 can 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Task.restriction.repetitions | |
Definition | Indicates the number of times the requested action should occur. |
Cardinality | 0...1 |
Type | positiveInt |
Requirements | E.g. order that requests monthly lab tests, fulfillment is sought for 1. |
Comments | 32 bit number; for values larger than this, use decimal |
Invariants |
|
Mappings |
|
Task.restriction.period | |
Definition | Over what time-period is fulfillment sought. |
Cardinality | 0...1 |
Type | Period |
Must Support | True |
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. |
Invariants |
|
Mappings |
|
Task.restriction.recipient | |
Definition | For requests that are targeted to more than on potential recipient/target, for whom is fulfillment sought? |
Cardinality | 0...* |
Type | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Group | Organization) |
Comments | References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. |
Invariants |
|
Mappings |
|
Task.input | |
Definition | Additional information that may be needed in the execution of the task. |
Cardinality | 0...* |
Type | BackboneElement |
Must Support | True |
Alias | Supporting Information |
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. |
Invariants |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Task.input.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0...* |
Type | Extension |
Alias | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 in which it is contained 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 can 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Task.input.type | |
Definition | A code or description indicating how the input is intended to be used as part of the task execution. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes to identify types of input parameters. These will typically be specific to a particular workflow. E.g. "Comparison source", "Applicable consent", "Concomitent Medications", etc. (unbound) (example) |
Alias | Name |
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. |
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. |
Invariants |
|
Mappings |
|
Task.input.value[x] | |
Definition | The value of the input parameter as a basic type. |
Cardinality | 1...1 |
Type | base64Binary |
Invariants |
|
Mappings |
|
Task.output | |
Definition | Outputs produced by the Task. |
Cardinality | 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 |
|
Mappings |
|
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. |
Cardinality | 0...1 |
Type | System.String |
Mappings |
|
Task.output.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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. |
Cardinality | 0...* |
Type | Extension |
Alias | 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. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
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 in which it is contained 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 can 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). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
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. |
Invariants |
|
Mappings |
|
Task.output.type | |
Definition | The name of the Output parameter. |
Cardinality | 1...1 |
Type | CodeableConcept |
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. (unbound) (example) |
Alias | Name |
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. |
Comments | Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Invariants |
|
Mappings |
|
Task.output.value[x] | |
Definition | The value of the Output parameter as a basic type. |
Cardinality | 1...1 |
Type | base64Binary |
Requirements | Task outputs can take any form. |
Invariants |
|
Mappings |
|
Table View
Task | .. | |
Task.status | .. | |
Task.intent | .. | |
Task.code | .. | |
Task.focus | .. | |
Task.for | .. | |
Task.authoredOn | .. | |
Task.requester | .. | |
Task.owner | .. | |
Task.reasonCode | .. | |
Task.reasonReference | .. | |
Task.restriction | .. | |
Task.restriction.period | .. | |
Task.input | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Task" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task" /> <version value="1.2.0" /> <name value="UKCoreTask" /> <title value="UK Core Task" /> <status value="draft" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Task](https://hl7.org/fhir/R4/Task.html)." /> <purpose value="A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.\n\nNote that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Task" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Task" /> <derivation value="constraint" /> <differential> <element id="Task.status"> <path value="Task.status" /> <mustSupport value="true" /> </element> <element id="Task.intent"> <path value="Task.intent" /> <mustSupport value="true" /> </element> <element id="Task.code"> <path value="Task.code" /> <mustSupport value="true" /> </element> <element id="Task.focus"> <path value="Task.focus" /> <mustSupport value="true" /> </element> <element id="Task.for"> <path value="Task.for" /> <mustSupport value="true" /> </element> <element id="Task.authoredOn"> <path value="Task.authoredOn" /> <mustSupport value="true" /> </element> <element id="Task.requester"> <path value="Task.requester" /> <mustSupport value="true" /> </element> <element id="Task.owner"> <path value="Task.owner" /> <mustSupport value="true" /> </element> <element id="Task.reasonCode"> <path value="Task.reasonCode" /> <mustSupport value="true" /> </element> <element id="Task.reasonReference"> <path value="Task.reasonReference" /> <mustSupport value="true" /> </element> <element id="Task.restriction"> <path value="Task.restriction" /> <mustSupport value="true" /> </element> <element id="Task.restriction.period"> <path value="Task.restriction.period" /> <mustSupport value="true" /> </element> <element id="Task.input"> <path value="Task.input" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Task", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Task", "version": "1.2.0", "name": "UKCoreTask", "title": "UK Core Task", "status": "draft", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Task](https://hl7.org/fhir/R4/Task.html).", "purpose": "A task resource describes an activity that can be performed and tracks the state of completion of that activity. It is a representation that an activity should be or has been initiated, and eventually, represents the successful or unsuccessful completion of that activity.\n\nNote that there are a variety of processes associated with making and processing orders. Some orders may be handled immediately by automated systems but most require real world actions by one or more humans. Some orders can only be processed when other real world actions happen, such as a patient presenting themselves so that the action to be performed can actually be performed. Often these real world dependencies are only implicit in the order details.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Task", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Task", "derivation": "constraint", "differential": { "element": [ { "id": "Task.status", "path": "Task.status", "mustSupport": true }, { "id": "Task.intent", "path": "Task.intent", "mustSupport": true }, { "id": "Task.code", "path": "Task.code", "mustSupport": true }, { "id": "Task.focus", "path": "Task.focus", "mustSupport": true }, { "id": "Task.for", "path": "Task.for", "mustSupport": true }, { "id": "Task.authoredOn", "path": "Task.authoredOn", "mustSupport": true }, { "id": "Task.requester", "path": "Task.requester", "mustSupport": true }, { "id": "Task.owner", "path": "Task.owner", "mustSupport": true }, { "id": "Task.reasonCode", "path": "Task.reasonCode", "mustSupport": true }, { "id": "Task.reasonReference", "path": "Task.reasonReference", "mustSupport": true }, { "id": "Task.restriction", "path": "Task.restriction", "mustSupport": true }, { "id": "Task.restriction.period", "path": "Task.restriction.period", "mustSupport": true }, { "id": "Task.input", "path": "Task.input", "mustSupport": true } ] } }
Usage
This Profile has the following derived profiles:This Profile is referenced in the following Extensions:
This Profile is referenced in the following Profiles:
Feedback
Click here to:Examples
Colonoscopy - An example to illustrate a task regarding a colonoscopy.Example UKCore-Task-Colonoscopy
Example Usage Scenarios
The following are example usage scenarios for the UK Core Task profile:
- Query for task information
- Exchange task information within a FHIR document or message.
Profile Specific Implementation Guidance:
Minimum Viable Content
A minimum viable content that all provider and consumer systems SHALL support are the following elements.
Element | Reason |
---|---|
Task.status |
The current status of the task. |
Task.intent |
Indicates the "level" of actionability associated with the task. |
Task.code |
A name or code (or both) briefly describing what the task involves. |
Task.focus |
The request being actioned or the resource being manipulated by this task. |
Task.for |
Beneficiary of the task. |
Task.authoredOn |
Task creation date. |
Task.requester |
Who is asking for task to be done. |
Task.owner |
Responsible individual. |
Task.reasonCode |
Why task is needed. |
Task.restriction |
Constraints on fulfilment tasks. |
Task.restriction.period |
Over what time-period is fulfilment sought. |
Task.input |
Information used to perform task. |
basedOn
Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.
partOf
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Task.
focus
Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.
for
Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.
encounter
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Encounter.
requester
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-Device
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
owner
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-CareTeam
- Profile UKCore-Device
- Profile UKCore-HealthcareService
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
location
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Location.
reasonReference
Where a UK Core profile exists the resource being referenced SHOULD conform to the profile.
relevantHistory
Where possible, it is expected that the resource being referenced SHOULD conform to Profile UKCore-Provenance.
restriction
Task.restriction.recipient
Where possible, it is expected that the resource being referenced SHOULD conform to one of the following UK Core profiles:
- Profile UKCore-Organization
- Profile UKCore-Patient
- Profile UKCore-Practitioner
- Profile UKCore-PractitionerRole
- Profile UKCore-RelatedPerson
- Group Resource