3.66 StructureDefinition: Task p142-m - Cancel RX Request Approved
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
The Cancel Responses are used to respond to the e140-m Cancel Request.
If a pharmacy responds with an Approved response, it is an indication to the Prescriber that the patient did not yet pick up the medication, and the Prescriber can confidently cancel the medication within the patient EMR profile.
The following diagram depicts the overall structure of a Task p142-m - Cancel RX Request Approved and the relationships between resources. Each box represents a resource that may be present in the message instance. The bolded text is the resource name. The profile name that is associated with the resource is also included.
Conformance rules specific to this task may exist. Refer to the Business Rules.
3.66.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 Response from PMS Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Task | 0..* | 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 requesting 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-p142-m-profile) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-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-p142-m |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (requisitionIdentifier) | 1..1 | Task Requisition ID | Definition: This is the common number that represents a paper order. It may be shared by multiple MedicationOrder, DeviceRequest and Task instances, 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. There are some business scenarios where a given task will be managed individually (eg cancel request). If a particular task is not part of a logical group, it will have its own requisition identifier (i.e. it will be handled as a group of 1). In other scenarios, the same requisition identifier is assigned to multiple tasks as they are considered to be part of a group. Example: medications that would be part of the same written paper Prescription or Renewal request will share the same Requisition Identifier. Usage Note: Tasks corresponding to different requisition identifiers may be present in the same Bundle. The recipient must take this into account when grouping content for display/actioning by requisition identifier. Suggested Structure: Assigned by the EMR; scoped by the application instance; this is an OID. An OID may be structured as Vendor.ApplicationInstance.RX#Branch Ext = Requisition Id. Conformance Rule: All task resources sharing a common requisition number must be transmitted in the same message bundle. Conformance Rule: All medication orders sharing the same requisition identifier in a renewal request must be viewed, managed and responded to together. Conformance Rule: Different task types can share a requisition identifier when a task was performed in the shared context of other tasks with the same requisition id. For example, medication 1 was discontinued in the same context that medication 2 was prescribed. Receiving systems SHOULD display/manage tasks that are part of the same requisition together when this is feasible. Conformance Rule: In the context of a 401 - Execute deferred (prescription) tasks from an EMR, this will map to the 'PrescribeIT™ RX ID' on the printed Patient Copy. Usage Note: Requisition ID would be used by PMS to establish which medications belong to the same prescription. |
| extension (basedOn) | 1..1 | Task Order Based On | Definition: Identifies a request, plan or proposal that drove the creation of this task Comments: Conformance Rule: The following child elements will convey the reference to the incoming request for which this response is based |
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
 valueReference | 1..1 | Reference() {r} | Definition: The business identifier of the request task that this task was created based on Comments: Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the task.id for the task being responded to |
 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: 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]) |
| extension (disnotification) | 0..1 | Task DIS Notification | Definition: Indicates that the DIS is notified of prescription cancellation Comments: Conformance Rule: PMSs must set this flag to true if they successfully notified the DIS of the cancellation. The element will be omitted if the applicable jurisdiction does not have a DIS. It is mandatory to include this element if the applicable jurisdiction has a DIS. Usage Note: In the case that the DIS notified flag is set to true PrescribeIT will not send a cancel message to the DIS. |
| url | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification" |
| valueBoolean | 1..1 | boolean | Definition: Indicates that the prescriber will not support renewals for this prescription Comments: Conformance Rule: If the PMS is not connected real time to the provincial DIS system then this flag must be set to ‘False’ for Task p141-m - Cancel RX Request Denied, Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked. Conformance Rule:If the PMS is connected real time to the provincial DIS system then this flag must be set as follows: a. For Task p141-m - Cancel RX Request Denied set the flag to ‘False’ as no changes should be done to the status of the prescription on the DIS. b. For Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked set the flag to ‘True’ when the PMS will be updating the status of the prescription on the DIS this includes the when the status has been updated or is in the process of been updated (queue later, exception handling etc). If the PMS is not updating or will not update the status of the prescription on the DIS then set this flag to ‘False’. |
| extension (requestReason) | 0..1 | Task Request Reason | Definition: Echoes the reason provided on the Task which this task is fulfilling Comments: Conformance Rule: This must echo the content of the 'task-reason' extension in the e140 Task this task is responding to. It simplifies the process of communicating the cancellation to any relevant Drug Information System (DIS) |
| url | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason" |
| valueCodeableConcept | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Binding: PrescriptionCancelReason (extensible) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Conformance Rule: The application generating this message must provide the required Terminology Binding coding elements, including the valueCodeableConcept.coding.system, the valueCodeableConcept.coding.code, and the valueCodeableConcept.coding.display. If a user provides a free text description above and beyond the coded value, this free text description should be provided in the valueCodeableConcept.text element |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (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: |
 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). |
