PrescribeIT® Specification and Guide Version 5.0

 

Definitions for the task-e163-m Profile.

1. Task
Definition

A task to be performed.

Control0..*
Max Length0
InvariantsDefined on this element
inv-1: Last modified date must be greater than or equal to created date. (: lastModified >= created)
inv-2: A Failure reason may be present only when a task has failed. (: failureReason.empty() or status = 'failed')
2. Task.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Must Supporttrue
Comments

Usage Note: This will usually be a GUID and is assigned by the sending application.

Max Length0
3. 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.

Control1..1
TypeMeta
Must Supporttrue
Max Length0
4. Task.meta.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
5. Task.meta.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
6. Task.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Max Length0
7. Task.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

Max Length0
8. Task.meta.profile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..*
Typeuri
Must Supporttrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.

Max Length0
SlicingThis element introduces a set of slices on Task.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ value
9. Task.meta.profile:task-e163-m
SliceNametask-e163-m
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1
Typeuri
Must Supporttrue
Comments

Fixed value: http://prescribeit.ca/fhir/StructureDefinition/task-e163-m

Max Length0
Fixed Valuehttp://prescribeit.ca/fhir/StructureDefinition/task-e163-m
10. Task.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..0
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
11. Task.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
12. 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.

Control0..1
Typeuri
Is Modifiertrue
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 as much as possible.

Max Length0
13. Task.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.

Typecode
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).

Max Length0
14. 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.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Max Length0
15. 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.

Control0..*
TypeResource
Alternate Namesinline 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.

Max Length0
16. Task.extension
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
Max Length0
SlicingThis element introduces a set of slices on Task.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. Task.extension:groupIdentifier
SliceNamegroupIdentifier
Definition

This is the common identifier that represents a paper order. It may be shared by multiple Task instances for various Medication Orders, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber

Control1..1
TypeExtension(Task Group Identifier) (Extension Type: Identifier)
Must Supporttrue
Comments

Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. The following scenarios provide further detail:

Scenario 1) Single Task allowed within a Bundle: There are some business scenarios where a given task will be managed individually and only a single task is allowed in a bundle. This is true for the Adapt (p170) and the Pharmacist Prescribe (p190). Multiple tasks of the same type are not allowed, nor are any other task type.

Scenario 2) Single Task is sent. For any task type, the source system may send a single task within the bundle.

Scenario 3) In either scenario 1 or 2, the task will be assigned its own Group Identifier and will be handled as a group of one.

Scenario 4) Bundle restricted to same task type only: There are cases when only tasks of the same type can be grouped together. This is true for the cancel request (e140), Dispense Notifications (p200), Cancel RX Dispense Notification (p210). In this scenario, no other task types are allowed within the bundle.

Scenario 5) Same or Mixed Task Types within a single group: There are cases when either all the tasks within a group happen to have the same task type (p160) which are not necessary restricted due to 4 or certain task types that are different can be grouped together. This is true for new (e110) and renewal (e120) where these are part of the same prescription. Another scenario is that renewal responses (e161, e162, e163, e164) may be sent with an e110 and/or an e120.

Scenario 6) In either scenario 4 and 5, the same Group Identifier must be assigned to the multiple tasks as they are all part of the same group. All task resources sharing a Group Identifier must be transmitted in the same message bundle and should be treated as a group by the receiving system.

Scenario 7) The p160 task type can only be sent within it's own bundle.

Multiple Group Identifiers within the same Bundle is not allowed.

The Task.extension:groupIdentifier.valueIdentifier.system element will be an OID of the form [Vendor root].[Application instance node].3 expressed as a uri (e.g. urn:oid:1.2.3.4). The branch “.3” is appended to create a unique namespace for the Group Identifer. The Task.extension:groupIdentifier.valueIdentifier.value element will be assigned by the sending system and must be a unique business identifier.

Max Length0
18. Task.extension:basedOn
SliceNamebasedOn
Definition

Identifies a request, plan or proposal that drove the creation of this task

