- 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 | |||
Short | A task to be performed | ||
Definition | A task to be performed. | ||
Cardinality | 0..* | ||
Constraints |
| ||
Mappings |
| ||
Task.id | |||
Short | Logical id of this artifact | ||
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 | 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 | |||
Short | Metadata about the resource | ||
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 | ||
Constraints |
| ||
Task.implicitRules | |||
Short | A set of rules under which this content was created | ||
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. | ||
Constraints |
| ||
Task.language | |||
Short | Language of the resource content | ||
Definition | The base language in which the resource is written. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | A human language.
| ||
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). | ||
Constraints |
| ||
Task.text | |||
Short | Text summary of the resource, for human interpretation | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.contained | |||
Short | Contained, inline Resources | ||
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 | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.modifierExtension | |||
Short | Extensions that cannot be ignored | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.identifier | |||
Short | Task Instance Identifier | ||
Definition | The business identifier for this task. | ||
Cardinality | 0..* | ||
Type | Identifier | ||
Constraints |
| ||
Mappings |
| ||
Task.instantiatesCanonical | |||
Short | Formal definition of task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.instantiatesUri | |||
Short | Formal definition of task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.basedOn | |||
Short | Request fulfilled by this task | ||
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 | ||
Constraints |
| ||
Mappings |
| ||
Task.groupIdentifier | |||
Short | Requisition or grouper id | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.partOf | |||
Short | Composite task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.status | |||
Short | draft | requested | received | accepted | + | ||
Definition | The current status of the task. | ||
Cardinality | 1..1 | ||
Type | code | ||
Binding | The current status of the task. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.statusReason | |||
Short | Reason for current status | ||
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. | ||
Summary | True | ||
Comments | This applies to the current status. Look at the history of the task to see reasons for past statuses. | ||
Constraints |
| ||
Mappings |
| ||
Task.businessStatus | |||
Short | E.g. "Specimen collected", "IV prepped" | ||
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. | ||
Summary | True | ||
Requirements | There's often a need to track substates of a task - this is often variable by specific workflow implementation. | ||
Constraints |
| ||
Mappings |
| ||
Task.intent | |||
Short | unknown | proposal | plan | order | original-order | reflex-order | filler-order | instance-order | option | ||
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. | ||
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". | ||
Constraints |
| ||
Mappings |
| ||
Task.priority | |||
Short | routine | urgent | asap | stat | ||
Definition | Indicates how quickly the Task should be addressed with respect to other requests. | ||
Cardinality | 0..1 | ||
Type | code | ||
Binding | The task's priority. | ||
Requirements | Used to identify the service level expected while performing a task. | ||
Meaning when missing | If missing, this task should be performed with normal priority | ||
Constraints |
| ||
Mappings |
| ||
Task.code | |||
Short | Task Type | ||
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. | ||
Must Support | True | ||
Summary | True | ||
Comments | The title (eg "My Tasks", "Outstanding Tasks for Patient X") should go into the code. | ||
Constraints |
| ||
Mappings |
| ||
Task.description | |||
Short | Human-readable explanation of task | ||
Definition | A free-text description of what is to be performed. | ||
Cardinality | 0..1 | ||
Type | string | ||
Summary | True | ||
Constraints |
| ||
Mappings |
| ||
Task.focus | |||
Short | What task is acting on | ||
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.). | ||
Constraints |
| ||
Mappings |
| ||
Task.for | |||
Short | Beneficiary of the Task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.encounter | |||
Short | Healthcare event during which this task originated | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.executionPeriod | |||
Short | Start and end time of execution | ||
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 | ||
Constraints |
| ||
Mappings |
| ||
Task.authoredOn | |||
Short | Task Creation Date | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 | ||
Constraints |
| ||
Mappings |
| ||
Task.lastModified | |||
Short | Task Last Modified Date | ||
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. | ||
Conditions | The cardinality or value of this element may be affected by these constraints: inv-1 | ||
Constraints |
| ||
Mappings |
| ||
Task.requester | |||
Short | Who is asking for task to be done | ||
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). | ||
Constraints |
| ||
Mappings |
| ||
Task.performerType | |||
Short | Requested performer | ||
Definition | The kind of participant that should perform the task. | ||
Cardinality | 0..* | ||
Type | CodeableConcept | ||
Binding | The type(s) of task performers allowed. | ||
Requirements | Use to distinguish tasks on different activity queues. | ||
Constraints |
| ||
Mappings |
| ||
Task.owner | |||
Short | Responsible individual | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.location | |||
Short | Where task occurs | ||
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). | ||
Constraints |
| ||
Mappings |
| ||
Task.reasonCode | |||
Short | Why task is needed | ||
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. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.reasonReference | |||
Short | Why task is needed | ||
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 | ||
Constraints |
| ||
Mappings |
| ||
Task.insurance | |||
Short | Associated insurance coverage | ||
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be relevant to the Task. | ||
Cardinality | 0..* | ||
Type | Reference(Coverage | ClaimResponse) | ||
Constraints |
| ||
Mappings |
| ||
Task.note | |||
Short | Comments made about the task | ||
Definition | Free-text information captured about the task as it progresses. | ||
Cardinality | 0..* | ||
Type | Annotation | ||
Constraints |
| ||
Mappings |
| ||
Task.relevantHistory | |||
Short | Key events in history of the Task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.restriction | |||
Short | Constraints on fulfillment tasks | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.restriction.id | |||
Short | Unique id for inter-element referencing | ||
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 | string | ||
Mappings |
| ||
Task.restriction.extension | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.restriction.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.restriction.repetitions | |||
Short | How many times to repeat | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.restriction.period | |||
Short | When fulfillment sought | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.restriction.recipient | |||
Short | For whom is fulfillment sought? | ||
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) | ||
Constraints |
| ||
Mappings |
| ||
Task.input | |||
Short | Information used to perform task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.input.id | |||
Short | Unique id for inter-element referencing | ||
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 | string | ||
Mappings |
| ||
Task.input.extension | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.input.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.input.type | |||
Short | Label for the input | ||
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. | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.input.value[x] | |||
Short | Content to use in performing the task | ||
Definition | The value of the input parameter as a basic type. | ||
Cardinality | 1..1 | ||
Type | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||
Constraints |
| ||
Mappings |
| ||
Task.output | |||
Short | Information produced as part of task | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.output.id | |||
Short | Unique id for inter-element referencing | ||
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 | string | ||
Mappings |
| ||
Task.output.extension | |||
Short | Additional content defined by implementations | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.output.modifierExtension | |||
Short | Extensions that cannot be ignored even if unrecognized | ||
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. | ||
Constraints |
| ||
Mappings |
| ||
Task.output.type | |||
Short | Label for output | ||
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. | ||
Alias | Name | ||
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. | ||
Constraints |
| ||
Mappings |
| ||
Task.output.value[x] | |||
Short | Result of output | ||
Definition | The value of the Output parameter as a basic type. | ||
Cardinality | 1..1 | ||
Type | base64Binary, boolean, canonical(), code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference(), SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta | ||
Requirements | Task outputs can take any form. | ||
Constraints |
| ||
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
JSON View
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