Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Task Implementation Guidance

Task resource implementation guidance

Task: Implementation Guidance

Usage

The Task resource will be populated where there is a specific action for the intended recipient of the encounter report.

Detailed implementation guidance for a Task resource within the scope of this implementation guide is given below:
​ ​

Name Cardinality Type FHIR Documentation CDS Implementation Guidance
id 0..1 id Logical id of this artifact
meta 0..1 Meta Metadata about the resource
implicitRules 0..1 uri A set of rules under which this content was created
language 0..1 code Language of the resource content.
Common Languages (Extensible but limited to All Languages)
text 0..1 Narrative Text summary of the resource, for human interpretation
contained 0..* Resource Contained, inline Resources
extension 0..* Extension Additional Content defined by implementations
modifierExtension 0..* Extension Extensions that cannot be ignored
identifier 0..* Identifier Business identifier
definition[x] 0..1 Formal definition of task
definitionUri uri
definitionReference Reference(ActivityDefinition)
basedOn 0..* Reference(Any) Request fulfilled by this task This SHOULD be the associated ReferralRequest.
groupIdentifier 0..1 Identifier Requisition or grouper id
partOf 0..* Reference(Task) Composite task
status 1..1 code draft | requested | received | accepted | +
TaskStatus (Required)
statusReason 0..1 CodeableConcept Reason for current status
businessStatus 0..1 CodeableConcept E.g. "Specimen collected", "IV prepped"
intent 1..1 code proposal | plan | order +
RequestIntent (Required)
priority 0..1 code routine | urgent | asap | stat
RequestPriority (Required)
This MUST carry the value 'routine'.
code 0..1 CodeableConcept Task Type: ambulance | cpcs | validation UEC-TaskCode-1 (Extensible) This MUST be populated.
description 0..1 string Human-readable explanation of task
focus 0..1 Reference(Any) What task is acting on This MUST NOT be populated.
for 0..1 Reference(Any) Beneficiary of the Task This MUST be the associated Patient.
context 0..1 Reference(Encounter | EpisodeOfCare) Healthcare event during which this task originated This MUST be the associated Encounter.
executionPeriod 0..1 Period Start and end time of execution This MUST be null at the creation of the encounter report.
authoredOn 0..1 dateTime Task Creation Date This MUST be populated.
lastModified 0..1 dateTime Task Last Modified Date
requester 0..1 BackboneElement Who is asking for task to be done This SHOULD be the initiating user of the Encounter, i.e. the user of the EMS.
agent 1..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Individual asking for task
onBehalfOf 0..1 Reference(Organization) Organization individual is acting for Only to be populated if requester.agent is a Practitioner.
performerType 0..* CodeableConcept requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
TaskPerformerType (Preferred)
owner 0..1 Reference(Device | Organization | Patient | Practitioner | RelatedPerson) Responsible individual This MUST be populated with the Organisation that is receiving the Task.
reason 0..1 CodeableConcept Why task is needed This MUST NOT be populated.
note 0..* Annotation Comments made about the task See additional guidance below.
relevantHistory 0..* Reference(Provenance) Key events in history of the Task If populated this MUST be the same as ReferralRequest.relevantHistory.
restriction 0..1 BackboneElement Constraints on fulfillment tasks
repetitions 0..1 positiveInt How many times to repeat In practice this will usually be set to one repetition.
period 0..1 Period When fulfillment sought Time period in which the Task must be fulfilled - note that this will normally be different (shorter) than ReferralRequest.occurrence
recipient 0..* Reference(Patient | Practitioner | RelatedPerson | Group | Organization) For whom is fulfillment sought? This MUST NOT be populated.
input 0..* BackboneElement Information used to perform task
type 1..1 CodeableConcept Label for the input
value[x] 1..1 * Content to use in performing the task
output 0..* BackboneElement Information produced as part of task This MUST NOT be populated.
type 1..1 CodeableConcept Label for output This MUST NOT be populated.
value[x] 1..1 * Result of output This MUST NOT be populated.

Task: Element Guidance

note

If notes are made about a Task they MUST be displayed by the Encounter Report Receiving System (ERR).

Tags: rest fhir api

All content is available under the Open Government Licence v3.0, except where otherwise stated