Control1..1
TypeExtension(Task Order Based On) (Extension Type: Reference(Shared Health Reference)(PrescribeIT® base Task profile))
Must Supporttrue
Comments

Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information.

Max Length0
19. Task.extension:basedOn.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
20. Task.extension:basedOn.extension
Definition

An Extension

Control0..0
TypeExtension
21. Task.extension:basedOn.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
Must Supporttrue
Comments

Fixed value: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn

Fixed Valuehttp://hl7.org/fhir/StructureDefinition/extension-Task.basedOn
22. Task.extension:basedOn.value[x]
Definition

The identifier of the request task that this task was created based on

Control1..1
TypeReference
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the Task.id for the task being responded to

SlicingThis element introduces a set of slices on Task.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
23. Task.extension:basedOn.value[x]:valueReference
SliceNamevalueReference
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

Control1..1
TypeReference
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the Task.id for the task being responded to

24. Task.extension:basedOn.value[x]:valueReference.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
25. Task.extension:basedOn.value[x]:valueReference.extension
Definition

An Extension

Control0..*
TypeExtension
Must Supporttrue
Max Length0
SlicingThis element introduces a set of slices on Task.extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
26. Task.extension:basedOn.value[x]:valueReference.extension:multipleResponse
SliceNamemultipleResponse
Definition

If true, indicates that this renewal response is a subsequent response of an initial response that was sent as 'under review'.

Control0..1
TypeExtension(Task Multiple Response) (Extension Type: boolean)
Must Supporttrue
Comments

Conformance Rules:

1) This must not be provided on any of the initial responses including when initial response is under review

2) This must only be provided and set to true on a subsequent response of Approve, Approve with change or Deny which follows on initial response of 'under review'

3) Subsequent responses of under review are not permitted

Max Length0
27. Task.extension:basedOn.value[x]:valueReference.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
Comments

Conformance Rule: This shall be the Task.id of the request task being responded to, expressed as a uri (i.e. urn:uuid:[original task id])

Max Length0
28. Task.extension:basedOn.value[x]:valueReference.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Max Length0
29. Task.modifierExtension
Definition

An Extension

Control0..*
TypeExtension
Is Modifiertrue
Max Length0
SlicingThis element introduces a set of slices on Task.modifierExtension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
30. Task.modifierExtension:doNotAutofill
SliceNamedoNotAutofill
Definition

A modifier extension that, if true, indicates that a task that would normally be interpretted as seeking the immediate fulfillment of a request is not seeking fulfillment, but is merely sharing the authoritative order. The fulfillment request will arrive by other means

Control0..1
TypeExtension(Task Do Not Auto-fill) (Extension Type: boolean)
Is Modifiertrue
Must Supporttrue
Max Length0
31. Task.identifier
Definition

The business identifier for this task.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Max Length0
32. Task.type
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1
BindingThe codes SHALL be taken from PrescriptionTaskType (20190315)
TypeCodeableConcept(Shared Health CodeableConcept Code)
Must Supporttrue
Comments

This will be a fixed code for each type of task. Review usage comments on child elements.

Max Length0
33. Task.type.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
34. Task.type.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
35. Task.type.coding
Definition

A reference to a code defined by a terminology system.

Control1..*
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Max Length0
SlicingThis element introduces a set of slices on Task.type.coding. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
36. Task.type.coding.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
37. Task.type.coding.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
38. Task.type.coding.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

This is the URI that represents the coding system as defined within the binding.

Max Length0
39. Task.type.coding.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
40. Task.type.coding.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments

This is the code as defined within the binding.

Max Length0
41. Task.type.coding.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
42. Task.type.coding.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
43. Task.type.coding:taskCode
SliceNametaskCode
Definition

A reference to a code defined by a terminology system.

Control1..*
TypeCoding
Must Supporttrue
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Max Length0
44. Task.type.coding:taskCode.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
45. Task.type.coding:taskCode.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
46. Task.type.coding:taskCode.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype

