PrescribeIT™ Specification and Guide Version 2.0 Revision F

 

The official URL for this profile is:

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

The Cancel Responses are used to respond to the e140-m Cancel Request.

If a pharmacy responds with an Approved response, it is an indication to the Prescriber that the patient did not yet pick up the medication, and the Prescriber can confidently cancel the medication within the patient EMR profile.

The following diagram depicts the overall structure of a Task p142-m - Cancel RX Request Approved and the relationships between resources. Each box represents a resource that may be present in the message instance. The bolded text is the resource name. The profile name that is associated with the resource is also included.

Conformance rules specific to this task may exist. Refer to the Business Rules.

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..*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..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 requesting 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-p142-m-profile)
1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
Fixed value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m

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

..  extension
     (requisitionIdentifier)
1..1Task Requisition IDDefinition:
This is the common number that represents a paper order. It may be shared by multiple MedicationOrder, DeviceRequest and Task instances, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber


Comments:
Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. There are some business scenarios where a given task will be managed individually (eg cancel request). If a particular task is not part of a logical group, it will have its own requisition identifier (i.e. it will be handled as a group of 1). In other scenarios, the same requisition identifier is assigned to multiple tasks as they are considered to be part of a group. Example: medications that would be part of the same written paper Prescription or Renewal request will share the same Requisition Identifier.

Usage Note: Tasks corresponding to different requisition identifiers may be present in the same Bundle. The recipient must take this into account when grouping content for display/actioning by requisition identifier.

Suggested Structure: Assigned by the EMR; scoped by the application instance; this is an OID. An OID may be structured as Vendor.ApplicationInstance.RX#Branch Ext = Requisition Id.

Conformance Rule: All task resources sharing a common requisition number must be transmitted in the same message bundle.

Conformance Rule: All medication orders sharing the same requisition identifier in a renewal request must be viewed, managed and responded to together.

Conformance Rule: Different task types can share a requisition identifier when a task was performed in the shared context of other tasks with the same requisition id. For example, medication 1 was discontinued in the same context that medication 2 was prescribed. Receiving systems SHOULD display/manage tasks that are part of the same requisition together when this is feasible.

Conformance Rule: In the context of a 401 - Execute deferred (prescription) tasks from an EMR, this will map to the 'PrescribeIT™ RX ID' on the printed Patient Copy.

Usage Note: Requisition ID would be used by PMS to establish which medications belong to the same prescription.

..  extension
     (basedOn)
1..1Task Order Based OnDefinition:
Identifies a request, plan or proposal that drove the creation of this task


Comments:
Conformance Rule: The following child elements will convey the reference to the incoming request for which this response is based

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
...  valueReference 1..1Reference() {r}Definition:
The business identifier of the request task that this task was created based on


Comments:
Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the task.id for the task being responded to

....  reference 1..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)
0..1Task DIS NotificationDefinition:
Indicates that the DIS is notified of prescription cancellation


Comments:
Conformance Rule: PMSs must set this flag to true if they successfully notified the DIS of the cancellation. The element will be omitted if the applicable jurisdiction does not have a DIS. It is mandatory to include this element if the applicable jurisdiction has a DIS.

Usage Note: In the case that the DIS notified flag is set to true PrescribeIT will not send a cancel message to the DIS.

...  url 1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification"
...  valueBoolean 1..1booleanDefinition:
Indicates that the prescriber will not support renewals for this prescription


Comments:
Conformance Rule: If the PMS is not connected real time to the provincial DIS system then this flag must be set to ‘False’ for Task p141-m - Cancel RX Request Denied, Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked.

Conformance Rule:If the PMS is connected real time to the provincial DIS system then this flag must be set as follows:

a. For Task p141-m - Cancel RX Request Denied set the flag to ‘False’ as no changes should be done to the status of the prescription on the DIS.

b. For Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked set the flag to ‘True’ when the PMS will be updating the status of the prescription on the DIS this includes the when the status has been updated or is in the process of been updated (queue later, exception handling etc). If the PMS is not updating or will not update the status of the prescription on the DIS then set this flag to ‘False’.

..  extension
     (requestReason)
0..1Task Request ReasonDefinition:
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..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason"
...  valueCodeableConcept 1..1Shared Health CodeableConcept Code Required with Text OptionalBinding: PrescriptionCancelReason (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: The application generating this message must provide the required Terminology Binding coding elements, including the valueCodeableConcept.coding.system, the valueCodeableConcept.coding.code, and the valueCodeableConcept.coding.display. If a user provides a free text description above and beyond the coded value, this free text description should be provided in the valueCodeableConcept.text element

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


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

...  coding 1..*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:
....  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).

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


