3.50.6 StructureDefinition: PrescribeIT® base Task profile - Detailed Descriptions
Definitions for the profile-task Profile.
1. Task | |
Definition | A task to be performed. |
Control | 0..* |
Max Length | 0 |
Invariants | Defined 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. |
Control | 1..1 |
Type | id |
Must Support | true |
Comments | Usage Note: This will usually be a GUID and is assigned by the requesting application. |
Max Length | 0 |
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. |
Control | 1..1 |
Type | Meta |
Must Support | true |
Max Length | 0 |
4. Task.meta.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
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. |
Control | 0..1 |
Type | id |
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 Length | 0 |
7. Task.meta.lastUpdated | |
Definition | When the resource last changed - e.g. when the version changed. |
Control | 0..1 |
Type | instant |
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 Length | 0 |
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. |
Control | 1..* |
Type | uri |
Must Support | true |
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 Length | 0 |
9. Task.meta.security | |
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. |
Control | 0..0 |
Binding | The 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. |
Type | Coding |
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 Length | 0 |
10. 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. |
Control | 0..* |
Binding | Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
Type | Coding |
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 Length | 0 |
11. Task.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Max Length | 0 |
12. Task.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | The codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language. |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Max Length | 0 |
13. Task.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Max Length | 0 |
14. Task.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
Max Length | 0 |
15. Task.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
Max Length | 0 |
Slicing | This element introduces a set of slices on Task.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
16. Task.extension:groupIdentifier | |
SliceName | groupIdentifier |
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 |
Control | 1..1 |
Type | Extension(Task Group Identifier) (Extension Type: Identifier) |
Must Support | true |
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 Length | 0 |
17. Task.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
18. Task.identifier | |
Definition | The business identifier for this task. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Max Length | 0 |
19. Task.type | |
Definition | A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. |
Control | 1..1 |
Binding | The codes SHALL be taken from PrescriptionTaskType (20190315) |
Type | CodeableConcept(Shared Health CodeableConcept Code) |
Must Support | true |
Comments | This will be a fixed code for each type of task. Review usage comments on child elements. |
Max Length | 0 |
20. Task.description | |
Definition | A description of this task. |
Control | 0..1 |
Type | string |
Max Length | 0 |
21. Task.performerType | |
Definition | The type of participant that can execute the task. |
Control | 0..* |
Binding | The codes SHOULD be taken from TaskPerformerType The type(s) of task performers allowed |
Type | Coding |
Requirements | Use to distinguish tasks on different activity queues. |
Max Length | 0 |
22. Task.priority | |
Definition | The priority of the task among other tasks of the same type. |
Control | 0..1 |
Binding | The codes SHALL be taken from PrescriptionTaskPriority (20190415) |
Type | code |
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 Length | 0 |
Meaning if Missing | If missing, this task should be performed with normal priority |
23. Task.status | |
Definition | The current status of the task. |
Control | 1..1 This element is affected by the following invariants: inv-2 |
Binding | The codes SHALL be taken from TaskStatus The current status of the task. |
Type | code |
Must Support | true |
Requirements | These states enable coordination of task status with off-the-shelf workflow solutions that support automation of tasks. |
Comments | This will be fixed based on the task code being used as the architecture calls for different tasks for each state rather than updating of existing tasks. |
Max Length | 0 |
24. Task.failureReason | |
Definition | An explaination as to why this task failed. |
Control | 0..1 This element is affected by the following invariants: inv-2 |
Type | CodeableConcept |
Max Length | 0 |
25. Task.subject | |
Definition | The subject of the task. |
Control | 0..1 |
Type | Reference(Resource) |
Must Support | true |
Requirements | Used to identify the thing to be done (not the beneficiary -- see for below). |
Max Length | 0 |
26. Task.for | |
Definition | The entity who benefits from the performance of the service specified in the task (e.g., the patient). |
Control | 1..1 |
Type | Reference(Shared Health Patient) |
Must Support | true |
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 Length | 0 |
27. Task.for.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
28. 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. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
29. 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. |
Control | 1..1 This element is affected by the following invariants: ref-1 |
Type | string |
Must Support | true |
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 Length | 0 |
30. Task.for.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 |
Type | string |
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 Length | 0 |
31. Task.definition | |
Definition | A reference to a formal or informal definition of the task. |
Control | 0..1 |
Type | uri |
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 Length | 0 |
32. Task.created | |
Definition | The date and time this task was created. |
Control | 1..1 This element is affected by the following invariants: inv-1 |
Type | dateTime |
Must Support | true |
Requirements | Most often used along with lastUpdated to track duration of task to supporting monitoring and management. |
Alternate Names | Created 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 Length | 0 |
Invariants | Defined on this element created-full: Must be at least a full date. i.e. yyyy-mm-dd (: length()>=10) |
33. Task.lastModified | |
Definition | The date and time of last modification to this task. |
Control | 1..1 This element is affected by the following invariants: inv-1 |
Type | dateTime |
Must Support | true |
Requirements | Used along with history to track task activity and time in a particular task state. This enables monitoring and management. |
Alternate Names | Update Date |
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 Length | 0 |
Invariants | Defined on this element created-full: Must be at least a full date. i.e. yyyy-mm-dd (: length()>=10) |
34. Task.creator | |
Definition | The creator of the task. |
Control | 1..1 |
Type | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
Must Support | true |
Must Support Types | No must-support rules about the choice of types/profiles |
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 Names | Initiator, Author |
Comments | This is who is submitting the task and asking it be done |
Max Length | 0 |
35. Task.owner | |
Definition | The owner of this task. The participant who can execute this task. |
Control | 0..1 |
Type | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) |
Requirements | Identifies who is expected to perform this task. |
Alternate Names | Performer, Executer |
Comments | This is who is intended to receive/act on the task |
Max Length | 0 |
36. Task.parent | |
Definition | Task that this particular task is part of. |
Control | 0..1 |
Type | Reference(Task) |
Requirements | Allows tasks to be broken down into sub-steps (and this division can occur independent of the original task). |
Max Length | 0 |
37. Task.input | |
Definition | Inputs to the task. |
Control | 0..* |
Type | BackboneElement |
Requirements | Resources and data used to perform the task. This data is used in the business logic of task execution, and is stored separately because it varies between workflows. |
Max Length | 0 |
38. Task.input.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
39. Task.input.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
40. Task.input.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
41. Task.input.name | |
Definition | The name of the input parameter. |
Control | 1..1 |
Type | string |
Requirements | Inputs are named to enable task automation to bind data and pass it from one task to the next. |
Max Length | 0 |
42. Task.input.value[x] | |
Definition | The value of the input parameter as a basic type. |
Control | 1..1 |
Type | Choice 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] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Task inputs can take any form. |
Max Length | 0 |
43. Task.output | |
Definition | Outputs produced by the Task. |
Control | 0..* |
Type | BackboneElement |
Requirements | Resources and data produced during the execution the task. This data is generated by the business logic of task execution, and is stored separately because it varies between workflows. |
Max Length | 0 |
44. Task.output.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Max Length | 0 |
45. Task.output.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
46. Task.output.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Max Length | 0 |
47. Task.output.name | |
Definition | The name of the Output parameter. |
Control | 1..1 |
Type | string |
Requirements | Outputs are named to enable task automation to bind data and pass it from one task to the next. |
Max Length | 0 |
48. Task.output.value[x] | |
Definition | The value of the Output parameter as a basic type. |
Control | 1..1 |
Type | Choice 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] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | Task outputs can take any form. |
Max Length | 0 |