3.110 StructureDefinition: Task e140-m - Cancel RX Fill Request
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/task-e140-m
The Cancel RX Fill Request can be used to cancel any type of directed EMR prescription (New, Renew, Approved or Approved with changes). It cannot be used for any other type of task that is created by the EMR (i.e. deferred, held prescriptions, Deny or under review responses, discontinue) or any PMS tasks.
This is typically issued when an error has occurred and the prescriber wants the prescription to be cancelled and not to be filled by the pharmacy. Once the pharmacy receives the cancel request they must respond with how the cancellation was actioned which includes accepting the cancelling, revoking the remaining refills or denying the cancellation.
The following diagram depicts the overall structure of Task e140-m - Cancel RX Fill Request or Renewal RX Drug Fill Request and the relationships among other relevant resources. The diagrams are only showing the possible types of resources but that the GridView reflects the true relationships.
Conformance Rules and Usage Notes specific to this task may exist.
3.110.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from PrescribeIT® Request from EMR Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Task | 0..* | PrescribeIT® Request from EMR Task | inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. Definition: A task to be performed. |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. |
| meta | 1..1 | 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. |
 profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. 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. |
 profile(task-e140-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (groupIdentifier) | 1..1 | Task Group Identifier | 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 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. Refer to the PrescribeIT® Version 5.0 Jurisdictional Rules and Task Grouping Excel spreadsheet rules for a full set of scenarios. |
| extension (reason) | 1..1 | Task Reason | Definition: Indicates the reason for the current task's status or existence - used for reasons other than 'failed' Comments: Conformance Rule: This will contain the reason for the cancellation |
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Slice: Unordered, Closed by type:$this Binding: PrescriptionCancelReason (20210401) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
 value[x](valueCodeableConcept) | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
 coding | 1..* | Coding | Definition: A reference to a code defined by a terminology system. 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. |
 system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | 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). Comments: This is the code as defined within the binding. |
| display | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| text | 0..1 | string | Max Length: 2500 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. Comments: Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20220913) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. 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. |
 system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | 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). Comments: This is the code as defined within the binding. |
 display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| coding (taskCode) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. 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. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | 1..1 | code | Fixed Value: e140-m 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). Comments: Fixed value: e140-m |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (20190415) (required) Definition: The priority of the task among other tasks of the same type. 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. Usage Note: For Task e150-m (Discontinue RX Request) the priority should default to normal. |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. Fixed Value: requested Definition: The current status of the task. Comments: Fixed value: requested |
| subject | 1..1 | Reference(PrescribeIT® Prescription) {b} | Definition: A reference from one resource to another. |
| reference | 1..1 | string | 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. Comments: This is the reference to the MedicationOrder.id assigned by the Sending system. This is not a business identifier. Example: value='MedicationOrder/[guid]. |
| for | 1..1 | Reference(Shared Health Patient) {b} | Definition: The entity who benefits from the performance of the service specified in the task (e.g., the patient). 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) |
| reference | 1..1 | string | 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. 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 |
| created | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time this task was created. 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' |
| lastModified | 1..1 | dateTime | lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time of last modification to this task. 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. |
| creator | 1..1 | Reference(Shared Health SAML Practitioner) {b} | Definition: The creator of the task. 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. |
| reference | 1..1 | string | 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. 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}' |
| owner | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Definition: The owner of this task. The participant who can execute this task. Comments: This is who is intended to receive/act on the task |
| reference | 1..1 | string | 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. Comments: This is a reference to the pharmacy Organization being requested to act. This value will be returned from the Provider Registry query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}' |
This structure is derived from PrescribeIT® Request from EMR Task
Summary
Mandatory: 13 elements
Must-Support: 16 elements
Fixed Value: 4 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Task.meta.profile is sliced based on the value of value:value
- The element Task.type.coding is sliced based on the value of value:system
This structure is derived from PrescribeIT® Request from EMR Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Task | 0..* | PrescribeIT® Request from EMR Task | Cancel RX Fill Request | |
 meta | S | 1..1 | Meta | Metadata about the resource |
 profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
 profile:task-e140-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m |
 extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
 value[x] | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionCancelReason (20210401) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| coding | S | 1..* | Coding | Code defined by a terminology system |
| display | S | 1..1 | string | Representation defined by the system |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text |
| coding | S | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:taskCode | S | 1..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: e140-m |
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: requested |
 subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription being cancelled |