Comments:
Fixed value: p142-m

..  priority 0..1codeBinding: PrescriptionTaskPriority (required)
Definition:
The priority of the task among other tasks of the same type.


Comments:
This element does not apply to either Task p200-m - RX Dispense Notification or Task p210-m - RX Dispense Cancel Notification

Conformance Rule: If one of the medications within a requisition is a high priority, the EMR should present the entire renewal request (based on requisision.id) as a high priority item within the queue.

Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber.

..  status 1..1codeBinding: TaskStatus (required)
Fixed Value: completed
Definition:
The current status of the task.


Comments:
Fixed value: completed

..  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 being cancelled will pointed to indirectly by business identifier using the extension below.

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

...  extension
       (identifier)
1..1Referenced Requisition 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: 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"
....  valueIdentifier 1..1Shared Health IdentifierDefinition:
The prescription number whose renewal is being accepted


Comments:
Conformance Rule: This is the MedicationOrder. identifier for the prescription that is being cancelled. This is considered to be the Prescription Identifier, as originally assigned by the EMR.

Usage Note: Note, the Medication Order resource is not included in the message instance, just the identifier

..  for 1..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..1dateTimecreated-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 it be done

...  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/EnvironmentAndContextSpecificPathRegistry/Organization/2263396629'

..  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/EnvironmentAndContextSpecificPathRegistry/Practitioner/2263396629'

This structure is derived from PrescribeIT Response from PMS Task

Summary

Mandatory: 11 elements (1 nested mandatory element)
Must-Support: 16 elements
Fixed Value: 4 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

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 S0..*Cancel RX Request Approved
... meta S1..1Meta
.... profile SuriSlice: Unordered, Open by value:value
.... profile S1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
... ext-task-dis-notification S0..1booleanDIS Notification of Prescription Cancel?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
... ext-task-request-reason S0..1CodeableConceptTask Request Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason
.... valueCodeableConcept S1..1Shared Health CodeableConcept Code Required with Text OptionalBinding: PrescriptionCancelReason (extensible)
... type S1..1Shared Health CodeableConcept Code
.... coding SCodingSlice: Unordered, Open by value:system
.... coding S1..*Coding
..... system S1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
..... code S1..1codeFixed Value: p142-m
... status S1..1codeFixed Value: completed
... subject S1..1Reference(PrescribeIT Prescription) {r}Prescription that has been cancelled
.... extension S0..*ExtensionSlice: Unordered, Open by value:url
.... ext-reference-identifier S1..1Shared Health IdentifierReferenced identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
..... valueIdentifier S1..1Shared Health IdentifierLast prescription number
... input 0..0
... output 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task SI0..*Cancel RX Request Approved
... 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ΣuriProfiles this resource claims to conform to
Slice: Unordered, Open by value:value
.... profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-requisition-id S1..1Shared Health IdentifierPrescription Number
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-requisition-id
... ext-task-basedon S1..1Reference(PrescribeIT™ base Task profile) {r}Plan, request or referral
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-basedon
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
.... valueReference S1..1Reference() {r}e-Renewal request
..... 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 S0..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"
.... valueBoolean S1..1booleanNo Prescription Renewals?
... ext-task-request-reason S0..1CodeableConceptTask Request Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason"
.... valueCodeableConcept S1..1Shared Health CodeableConcept Code Required with Text OptionalConcept - reference to a terminology or just text
Binding: PrescriptionCancelReason (extensible)
... 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 (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... 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 Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding 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: p142-m
..... display Σ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)
... priority S0..1codenormal | high
Binding: PrescriptionTaskPriority (required)
... status SΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required)
Fixed Value: completed
... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT Prescription) {r}Prescription that has been cancelled
.... id 0..1idxml:id (or equivalent in JSON)
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-identifier S1..1Shared Health IdentifierReferenced 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"
..... valueIdentifier S1..1Shared Health IdentifierLast prescription number
.... reference ΣI0..1stringRelative, internal or absolute URL reference
.... 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
created-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..*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..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 requesting 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-p142-m-profile)
1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
Fixed value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m

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

..  extension
     (requisitionIdentifier)
1..1Task Requisition IDDefinition:
This is the common number that represents a paper order. It may be shared by multiple MedicationOrder, DeviceRequest and Task instances, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber


