PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

http://prescribeit.ca/fhir/StructureDefinition/task-p141-m

The Cancel RX Request Denied, Revoke and Approved messages are used to respond to the e140-m Cancel. If a pharmacy responds with an Approved, 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 Revoke message is used when the patient has received the medication; the pharmacy will revoke/cancel all future dispenses.

The Denied response is sent by the pharmacy if the cancellation cannot be processed. The only known situation for this is when the prescription has been transferred. The Prescriber will be notified through this message and can determine if they need to contact the patient, or take further action with the pharmacy who now has the prescription.

The following diagram depicts the overall structure of a Task – p141-m Cancel RX Request Denied and the relationships between resources. The diagrams are only showing the possible types of resources but that the GridView reflects the true relationships.

Conformance Rules and Usage Notes specific to this task may exist.

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

>

This structure is derived from PrescribeIT® Response from PMS Task

NameCard.TypeConstraints and Usage
.  Task 0..*PrescribeIT® Response from PMS Taskinv-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..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


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

..  meta 1..1MetaDefinition:
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..*uriSlice: 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-p141-m)
1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p141-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-p141-m

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

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


Comments:
Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. Refer to the PrescribeIT® Version 5.0 Jurisdictional Rules and Task Grouping Excel spreadsheet rules for a full set of scenarios.

..  extension
     (basedOn)
1..1Task Order Based OnDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
...  value[x] 1..1Reference() {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..1Reference() {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..1stringDefinition:
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)
1..1Task DIS NotificationDefinition:
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.

...  url 1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification"
...  value[x] 1..1booleanFixed Value: false
Definition:
Indicates that the prescriber will not support renewals for this prescription


Comments:
Fixed value: false

..  extension
     (reason)
1..1Task ReasonDefinition:
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 refusal

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
...  value[x] 1..1Shared Health CodeableConceptSlice: Unordered, Closed by type:$this
Binding: PrescriptionCancelRejectReason (20190415) (extensible)
inv-1: Must have coding, text or both
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


..  type 1..1Shared Health CodeableConcept CodeBinding: PrescriptionTaskType (20220913) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


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

...  coding 1..*CodingSlice: 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..1uriDefinition:
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..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  coding
       (taskCode)
1..*CodingDefinition:
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..1uriFixed 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..1codeFixed Value: p141-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: p141-m

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

..  priority 1..1codeBinding: 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..1codeBinding: TaskStatus (required): The current status of the task.


Fixed Value: rejected
Definition:
The current status of the task.


Comments:
Fixed value: rejected

..  subject 1..1Reference(PrescribeIT® Prescription) {r}Definition:
The subject of the task.


Comments:
Conformance Rule: The 'reference' element will not be used. Instead, the prescription whose cancel is being denied will point to indirectly by business identifier using the extension below.

...  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

...  extension
       (identifier)
1..1Referenced Business identifierDefinition:
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 cancel response is associated with



Usage Note: In the context of p141, p142, and p143, this provides the medication order identifier that the cancel response is associated with



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..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
....  value[x] 1..1PrescribeIT® Prescriber Prescription IdentifierSlice: 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..1Reference(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..1stringDefinition:
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..1dateTimecreated-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..1dateTimelastModified-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..1Reference(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..1stringDefinition:
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}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

..  owner 1..1Reference(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..1stringDefinition:
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}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}'

This structure is derived from PrescribeIT® Response from PMS Task

Summary

Mandatory: 16 elements
Must-Support: 19 elements
Fixed Value: 6 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Task.meta.profile is sliced based on the value of value:value
  • The element Task.type.coding is sliced based on the value of value:system

This structure is derived from PrescribeIT® Response from PMS Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*PrescribeIT® Response from PMS TaskCancel RX Request Denied
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:task-p141-m S1..1uriProfiles this resource claims to conform to
Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p141-m
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-dis-notification S1..1booleanDIS Notification of Prescription Cancel?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
.... value[x] S1..1booleanNo Prescription Renewals?
Fixed Value: false
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... value[x] S1..1Shared Health CodeableConceptConcept - reference to a terminology or just text
Binding: PrescriptionCancelRejectReason (20190415) (extensible)
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:taskCode S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: p141-m
... priority S1..1codenormal | high
Fixed Value: high
... status S1..1codedraft | requested | received | accepted | +
Fixed Value: rejected
... subject S1..1Reference(PrescribeIT® Prescription) {r}Prescription whose cancel request is being refused
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-identifier S1..1IdentifierReferenced identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
..... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierLast prescription identifier
.... reference 0..0
... input 0..0
... output 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*PrescribeIT® Response from PMS TaskCancel RX Request Denied
... id SΣ1..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen 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-p141-m SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p141-m
.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-group-identifier S1..1Shared Health IdentifierGroup Identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier
... ext-task-basedon S1..1Reference()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..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
.... value[x] S1..1(Slice Definition)e-Renewal request
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S1..1Reference() {r}Value of extension
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... reference SΣI1..1stringRelative, internal or absolute URL reference
...... display Σ0..1stringText alternative for the resource
... ext-task-dis-notification S1..1booleanDIS Notification of Prescription Cancel?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification"
.... value[x] S1..1booleanNo Prescription Renewals?
Fixed Value: false
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
.... value[x] SI1..1(Slice Definition)Concept - reference to a terminology or just text
Slice: Unordered, Closed by type:$this
Binding: PrescriptionCancelRejectReason (20190415) (extensible)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierTask Instance Identifier
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20220913) (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:taskCode SΣ1..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: p141-m
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1stringTask Description
... performerType 0..*Codingrequester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
Binding: TaskPerformerType (preferred): The type(s) of task performers allowed


... priority S1..1codenormal | high
Binding: PrescriptionTaskPriority (20190415) (required)
Fixed Value: high
... status SΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.


Fixed Value: rejected
... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT® Prescription) {r}Prescription whose cancel request is being refused
.... id 0..1idxml:id (or equivalent in JSON)
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-identifier S1..1IdentifierReferenced identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
..... value[x] S1..1(Slice Definition)Last prescription identifier
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier 1..1IdentifierValue of extension
.... display Σ0..1stringText alternative for the resource
... for SΣ1..1Reference(Shared Health Patient) {b}Beneficiary of the Task
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... definition Σ0..1uriTask Definition
... created SI1..1dateTimeTask Creation Date
created-full: Must be at least a full date. i.e. yyyy-mm-dd
... lastModified SΣI1..1dateTimeTask Last Modified Date
lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd
... creator S1..1Reference(Shared Health - eRx Service Location) {b}Task requestor
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... owner S1..1Reference(Shared Health Practitioner) {b}Task recipient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... parent 0..1Reference(Task)Composite task