| input | 0..0 | |||
| output | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Request from EMR Task | Cancel RX Fill Request |
 id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:task-e140-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-group-identifier | S | 1..1 | Shared Health Identifier | Group Identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | S | 1..1 | (Slice Definition) | Concept - reference to a terminology or just text Slice: Unordered, Closed by type:$this Binding: PrescriptionCancelReason (20210401) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..1 | Identifier | Task Instance Identifier | |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20220913) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:All Slices | Content/Rules for all slices | |||
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:taskCode | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: e140-m |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (20190415) (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: requested |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription being cancelled |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| for | SΣ | 1..1 | Reference(Shared Health Patient) {b} | Beneficiary of the Task |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| definition | Σ | 0..1 | uri | Task Definition |
| created | SI | 1..1 | dateTime | Task Creation Date created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| lastModified | SΣI | 1..1 | dateTime | Task Last Modified Date lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | S | 1..1 | Reference(Shared Health SAML Practitioner) {b} | Task requestor |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| owner | S | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Task recipient |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| parent | 0..1 | Reference(Task) | Composite task | |
| Documentation for this format | ||||
Grid View
This structure is derived from PrescribeIT® Request from EMR Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Task | 0..* | PrescribeIT® Request from EMR Task | inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. Definition: A task to be performed. |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. |
| meta | 1..1 | 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. |
| profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. 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. |
| profile (task-e140-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (groupIdentifier) | 1..1 | Task Group Identifier | 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 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. Refer to the PrescribeIT® Version 5.0 Jurisdictional Rules and Task Grouping Excel spreadsheet rules for a full set of scenarios. |
| extension (reason) | 1..1 | Task Reason | Definition: Indicates the reason for the current task's status or existence - used for reasons other than 'failed' Comments: Conformance Rule: This will contain the reason for the cancellation |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Slice: Unordered, Closed by type:$this Binding: PrescriptionCancelReason (20210401) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| value[x] (valueCodeableConcept) | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
| coding | 1..* | Coding | Definition: A reference to a code defined by a terminology system. 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. |
| system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | 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). Comments: This is the code as defined within the binding. |
| display | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| text | 0..1 | string | Max Length: 2500 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. Comments: Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20220913) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. 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. |
| system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | 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). Comments: This is the code as defined within the binding. |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| coding (taskCode) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. 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. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | 1..1 | code | Fixed Value: e140-m 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). Comments: Fixed value: e140-m |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (20190415) (required) Definition: The priority of the task among other tasks of the same type. 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. Usage Note: For Task e150-m (Discontinue RX Request) the priority should default to normal. |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. Fixed Value: requested Definition: The current status of the task. Comments: Fixed value: requested |
| subject | 1..1 | Reference(PrescribeIT® Prescription) {b} | Definition: A reference from one resource to another. |
| reference | 1..1 | string | 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. Comments: This is the reference to the MedicationOrder.id assigned by the Sending system. This is not a business identifier. Example: value='MedicationOrder/[guid]. |
| for | 1..1 | Reference(Shared Health Patient) {b} | Definition: The entity who benefits from the performance of the service specified in the task (e.g., the patient). 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) |
| reference | 1..1 | string | 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. 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 |
| created | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time this task was created. 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' |
| lastModified | 1..1 | dateTime | lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time of last modification to this task. 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. |
| creator | 1..1 | Reference(Shared Health SAML Practitioner) {b} | Definition: The creator of the task. 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. |
| reference | 1..1 | string | 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. 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}' |
| owner | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Definition: The owner of this task. The participant who can execute this task. Comments: This is who is intended to receive/act on the task |
| reference | 1..1 | string | 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. Comments: This is a reference to the pharmacy Organization being requested to act. This value will be returned from the Provider Registry query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}' |
This structure is derived from PrescribeIT® Request from EMR Task
Summary
Mandatory: 13 elements
Must-Support: 16 elements
Fixed Value: 4 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-reference
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element Task.meta.profile is sliced based on the value of value:value
- The element Task.type.coding is sliced based on the value of value:system
Differential View
This structure is derived from PrescribeIT® Request from EMR Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | 0..* | PrescribeIT® Request from EMR Task | Cancel RX Fill Request | |
| meta | S | 1..1 | Meta | Metadata about the resource |
| profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:task-e140-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionCancelReason (20210401) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| coding | S | 1..* | Coding | Code defined by a terminology system |
| display | S | 1..1 | string | Representation defined by the system |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text |
| coding | S | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:taskCode | S | 1..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: e140-m |
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: requested |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription being cancelled |
| input | 0..0 | |||
| output | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Request from EMR Task | Cancel RX Fill Request |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:task-e140-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e140-m |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-group-identifier | S | 1..1 | Shared Health Identifier | Group Identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | S | 1..1 | (Slice Definition) | Concept - reference to a terminology or just text Slice: Unordered, Closed by type:$this Binding: PrescriptionCancelReason (20210401) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..1 | Identifier | Task Instance Identifier | |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20220913) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:All Slices | Content/Rules for all slices | |||
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:taskCode | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: e140-m |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (20190415) (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: requested |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription being cancelled |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| for | SΣ | 1..1 | Reference(Shared Health Patient) {b} | Beneficiary of the Task |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| definition | Σ | 0..1 | uri | Task Definition |
| created | SI | 1..1 | dateTime | Task Creation Date created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| lastModified | SΣI | 1..1 | dateTime | Task Last Modified Date lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | S | 1..1 | Reference(Shared Health SAML Practitioner) {b} | Task requestor |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| owner | S | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Task recipient |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| parent | 0..1 | Reference(Task) | Composite task | |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.110.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Task.meta.tag | example | |
| Task.language | required | http://tools.ietf.org/html/bcp47 |
| Task.extension:reason.value[x] | required | PrescriptionCancelReason |
| Task.type | required | PrescriptionTaskType |
| Task.performerType | preferred | TaskPerformerType |
| Task.priority | required | PrescriptionTaskPriority |
| Task.status | required | Fixed Value: requested |
3.110.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| inv-2 | Task | A Failure reason may be present only when a task has failed. : failureReason.empty() or status = 'failed' | |
| inv-1 | Task | Last modified date must be greater than or equal to created date. : lastModified >= created | |
| created-full | Task.created | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 | |
| lastModified-full | Task.lastModified | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 |