Comments:
Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. There are some business scenarios where a given task will be managed individually (eg cancel request). If a particular task is not part of a logical group, it will have its own requisition identifier (i.e. it will be handled as a group of 1). In other scenarios, the same requisition identifier is assigned to multiple tasks as they are considered to be part of a group. Example: medications that would be part of the same written paper Prescription or Renewal request will share the same Requisition Identifier.

Usage Note: Tasks corresponding to different requisition identifiers may be present in the same Bundle. The recipient must take this into account when grouping content for display/actioning by requisition identifier.

Suggested Structure: Assigned by the EMR; scoped by the application instance; this is an OID. An OID may be structured as Vendor.ApplicationInstance.RX#Branch Ext = Requisition Id.

Conformance Rule: All task resources sharing a common requisition number must be transmitted in the same message bundle.

Conformance Rule: All medication orders sharing the same requisition identifier in a renewal request must be viewed, managed and responded to together.

Conformance Rule: Different task types can share a requisition identifier when a task was performed in the shared context of other tasks with the same requisition id. For example, medication 1 was discontinued in the same context that medication 2 was prescribed. Receiving systems SHOULD display/manage tasks that are part of the same requisition together when this is feasible.

Conformance Rule: In the context of a 401 - Execute deferred (prescription) tasks from an EMR, this will map to the 'PrescribeIT™ RX ID' on the printed Patient Copy.

Usage Note: Requisition ID would be used by PMS to establish which medications belong to the same prescription.

..  extension
     (basedOn)
1..1Task Order Based OnDefinition:
Identifies a request, plan or proposal that drove the creation of this task


Comments:
Conformance Rule: The following child elements will convey the reference to the incoming request for which this response is based

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
...  valueReference 1..1Reference() {r}Definition:
The business identifier of the request task that this task was created based on


Comments:
Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the task.id for the task being responded to

....  reference 1..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)
0..1Task DIS NotificationDefinition:
Indicates that the DIS is notified of prescription cancellation


Comments:
Conformance Rule: PMSs must set this flag to true if they successfully notified the DIS of the cancellation. The element will be omitted if the applicable jurisdiction does not have a DIS. It is mandatory to include this element if the applicable jurisdiction has a DIS.

Usage Note: In the case that the DIS notified flag is set to true PrescribeIT will not send a cancel message to the DIS.

...  url 1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification"
...  valueBoolean 1..1booleanDefinition:
Indicates that the prescriber will not support renewals for this prescription


Comments:
Conformance Rule: If the PMS is not connected real time to the provincial DIS system then this flag must be set to ‘False’ for Task p141-m - Cancel RX Request Denied, Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked.

Conformance Rule:If the PMS is connected real time to the provincial DIS system then this flag must be set as follows:

a. For Task p141-m - Cancel RX Request Denied set the flag to ‘False’ as no changes should be done to the status of the prescription on the DIS.

b. For Task p142-m - Cancel RX Request Approved and Task p143-m – Cancel Rx Remaining Refill Revoked set the flag to ‘True’ when the PMS will be updating the status of the prescription on the DIS this includes the when the status has been updated or is in the process of been updated (queue later, exception handling etc). If the PMS is not updating or will not update the status of the prescription on the DIS then set this flag to ‘False’.

..  extension
     (requestReason)
0..1Task Request ReasonDefinition:
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..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason"
...  valueCodeableConcept 1..1Shared Health CodeableConcept Code Required with Text OptionalBinding: PrescriptionCancelReason (extensible)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Conformance Rule: The application generating this message must provide the required Terminology Binding coding elements, including the valueCodeableConcept.coding.system, the valueCodeableConcept.coding.code, and the valueCodeableConcept.coding.display. If a user provides a free text description above and beyond the coded value, this free text description should be provided in the valueCodeableConcept.text element

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


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

...  coding 1..*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:
....  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).

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


Comments:
Fixed value: p142-m

..  priority 0..1codeBinding: PrescriptionTaskPriority (required)
Definition:
The priority of the task among other tasks of the same type.


Comments:
This element does not apply to either Task p200-m - RX Dispense Notification or Task p210-m - RX Dispense Cancel Notification

Conformance Rule: If one of the medications within a requisition is a high priority, the EMR should present the entire renewal request (based on requisision.id) as a high priority item within the queue.

Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber.

..  status 1..1codeBinding: TaskStatus (required)
Fixed Value: completed
Definition:
The current status of the task.


Comments:
Fixed value: completed

..  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 being cancelled will pointed to indirectly by business identifier using the extension below.

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