| 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: p142-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: p142-m |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (required) Definition: The priority of the task among other tasks of the same type. Comments: This element does not apply to either Task p200-m - RX Dispense Notification or Task p210-m - RX Dispense Cancel Notification Conformance Rule: If one of the medications within a requisition is a high priority, the EMR should present the entire renewal request (based on requisision.id) as a high priority item within the queue. Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber. |
| status | 1..1 | code | Binding: TaskStatus (required) Fixed Value: completed Definition: The current status of the task. Comments: Fixed value: completed |
| subject | 1..1 | Reference(PrescribeIT Prescription) {r} | Definition: The subject of the task. Comments: Conformance Rule: The 'reference' element will not be used. Instead, the prescription being cancelled will pointed to indirectly by business identifier using the extension below. |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (identifier) | 1..1 | Referenced Requisition identifier | Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted 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. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| valueIdentifier | 1..1 | Shared Health Identifier | Definition: The prescription number whose renewal is being accepted Comments: Conformance Rule: This is the MedicationOrder. identifier for the prescription that is being cancelled. This is considered to be the Prescription Identifier, as originally assigned by the EMR. Usage Note: Note, the Medication Order resource is not included in the message instance, just the identifier |
| 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 | created-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 - eRx Service Location) {b} | Definition: The creator of the task. Comments: This is who is submitting the task and asking it be done |
| 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 responding pharmacy Organization. This value will be returned from the Provider Registry query. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/2263396629' |
| owner | 1..1 | Reference(Shared Health Practitioner) {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 prescriber Practitioner being responded to. This value should echo the Task.creator from the request task being responded to. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Practitioner/2263396629' |
This structure is derived from PrescribeIT Response from PMS Task
Summary
Mandatory: 11 elements (1 nested mandatory element)
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://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
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 Response from PMS Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Task | SI | 0..* | Cancel RX Request Approved | |
 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Σ | uri | Profiles this resource claims to conform to Slice: Unordered, Open by value:value | |
| profile | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example) |
| 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) | |
| text | I | 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-requisition-id | S | 1..1 | Shared Health Identifier | Prescription Number URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-requisition-id |
| ext-task-basedon | S | 1..1 | Reference(PrescribeIT™ base Task profile) {r} | Plan, request or referral URL: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-basedon |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
 valueReference | S | 1..1 | Reference() {r} | e-Renewal request |
