3.85 StructureDefinition: Task p143-m - Cancel RX Remaining Fills Revoked
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/task-p143-m
The Cancel Responses are used to respond to the e140-m Cancel Request.
If a pharmacy responds with a Revoked, it is an indication that the pharmacy is not able to cancel the prescription based on previous actions taken, like one or more fills of the medication has been dispensed and provided to the patient. When the Prescriber receives this response, they cannot automatically cancel the medication on the patient’s chart.
The following diagram depicts the overall structure of a Task p143-m - Cancel RX Request Revoked 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.85.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..* | PrescribeIT® Response from PMS 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 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-p143-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p143-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-p143-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. The following scenarios provide further detail: Scenario 1) Single Task allowed within a Bundle: There are some business scenarios where a given task will be managed individually and only a single task is allowed in a bundle. This is true for the Adapt (p170) and the Pharmacist Prescribe (p190). Multiple tasks of the same type are not allowed, nor are any other task type. Scenario 2) Single Task is sent. For any task type, the source system may send a single task within the bundle. Scenario 3) In either scenario 1 or 2, the task will be assigned its own Group Identifier and will be handled as a group of one. Scenario 4) Bundle restricted to same task type only: There are cases when only tasks of the same type can be grouped together. This is true for the cancel request (e140), Dispense Notifications (p200), Cancel RX Dispense Notification (p210). In this scenario, no other task types are allowed within the bundle. Scenario 5) Same or Mixed Task Types within a single group: There are cases when either all the tasks within a group happen to have the same task type (p160) which are not necessary restricted due to 4 or certain task types that are different can be grouped together. This is true for new (e110) and renewal (e120) where these are part of the same prescription. Another scenario is that renewal responses (e161, e162, e163, e164) may be sent with an e110 and/or an e120. Scenario 6) In either scenario 4 and 5, the same Group Identifier must be assigned to the multiple tasks as they are all part of the same group. All task resources sharing a Group Identifier must be transmitted in the same message bundle and should be treated as a group by the receiving system. Scenario 7) The p160 task type can only be sent within it's own bundle. Multiple Group Identifiers within the same Bundle is not allowed. The Task.extension:groupIdentifier.valueIdentifier.system element will be an OID of the form [Vendor root].[Application instance node].3 expressed as a uri (e.g. urn:oid:1.2.3.4). The branch “.3” is appended to create a unique namespace for the Group Identifer. The Task.extension:groupIdentifier.valueIdentifier.value element will be assigned by the sending system and must be a unique business identifier. |
| extension (basedOn) | 1..1 | Task Order Based On | Definition: Identifies a request, plan or proposal that drove the creation of this task Comments: Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information. |
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| value[x] | 1..1 | Reference() {r} | Slice: Unordered, Closed by type:$this Definition: The 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 |
 value[x](valueReference) | 1..1 | Reference() {r} | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
 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: (1) For pharmacies that are currently uploading prescription information to a Provincial Drug Information System (DIS) using real time messaging the PMS must set the boolean flag accordingly based on the following: a. When replying with either Task 'p142-m - Cancel RX Request Approved' or 'p143-m - Cancel RX Remaining Fills Revoked' response, either set the boolean flag to 'true' when the corresponding prescription on the DIS has been updated (e.g. stopped, aborted, revoked, etc) OR set the boolean flag to 'false' when the corresponding prescription on the DIS has NOT been updated. b. When replying with Task 'p141-m - Cancel RX Request Denied' response, set the boolean flag to 'false'. (2) For non-real time messaging integration connections (e.g. AB Batch File), the PMS cannot update the prescription in the DIS and must set the boolean flag to FALSE for all cancel rx responses. (3) For jurisdictions that do not have a DIS connection, this extension(DISNotification) is not applicable and can be omitted or set to FALSE. Usage Rule: When the boolean flag is set to ‘false’, PrescribeIT® will update the DIS and will send the appropriate update message (i.e. C07.01 Stop Prescription for the Approved Cancel Response and C06.09 Revoke Dispense for the Revoke Remaining Refills Response) which is sent on behalf of the prescriber in the jurisdictions where this is applicable. Nothing will be sent when this value is 'false' on Task 'p141-m - Cancel RX Request Denied' response. |