Max Length0
Fixed Valuehttps://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
47. Task.type.coding:taskCode.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
48. Task.type.coding:taskCode.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Comments

Fixed value: e163-m

Max Length0
Fixed Valuee163-m
49. Task.type.coding:taskCode.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
50. Task.type.coding:taskCode.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
51. Task.type.text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Control0..1
Typestring
Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

Max Length0
52. Task.description
Definition

A description of this task.

Control0..1
Typestring
Max Length0
53. Task.performerType
Definition

The type of participant that can execute the task.

Control0..*
BindingThe codes SHOULD be taken from TaskPerformerType The type(s) of task performers allowed

TypeCoding
Requirements

Use to distinguish tasks on different activity queues.

Max Length0
54. Task.priority
Definition

The priority of the task among other tasks of the same type.

Control0..1
BindingThe codes SHALL be taken from PrescriptionTaskPriority (20190415)
Typecode
Must Supporttrue
Requirements

Used to identify the service level expected while performing a task.

Comments

This element does not apply to Tasks p170-m (Pharmacist Adapt), p200-m (RX Dispense Notification), and p210-m (RX Dispense Cancel Notification)

Conformance Rule: If one of the medications within a group is a high priority, the EMR should present the entire renewal request (based on Group Identifier) as a high priority item within the queue.

Conformance Rule: For Tasks p141-m (Cancel RX Request Denied) and p143-m (Cancel RX Remaining Fills Revoked) the priority must be set to high.

Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber.

Max Length0
Meaning if MissingIf missing, this task should be performed with normal priority
55. Task.status
Definition

The current status of the task.

Control1..1 This element is affected by the following invariants: inv-2
BindingThe codes SHALL be taken from TaskStatus The current status of the task.

Typecode
Must Supporttrue
Requirements

These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks.

Comments

Fixed value: requested

Max Length0
Fixed Valuerequested
56. Task.failureReason
Definition

An explaination as to why this task failed.

Control0..1 This element is affected by the following invariants: inv-2
TypeCodeableConcept
Max Length0
57. Task.subject
Definition

The subject of the task.

Control1..1
TypeReference(PrescribeIT® Renewal Prescription)
Must Supporttrue
Requirements

Used to identify the thing to be done (not the beneficiary -- see for below).

Max Length0
58. Task.subject.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
59. Task.subject.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
60. Task.subject.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
Comments

Conformance Rule: This is the reference to the Medication Order resource id. This is not a business identifier. Example: value='MedicationOrder/[guid].'

Conformance Rule: The Medication Order reference must be for the Medication Order that is being Approved or Approved with Changes by the prescriber.

Max Length0
61. Task.subject.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Max Length0
62. Task.for
Definition

The entity who benefits from the performance of the service specified in the task (e.g., the patient).

Control1..1
TypeReference(Shared Health Patient)
Must Supporttrue
Requirements

Used to track tasks outstanding for a beneficiary. Do not use to track the task owner or creator (see owner and creator respectively).

Comments

Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)

Max Length0
63. Task.for.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
64. Task.for.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
65. Task.for.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
Comments

This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message

Max Length0
66. Task.for.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Max Length0
67. Task.definition
Definition

A reference to a formal or informal definition of the task.

Control0..1
Typeuri
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.

Max Length0
68. Task.created
Definition

The date and time this task was created.

Control1..1 This element is affected by the following invariants: inv-1
TypedateTime
Must Supporttrue
Requirements

Most often used along with lastUpdated to track duration of task to supporting monitoring and management.

Alternate NamesCreated Date
Comments

This indicates when the request was created. This will generally be the same as the date of message construction.

Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored.

Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'

Max Length0
InvariantsDefined on this element
created-full: Must be at least a full date. i.e. yyyy-mm-dd (: length()>=10)
69. Task.lastModified
Definition

The date and time of last modification to this task.

Control1..1 This element is affected by the following invariants: inv-1
TypedateTime
Must Supporttrue
Requirements