...  extension
       (identifier)
1..1Referenced Requisition 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: 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"
....  valueIdentifier 1..1Shared Health IdentifierDefinition:
The prescription number whose renewal is being accepted


Comments:
Conformance Rule: This is the MedicationOrder. identifier for the prescription that is being cancelled. This is considered to be the Prescription Identifier, as originally assigned by the EMR.

Usage Note: Note, the Medication Order resource is not included in the message instance, just the identifier

..  for 1..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..1dateTimecreated-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 it be done

...  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/EnvironmentAndContextSpecificPathRegistry/Organization/2263396629'

..  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/EnvironmentAndContextSpecificPathRegistry/Practitioner/2263396629'

This structure is derived from PrescribeIT Response from PMS Task

Summary

Mandatory: 11 elements (1 nested mandatory element)
Must-Support: 16 elements
Fixed Value: 4 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

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 S0..*Cancel RX Request Approved
... meta S1..1Meta
.... profile SuriSlice: Unordered, Open by value:value
.... profile S1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
... ext-task-dis-notification S0..1booleanDIS Notification of Prescription Cancel?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-dis-notification
... ext-task-request-reason S0..1CodeableConceptTask Request Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason
.... valueCodeableConcept S1..1Shared Health CodeableConcept Code Required with Text OptionalBinding: PrescriptionCancelReason (extensible)
... type S1..1Shared Health CodeableConcept Code
.... coding SCodingSlice: Unordered, Open by value:system
.... coding S1..*Coding
..... system S1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
..... code S1..1codeFixed Value: p142-m
... status S1..1codeFixed Value: completed
... subject S1..1Reference(PrescribeIT Prescription) {r}Prescription that has been cancelled
.... extension S0..*ExtensionSlice: Unordered, Open by value:url
.... ext-reference-identifier S1..1Shared Health IdentifierReferenced identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier profiled by http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
..... valueIdentifier S1..1Shared Health IdentifierLast prescription number
... input 0..0
... output 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task SI0..*Cancel RX Request Approved
... 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ΣuriProfiles this resource claims to conform to
Slice: Unordered, Open by value:value
.... profile SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p142-m
.... security Σ0..*CodingSecurity Labels applied to this resource
Binding: All Security Labels (extensible)
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example)
... 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)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-requisition-id S1..1Shared Health IdentifierPrescription Number
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-requisition-id
... ext-task-basedon S1..1Reference(PrescribeIT™ base Task profile) {r}Plan, request or referral
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-basedon
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn"
.... valueReference S1..1Reference() {r}e-Renewal request
..... 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 S0..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"
.... valueBoolean S1..1booleanNo Prescription Renewals?
... ext-task-request-reason S0..1CodeableConceptTask Request Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://prescribeit.ca/fhir/StructureDefinition/ext-task-request-reason"
.... valueCodeableConcept S1..1Shared Health CodeableConcept Code Required with Text OptionalConcept - reference to a terminology or just text
Binding: PrescriptionCancelReason (extensible)
... 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 (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣCodingCode defined by a terminology system
Slice: Unordered, Open by value:system
..... 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 Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... coding 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: p142-m
..... display Σ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)
... priority S0..1codenormal | high
Binding: PrescriptionTaskPriority (required)
... status SΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required)
Fixed Value: completed
... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT Prescription) {r}Prescription that has been cancelled
.... id 0..1idxml:id (or equivalent in JSON)
.... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... ext-reference-identifier S1..1Shared Health IdentifierReferenced 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"
..... valueIdentifier S1..1Shared Health IdentifierLast prescription number
.... reference ΣI0..1stringRelative, internal or absolute URL reference
.... 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
created-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

PathNameConformanceValueSet
Task.meta.securityAll Security LabelsextensibleAll Security Labels
Task.meta.tag?extexample
Task.language?extrequiredhttp://tools.ietf.org/html/bcp47
Task.extension.valueCodeableConceptPrescriptionCancelReasonextensiblePrescriptionCancelReason
Task.typePrescriptionTaskTyperequiredPrescriptionTaskType
Task.performerTypeTaskPerformerTypepreferredTaskPerformerType
Task.priorityPrescriptionTaskPriorityrequiredPrescriptionTaskPriority
Task.statusTaskStatusrequiredTaskStatus

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
created-fullTask.createdMust be at least a full date. i.e. yyyy-mm-dd
: length()>=10
created-fullTask.lastModifiedMust be at least a full date. i.e. yyyy-mm-dd
: length()>=10