doco Documentation for this format

Grid View

This structure is derived from PrescribeIT® Response from PMS Task

NameCard.TypeConstraints and Usage
.  Task 0..*PrescribeIT® Response from PMS Taskinv-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..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


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

..  meta 1..1MetaDefinition:
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..*uriSlice: 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-p141-m)
1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p141-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-p141-m

..  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

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


Comments:
Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. Refer to the PrescribeIT® Version 5.0 Jurisdictional Rules and Task Grouping Excel spreadsheet rules for a full set of scenarios.

..  extension
     (basedOn)
1..1Task Order Based OnDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
...  value[x] 1..1Reference() {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..1Reference() {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..1stringDefinition:
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)
1..1Task DIS NotificationDefinition:
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.

...  url 1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification"
...  value[x] 1..1booleanFixed Value: false
Definition:
Indicates that the prescriber will not support renewals for this prescription


Comments:
Fixed value: false

..  extension
     (reason)
1..1Task ReasonDefinition:
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 refusal

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
...  value[x] 1..1Shared Health CodeableConceptSlice: Unordered, Closed by type:$this
Binding: PrescriptionCancelRejectReason (20190415) (extensible)
inv-1: Must have coding, text or both
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:


..  type 1..1Shared Health CodeableConcept CodeBinding: PrescriptionTaskType (20220913) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


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

...  coding 1..*CodingSlice: 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..1uriDefinition:
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..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


Comments:
This is the code as defined within the binding.

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

...  coding
       (taskCode)
1..*CodingDefinition:
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..1uriFixed 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..1codeFixed Value: p141-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: p141-m

....  display 0..1stringDefinition:
A representation of the meaning of the code in the system, following the rules of the system.

..  priority 1..1codeBinding: 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..1codeBinding: TaskStatus (required): The current status of the task.


Fixed Value: rejected
Definition:
The current status of the task.


Comments:
Fixed value: rejected

..  subject 1..1Reference(PrescribeIT® Prescription) {r}Definition:
The subject of the task.


Comments:
Conformance Rule: The 'reference' element will not be used. Instead, the prescription whose cancel is being denied will point to indirectly by business identifier using the extension below.

...  extension 0..*ExtensionSlice: Unordered, Open by value:url
Definition:
An Extension

...  extension
       (identifier)
1..1Referenced Business identifierDefinition:
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 cancel response is associated with



Usage Note: In the context of p141, p142, and p143, this provides the medication order identifier that the cancel response is associated with



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..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
....  value[x] 1..1PrescribeIT® Prescriber Prescription IdentifierSlice: 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..1Reference(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..1stringDefinition:
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..1dateTimecreated-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..1dateTimelastModified-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..1Reference(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..1stringDefinition:
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}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

..  owner 1..1Reference(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..1stringDefinition:
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}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}'

This structure is derived from PrescribeIT® Response from PMS Task

Summary

Mandatory: 16 elements
Must-Support: 19 elements
Fixed Value: 6 elements
Prohibited: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element Task.meta.profile is sliced based on the value of value:value
  • The element Task.type.coding is sliced based on the value of value:system

Differential View

This structure is derived from PrescribeIT® Response from PMS Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task 0..*PrescribeIT® Response from PMS TaskCancel RX Request Denied
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:task-p141-m S1..1uriProfiles this resource claims to conform to
Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p141-m
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-dis-notification S1..1booleanDIS Notification of Prescription Cancel?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
.... value[x] S1..1booleanNo Prescription Renewals?
Fixed Value: false
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... value[x] S1..1Shared Health CodeableConceptConcept - reference to a terminology or just text
Binding: PrescriptionCancelRejectReason (20190415) (extensible)
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:taskCode S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: p141-m
... priority S1..1codenormal | high
Fixed Value: high
... status S1..1codedraft | requested | received | accepted | +
Fixed Value: rejected
... subject S1..1Reference(PrescribeIT® Prescription) {r}Prescription whose cancel request is being refused
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-identifier S1..1IdentifierReferenced identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
..... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierLast prescription identifier
.... reference 0..0
... input 0..0
... output 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task I0..*PrescribeIT® Response from PMS TaskCancel RX Request Denied
... id SΣ1..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen 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-p141-m SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p141-m
.... tag Σ0..*CodingTags 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..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-group-identifier S1..1Shared Health IdentifierGroup Identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier
... ext-task-basedon S1..1Reference()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..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
.... value[x] S1..1(Slice Definition)e-Renewal request
Slice: Unordered, Closed by type:$this
..... value[x]:valueReference S1..1Reference() {r}Value of extension
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... reference SΣI1..1stringRelative, internal or absolute URL reference
...... display Σ0..1stringText alternative for the resource
... ext-task-dis-notification S1..1booleanDIS Notification of Prescription Cancel?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification"
.... value[x] S1..1booleanNo Prescription Renewals?
Fixed Value: false
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
.... value[x] SI1..1(Slice Definition)Concept - reference to a terminology or just text
Slice: Unordered, Closed by type:$this
Binding: PrescriptionCancelRejectReason (20190415) (extensible)
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierTask Instance Identifier
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20220913) (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional 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..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:taskCode SΣ1..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: p141-m
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1stringTask Description
... performerType 0..*Codingrequester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
Binding: TaskPerformerType (preferred): The type(s) of task performers allowed


... priority S1..1codenormal | high
Binding: PrescriptionTaskPriority (20190415) (required)
Fixed Value: high
... status SΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.


Fixed Value: rejected
... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT® Prescription) {r}Prescription whose cancel request is being refused
.... id 0..1idxml:id (or equivalent in JSON)
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-identifier S1..1IdentifierReferenced identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
..... id 0..1idxml:id (or equivalent in JSON)
..... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier"
..... value[x] S1..1(Slice Definition)Last prescription identifier
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier 1..1IdentifierValue of extension
.... display Σ0..1stringText alternative for the resource
... for SΣ1..1Reference(Shared Health Patient) {b}Beneficiary of the Task
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... definition Σ0..1uriTask Definition
... created SI1..1dateTimeTask Creation Date
created-full: Must be at least a full date. i.e. yyyy-mm-dd
... lastModified SΣI1..1dateTimeTask Last Modified Date
lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd
... creator S1..1Reference(Shared Health - eRx Service Location) {b}Task requestor
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... owner S1..1Reference(Shared Health Practitioner) {b}Task recipient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... parent 0..1Reference(Task)Composite task

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Task.meta.tagexample
Task.languagerequiredhttp://tools.ietf.org/html/bcp47
Task.extension:reason.value[x]extensiblePrescriptionCancelRejectReason
Task.typerequiredPrescriptionTaskType
Task.performerTypepreferredTaskPerformerType
Task.priorityrequiredFixed Value: high
Task.statusrequiredFixed Value: rejected

Constraints

IdPathDetailsRequirements
inv-2TaskA Failure reason may be present only when a task has failed.
: failureReason.empty() or status = 'failed'
inv-1TaskLast modified date must be greater than or equal to created date.
: lastModified >= created
inv-1Task.extension:reason.value[x]Must have coding, text or both
: coding.exists() or text.exists()
created-fullTask.createdMust be at least a full date. i.e. yyyy-mm-dd
: length()>=10
lastModified-fullTask.lastModifiedMust be at least a full date. i.e. yyyy-mm-dd
: length()>=10