| 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 |
| ext-task-dis-notification | S | 0..1 | boolean | DIS Notification of Prescription Cancel? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification" |
| valueBoolean | S | 1..1 | boolean | No Prescription Renewals? |
| ext-task-request-reason | S | 0..1 | CodeableConcept | Task Request Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason" |
| valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionCancelReason (extensible) |
 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 (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | Coding | Code defined by a terminology system Slice: Unordered, Open by value: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 | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| 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 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: p142-m |
| display | Σ | 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) | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required) Fixed Value: completed |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT Prescription) {r} | Prescription that has been cancelled |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-reference-identifier | S | 1..1 | Shared Health Identifier | Referenced identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| valueIdentifier | S | 1..1 | Shared Health Identifier | Last prescription number |
| reference | ΣI | 0..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 created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | S | 1..1 | Reference(Shared Health - eRx Service Location) {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 Practitioner) {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 Response from PMS Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Task | 0..* | 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 requesting 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-p142-m-profile) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-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-p142-m |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (requisitionIdentifier) | 1..1 | Task Requisition ID | Definition: This is the common number that represents a paper order. It may be shared by multiple MedicationOrder, DeviceRequest and Task instances, 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. There are some business scenarios where a given task will be managed individually (eg cancel request). If a particular task is not part of a logical group, it will have its own requisition identifier (i.e. it will be handled as a group of 1). In other scenarios, the same requisition identifier is assigned to multiple tasks as they are considered to be part of a group. Example: medications that would be part of the same written paper Prescription or Renewal request will share the same Requisition Identifier. Usage Note: Tasks corresponding to different requisition identifiers may be present in the same Bundle. The recipient must take this into account when grouping content for display/actioning by requisition identifier. Suggested Structure: Assigned by the EMR; scoped by the application instance; this is an OID. An OID may be structured as Vendor.ApplicationInstance.RX#Branch Ext = Requisition Id. Conformance Rule: All task resources sharing a common requisition number must be transmitted in the same message bundle. Conformance Rule: All medication orders sharing the same requisition identifier in a renewal request must be viewed, managed and responded to together. Conformance Rule: Different task types can share a requisition identifier when a task was performed in the shared context of other tasks with the same requisition id. For example, medication 1 was discontinued in the same context that medication 2 was prescribed. Receiving systems SHOULD display/manage tasks that are part of the same requisition together when this is feasible. Conformance Rule: In the context of a 401 - Execute deferred (prescription) tasks from an EMR, this will map to the 'PrescribeIT™ RX ID' on the printed Patient Copy. Usage Note: Requisition ID would be used by PMS to establish which medications belong to the same prescription. |
| extension (basedOn) | 1..1 | Task Order Based On | Definition: Identifies a request, plan or proposal that drove the creation of this task Comments: Conformance Rule: The following child elements will convey the reference to the incoming request for which this response is based |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| valueReference | 1..1 | Reference() {r} | Definition: The business identifier of the request task that this task was created based on Comments: Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the task.id for the task being responded to |
| 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: 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]) |
| extension (disnotification) | 0..1 | Task DIS Notification | Definition: Indicates that the DIS is notified of prescription cancellation Comments: Conformance Rule: PMSs must set this flag to true if they successfully notified the DIS of the cancellation. The element will be omitted if the applicable jurisdiction does not have a DIS. It is mandatory to include this element if the applicable jurisdiction has a DIS. Usage Note: In the case that the DIS notified flag is set to true PrescribeIT will not send a cancel message to the DIS. |
| url | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification" |
| valueBoolean | 1..1 | boolean | Definition: Indicates that the prescriber will not support renewals for this prescription Comments: Conformance Rule: If the PMS is not connected real time to the provincial DIS system then this flag must be set to ‘False’ for Task p141-m - Cancel RX Request Denied, Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked. Conformance Rule:If the PMS is connected real time to the provincial DIS system then this flag must be set as follows: a. For Task p141-m - Cancel RX Request Denied set the flag to ‘False’ as no changes should be done to the status of the prescription on the DIS. b. For Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked set the flag to ‘True’ when the PMS will be updating the status of the prescription on the DIS this includes the when the status has been updated or is in the process of been updated (queue later, exception handling etc). If the PMS is not updating or will not update the status of the prescription on the DIS then set this flag to ‘False’. |
| extension (requestReason) | 0..1 | Task Request Reason | Definition: Echoes the reason provided on the Task which this task is fulfilling Comments: Conformance Rule: This must echo the content of the 'task-reason' extension in the e140 Task this task is responding to. It simplifies the process of communicating the cancellation to any relevant Drug Information System (DIS) |
| url | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason" |
| valueCodeableConcept | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Binding: PrescriptionCancelReason (extensible) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: Conformance Rule: The application generating this message must provide the required Terminology Binding coding elements, including the valueCodeableConcept.coding.system, the valueCodeableConcept.coding.code, and the valueCodeableConcept.coding.display. If a user provides a free text description above and beyond the coded value, this free text description should be provided in the valueCodeableConcept.text element |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (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: |
| 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). |
| 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: p142-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: p142-m |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (required) Definition: The priority of the task among other tasks of the same type. Comments: This element does not apply to either Task p200-m - RX Dispense Notification or Task p210-m - RX Dispense Cancel Notification Conformance Rule: If one of the medications within a requisition is a high priority, the EMR should present the entire renewal request (based on requisision.id) as a high priority item within the queue. Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber. |
| status | 1..1 | code | Binding: TaskStatus (required) Fixed Value: completed Definition: The current status of the task. Comments: Fixed value: completed |
| subject | 1..1 | Reference(PrescribeIT Prescription) {r} | Definition: The subject of the task. Comments: Conformance Rule: The 'reference' element will not be used. Instead, the prescription being cancelled will pointed to indirectly by business identifier using the extension below. |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (identifier) | 1..1 | Referenced Requisition identifier | Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted 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. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| valueIdentifier | 1..1 | Shared Health Identifier | Definition: The prescription number whose renewal is being accepted Comments: Conformance Rule: This is the MedicationOrder. identifier for the prescription that is being cancelled. This is considered to be the Prescription Identifier, as originally assigned by the EMR. Usage Note: Note, the Medication Order resource is not included in the message instance, just the identifier |
| 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 | created-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 - eRx Service Location) {b} | Definition: The creator of the task. Comments: This is who is submitting the task and asking it be done |
| 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 responding pharmacy Organization. This value will be returned from the Provider Registry query. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/2263396629' |
| owner | 1..1 | Reference(Shared Health Practitioner) {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 prescriber Practitioner being responded to. This value should echo the Task.creator from the request task being responded to. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Practitioner/2263396629' |
This structure is derived from PrescribeIT Response from PMS Task
Summary
Mandatory: 11 elements (1 nested mandatory element)
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://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-identifier
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason
- http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
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 Response from PMS Task
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | SI | 0..* | Cancel RX Request Approved | |
| 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Σ | uri | Profiles this resource claims to conform to Slice: Unordered, Open by value:value | |
| profile | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example) |
| 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) | |
| text | I | 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-requisition-id | S | 1..1 | Shared Health Identifier | Prescription Number URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-requisition-id |
| ext-task-basedon | S | 1..1 | Reference(PrescribeIT™ base Task profile) {r} | Plan, request or referral URL: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-basedon |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| valueReference | S | 1..1 | Reference() {r} | e-Renewal request |
| 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 |
| ext-task-dis-notification | S | 0..1 | boolean | DIS Notification of Prescription Cancel? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification" |
| valueBoolean | S | 1..1 | boolean | No Prescription Renewals? |
| ext-task-request-reason | S | 0..1 | CodeableConcept | Task Request Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason" |
| valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionCancelReason (extensible) |
| 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 (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | Coding | Code defined by a terminology system Slice: Unordered, Open by value: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 | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| 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 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: p142-m |
| display | Σ | 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) | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required) Fixed Value: completed |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT Prescription) {r} | Prescription that has been cancelled |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-reference-identifier | S | 1..1 | Shared Health Identifier | Referenced identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| valueIdentifier | S | 1..1 | Shared Health Identifier | Last prescription number |
| reference | ΣI | 0..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 created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | S | 1..1 | Reference(Shared Health - eRx Service Location) {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 Practitioner) {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.66.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Task.meta.security | All Security Labels | extensible | All Security Labels |
| Task.meta.tag | ?ext | example | |
| Task.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Task.extension.valueCodeableConcept | PrescriptionCancelReason | extensible | PrescriptionCancelReason |
| Task.type | PrescriptionTaskType | required | PrescriptionTaskType |
| Task.performerType | TaskPerformerType | preferred | TaskPerformerType |
| Task.priority | PrescriptionTaskPriority | required | PrescriptionTaskPriority |
| Task.status | TaskStatus | required | TaskStatus |
3.66.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 | |
| created-full | Task.lastModified | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 |