| extension (reason) | 0..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 Cancel RX Remaining Fills Revoked. Text should be limited to no more than 240 characters. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Text Required | Slice: Unordered, Closed by type:$this 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. |
| 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" |
| value[x] | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Binding: PrescriptionCancelReason (20210401) (extensible) 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. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20190315) (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. |
| 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: p143-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: p143-m |
| priority | 1..1 | code | Binding: PrescriptionTaskPriority (20190415) (required) Fixed Value: high Definition: The priority of the task among other tasks of the same type. Comments: Fixed value: high |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. 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 whose cancel has had remaining fills revoked will point 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 Business 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: This provides the medication order identifier that the dispense is associated with Usage Note: In the context of p160 and p200, PMS's will populate this identifier value with the appropriate value Usage Note: In the context of p200, EMRs need to use this value to find the corresponding medication order in their local system in order to associate the incoming dispense it to. Usage Note: In the context of p160, EMRs can use either this value or the MedicationOrder.identifier:EMR-id to find the corresponding medication order in their local system which is related to the medication order which is asking to be renewed. 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" |
| value[x] | 1..1 | Shared Health Identifier | Slice: Unordered, Closed by type:$this Definition: The prescription identifier whose cancelation is being refused Comments: Conformance Rule: This is the MedicationOrder.identifier of the prescription that is being cancelled. This is considered to be the Prescription Identifier, as originally assigned by the EMR. Usage 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 for it be done. In the context of all PMS message this is the PrescribeIT® pharmacy that is responsible for initiating 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 responding pharmacy Organization. This value will be returned from the Provider Registry query. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/CPRID' |
| 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/CPRID' |
This structure is derived from PrescribeIT® Response from PMS Task
Summary
Mandatory: 12 elements (2 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 5 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required
- 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-reason
- 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 | 0..* | PrescribeIT® Response from PMS Task | Cancel RX Remaining fills revoked | |
 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-p143-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p143-m |
 extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-dis-notification | S | 0..1 | boolean | DIS Notification of Prescription Cancel? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification |
| ext-task-reason | S | 0..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 Text Required | Concept - reference to a terminology or just text |
| ext-task-request-reason | S | 0..1 | CodeableConcept | Task Request Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-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) (extensible) |
| 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: p143-m |
| priority | S | 1..1 | code | normal | high Fixed Value: high |
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: completed |
 subject | S | 1..1 | Reference(PrescribeIT® Prescription) {r} | Prescription whose cancel request has been partially successful |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-reference-identifier | S | 1..1 | Identifier | Referenced identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier |
| value[x] | S | 1..1 | Shared Health Identifier | Last prescription identifier |
| reference | 0..0 | |||
| input | 0..0 | |||
| output | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Response from PMS Task | Cancel RX Remaining fills revoked |
 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-p143-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p143-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-basedon | S | 1..1 | Reference() | 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" |
| value[x] | S | 1..1 | (Slice Definition) | e-Renewal request Slice: Unordered, Closed by type:$this |
| value[x]:valueReference | S | 1..1 | Reference() {r} | Value of extension |
| 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 |
| ext-task-reason | S | 0..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 |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
| 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" |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionCancelReason (20210401) (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 (20190315) (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 | Σ | 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: p143-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): The type(s) of task performers allowed | |
| priority | S | 1..1 | code | normal | high Binding: PrescriptionTaskPriority (20190415) (required) Fixed Value: high |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: completed |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {r} | Prescription whose cancel request has been partially successful |
| 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 | 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" |
| value[x] | S | 1..1 | (Slice Definition) | Last prescription identifier Slice: Unordered, Closed by type:$this |
| value[x]:valueIdentifier | 1..1 | Identifier | Value of extension | |
| 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..* | PrescribeIT® Response from PMS 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 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-p143-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p143-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-p143-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. The following scenarios provide further detail: Scenario 1) Single Task allowed within a Bundle: There are some business scenarios where a given task will be managed individually and only a single task is allowed in a bundle. This is true for the Adapt (p170) and the Pharmacist Prescribe (p190). Multiple tasks of the same type are not allowed, nor are any other task type. Scenario 2) Single Task is sent. For any task type, the source system may send a single task within the bundle. Scenario 3) In either scenario 1 or 2, the task will be assigned its own Group Identifier and will be handled as a group of one. Scenario 4) Bundle restricted to same task type only: There are cases when only tasks of the same type can be grouped together. This is true for the cancel request (e140), Dispense Notifications (p200), Cancel RX Dispense Notification (p210). In this scenario, no other task types are allowed within the bundle. Scenario 5) Same or Mixed Task Types within a single group: There are cases when either all the tasks within a group happen to have the same task type (p160) which are not necessary restricted due to 4 or certain task types that are different can be grouped together. This is true for new (e110) and renewal (e120) where these are part of the same prescription. Another scenario is that renewal responses (e161, e162, e163, e164) may be sent with an e110 and/or an e120. Scenario 6) In either scenario 4 and 5, the same Group Identifier must be assigned to the multiple tasks as they are all part of the same group. All task resources sharing a Group Identifier must be transmitted in the same message bundle and should be treated as a group by the receiving system. Scenario 7) The p160 task type can only be sent within it's own bundle. Multiple Group Identifiers within the same Bundle is not allowed. The Task.extension:groupIdentifier.valueIdentifier.system element will be an OID of the form [Vendor root].[Application instance node].3 expressed as a uri (e.g. urn:oid:1.2.3.4). The branch “.3” is appended to create a unique namespace for the Group Identifer. The Task.extension:groupIdentifier.valueIdentifier.value element will be assigned by the sending system and must be a unique business identifier. |
| extension (basedOn) | 1..1 | Task Order Based On | Definition: Identifies a request, plan or proposal that drove the creation of this task Comments: Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| value[x] | 1..1 | Reference() {r} | Slice: Unordered, Closed by type:$this Definition: The 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 |
| value[x] (valueReference) | 1..1 | Reference() {r} | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). |
| 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: (1) For pharmacies that are currently uploading prescription information to a Provincial Drug Information System (DIS) using real time messaging the PMS must set the boolean flag accordingly based on the following: a. When replying with either Task 'p142-m - Cancel RX Request Approved' or 'p143-m - Cancel RX Remaining Fills Revoked' response, either set the boolean flag to 'true' when the corresponding prescription on the DIS has been updated (e.g. stopped, aborted, revoked, etc) OR set the boolean flag to 'false' when the corresponding prescription on the DIS has NOT been updated. b. When replying with Task 'p141-m - Cancel RX Request Denied' response, set the boolean flag to 'false'. (2) For non-real time messaging integration connections (e.g. AB Batch File), the PMS cannot update the prescription in the DIS and must set the boolean flag to FALSE for all cancel rx responses. (3) For jurisdictions that do not have a DIS connection, this extension(DISNotification) is not applicable and can be omitted or set to FALSE. Usage Rule: When the boolean flag is set to ‘false’, PrescribeIT® will update the DIS and will send the appropriate update message (i.e. C07.01 Stop Prescription for the Approved Cancel Response and C06.09 Revoke Dispense for the Revoke Remaining Refills Response) which is sent on behalf of the prescriber in the jurisdictions where this is applicable. Nothing will be sent when this value is 'false' on Task 'p141-m - Cancel RX Request Denied' response. |
| extension (reason) | 0..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 Cancel RX Remaining Fills Revoked. Text should be limited to no more than 240 characters. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Text Required | Slice: Unordered, Closed by type:$this 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. |
| 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" |
| value[x] | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Binding: PrescriptionCancelReason (20210401) (extensible) 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. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20190315) (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. |
| 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: p143-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: p143-m |
| priority | 1..1 | code | Binding: PrescriptionTaskPriority (20190415) (required) Fixed Value: high Definition: The priority of the task among other tasks of the same type. Comments: Fixed value: high |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. 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 whose cancel has had remaining fills revoked will point 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 Business 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: This provides the medication order identifier that the dispense is associated with Usage Note: In the context of p160 and p200, PMS's will populate this identifier value with the appropriate value Usage Note: In the context of p200, EMRs need to use this value to find the corresponding medication order in their local system in order to associate the incoming dispense it to. Usage Note: In the context of p160, EMRs can use either this value or the MedicationOrder.identifier:EMR-id to find the corresponding medication order in their local system which is related to the medication order which is asking to be renewed. 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" |
| value[x] | 1..1 | Shared Health Identifier | Slice: Unordered, Closed by type:$this Definition: The prescription identifier whose cancelation is being refused Comments: Conformance Rule: This is the MedicationOrder.identifier of the prescription that is being cancelled. This is considered to be the Prescription Identifier, as originally assigned by the EMR. Usage 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 for it be done. In the context of all PMS message this is the PrescribeIT® pharmacy that is responsible for initiating 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 responding pharmacy Organization. This value will be returned from the Provider Registry query. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/CPRID' |
| 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/CPRID' |
This structure is derived from PrescribeIT® Response from PMS Task
Summary
Mandatory: 12 elements (2 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 5 elements
Prohibited: 3 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-text-required
- 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-reason
- 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
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | 0..* | PrescribeIT® Response from PMS Task | Cancel RX Remaining fills revoked | |
| 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-p143-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p143-m |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-dis-notification | S | 0..1 | boolean | DIS Notification of Prescription Cancel? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification |
| ext-task-reason | S | 0..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 Text Required | Concept - reference to a terminology or just text |
| ext-task-request-reason | S | 0..1 | CodeableConcept | Task Request Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-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) (extensible) |
| 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: p143-m |
| priority | S | 1..1 | code | normal | high Fixed Value: high |
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: completed |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {r} | Prescription whose cancel request has been partially successful |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-reference-identifier | S | 1..1 | Identifier | Referenced identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier |
| value[x] | S | 1..1 | Shared Health Identifier | Last prescription identifier |
| reference | 0..0 | |||
| input | 0..0 | |||
| output | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Response from PMS Task | Cancel RX Remaining fills revoked |
| 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-p143-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p143-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-basedon | S | 1..1 | Reference() | 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" |
| value[x] | S | 1..1 | (Slice Definition) | e-Renewal request Slice: Unordered, Closed by type:$this |
| value[x]:valueReference | S | 1..1 | Reference() {r} | Value of extension |
| 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 |
| ext-task-reason | S | 0..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 |
| value[x]:valueCodeableConcept | 1..1 | CodeableConcept | Value of extension | |
| 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" |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionCancelReason (20210401) (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 (20190315) (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 | Σ | 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: p143-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): The type(s) of task performers allowed | |
| priority | S | 1..1 | code | normal | high Binding: PrescriptionTaskPriority (20190415) (required) Fixed Value: high |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: completed |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {r} | Prescription whose cancel request has been partially successful |
| 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 | 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" |
| value[x] | S | 1..1 | (Slice Definition) | Last prescription identifier Slice: Unordered, Closed by type:$this |
| value[x]:valueIdentifier | 1..1 | Identifier | Value of extension | |
| 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.85.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Task.meta.tag | example | |
| Task.language | required | http://tools.ietf.org/html/bcp47 |
| Task.extension:requestReason.value[x] | extensible | PrescriptionCancelReason |
| Task.type | required | PrescriptionTaskType |
| Task.performerType | preferred | TaskPerformerType |
| Task.priority | required | Fixed Value: high |
| Task.status | required | Fixed Value: completed |
3.85.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 |