Used along with history to track task activity and time in a particular task state. This enables monitoring and management.

Alternate NamesUpdate Date
Comments

This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR.

Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'.

Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification.

Max Length0
InvariantsDefined on this element
lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd (: length()>=10)
70. Task.creator
Definition

The creator of the task.

Control1..1
TypeReference(Shared Health SAML Practitioner)
Must Supporttrue
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).

Alternate NamesInitiator, Author
Comments

This is who is submitting the task and asking for it be done.

In the context of all EMR message this will be the PrescribeIT® Prescriber that responsible for initiating or overseeing the clinical event in the message.

Max Length0
71. Task.creator.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
72. Task.creator.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
73. Task.creator.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
Comments

This is a reference to the originating prescriber Practitioner. This value will be returned from the Provider Registry Practitioner query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}'

Max Length0
74. Task.creator.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Max Length0
75. Task.owner
Definition

The owner of this task. The participant who can execute this task.

Control1..1
TypeReference(Shared Health - eRx Service Location)
Must Supporttrue
Requirements

Identifies who is expected to perform this task.

Alternate NamesPerformer, Executer
Comments

This is who is intended to receive/act on the task

Max Length0
76. Task.owner.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
77. Task.owner.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
78. Task.owner.reference
Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Control1..1 This element is affected by the following invariants: ref-1
Typestring
Must Supporttrue
Comments

This is a reference to the pharmacy Organization being responded to. This value should echo the Task.creator from the request task being responded to. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

Max Length0
79. Task.owner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
Typestring
Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Max Length0
80. Task.parent
Definition

Task that this particular task is part of.

Control0..1
TypeReference(Task)
Requirements

Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task).

Max Length0
81. Task.input
Definition

Inputs to the task.

Control0..1
TypeBackboneElement
Must Supporttrue
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.

Max Length0
SlicingThis element introduces a set of slices on Task.input. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • value @ name
82. Task.input.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
83. 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
84. 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Max Length0
85. Task.input.name
Definition

The name of the input parameter.

Control1..1
Typestring
Requirements

Inputs are named to enable task automation to bind data and pass it from one task to the next.

Max Length0
86. Task.input.value[x]
Definition

The value of the input parameter as a basic type.

Control1..1
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Task inputs can take any form.

Max Length0
87. Task.input:change
SliceNamechange
Definition

Inputs to the task.

Control1..1
TypeBackboneElement
Must Supporttrue
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.

Max Length0
88. Task.input:change.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
89. Task.input:change.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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
90. Task.input:change.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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Max Length0
91. Task.input:change.name
Definition

The name of the input parameter.

Control1..1
Typestring
Must Supporttrue
Requirements

Inputs are named to enable task automation to bind data and pass it from one task to the next.

Comments

Fixed value: change

Max Length0
Fixed Valuechange
92. Task.input:change.value[x]
Definition

This is a textual description of the changes, eg change. This would be a substantive change such as a change in dose, frequency or patient instructions, or a change of classification of drugs. This will be specified as needed and if included in the message, this should be displayed to the Pharmacist/Pharmacy Technician

Control1..1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Requirements

Task inputs can take any form.

Comments

Conformance Rule: EMR expected to call out a difference in dosing, if they notice a difference in the request, versus what is in the EMR. A difference in the quantity or number of refills does not constitute changes

Max Length0
93. Task.output
Definition

Outputs produced by the Task.

Control0..0
TypeBackboneElement
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.

Max Length0
94. Task.output.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
95. 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.

Control0..*
TypeExtension
Alternate Namesextensions, 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.

Max Length0
96. 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, 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.

Max Length0
97. Task.output.name
Definition

The name of the Output parameter.

Control1..1
Typestring
Requirements

Outputs are named to enable task automation to bind data and pass it from one task to the next.

Max Length0
98. Task.output.value[x]
Definition

The value of the Output parameter as a basic type.

Control1..1
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Task outputs can take any form.

Max Length0