3.124 StructureDefinition: Task p200-m - RX Dispense Notification
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/task-p200-m
PrescribeIT® provides functionality to allow pharmacies to send a dispense notification to the prescriber’s system that the dispense of a medication has occurred. The notification will provide the details of the actual dispense and a reference by identifier back to the prescription
The following diagram depicts the overall structure of a Task p200-m - RX Dispense Notification 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.
3.124.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from PrescribeIT® Request from PMS Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Task | 0..* | PrescribeIT® Request from PMS Task | inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. p200-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified Definition: A task to be performed. |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
 profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. |
 profile(task-p200-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p200-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-p200-m |
| extension (groupIdentifier) | 1..1 | Task Group Identifier | Definition: This is the common identifier that represents a paper order. It may be shared by multiple Task instances for various Medication Orders, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber Comments: Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. Refer to the PrescribeIT® Version 5.0 Jurisdictional Rules and Task Grouping Excel spreadsheet rules for a full set of scenarios. |
| extension (splitPrescriptionFlag) | 0..1 | Task Split Prescription | Definition: An extension, if true, indicates that a PMS Prescription has been split. |
| extension (splitPrescriptionReason) | 0..1 | Task Split Prescription Reason | Definition: Provides a textual description to convey any relevant reasons/rational related to the why the pharmacist’s split the prescription. The pharmacy staff should have the ability to enter any relevant information related to the pharmacist split prescription which may be required to be sent as per the jurisdictional regulations. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20220913) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
 system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
 display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| coding (taskCode) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
  system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | 1..1 | code | Fixed Value: p200-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: p200-m |
 display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. Fixed Value: completed Definition: The current status of the task. Comments: Fixed value: completed |
| subject | 1..1 | Reference(PrescribeIT® Dispense) {b} | Definition: The subject of the task. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is the reference to the MedicationDispense.id assigned by the Sending system. This is not a business identifier. Example: value='MedicationDispense/[guid]' |
| for | 1..1 | Reference(Shared Health Patient) {b} | Definition: The entity who benefits from the performance of the service specified in the task (e.g., the patient). Comments: Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message) |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message |
| created | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time this task was created. Comments: This indicates when the request was created. This will generally be the same as the date of message construction. Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00' |
| lastModified | 1..1 | dateTime | lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time of last modification to this task. Comments: This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'. Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification. |
| creator | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Definition: The creator of the task. Comments: This is who is submitting the task and asking for it be done. In the context of all PMS message this is the PrescribeIT® pharmacy that is responsible for initiating the message. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the originating pharmacy Organization. This value will be returned from the Provider Registry Organization query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}' |
| owner | 1..1 | Reference(Shared Health Practitioner) {b} | Definition: The owner of this task. The participant who can execute this task. Comments: This is who is intended to receive/act on the task |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the prescriber Practitioner being requested to act. This value will be returned from the Provider Registry Practitioner query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}' |
| input | 0..1 | BackboneElement | Slice: Unordered, Closed by value:name Definition: Inputs to the task. |
| input (PMSrequestedRx) | 0..1 | BackboneElement | Max Length: 1000 Definition: The business identifier of the Local PMS Prescription that is associated to this Dispense Comments: This is the local PMS prescription number that is associated to this dispense. This prescription number will be same for each dispense that is done against that local prescription. This is different then the dispense identifier which is the unique business identifier that is associated to each dispense. Conformance Rule: The local PMS prescription number must be provided in the scenario of a split prescription. This can be provided all for dispenses but is not mandatory on non split prescription although it is recommended to send it always for consistency. Usage Note: The local pms prescription number can be used on the EMR for sorting and display purposes especially in the scenario of split prescription where multiple dispenses will be done across multiple PMS prescriptions |
| name | 1..1 | string | Fixed Value: pmsrequestedrx Definition: The name of the input parameter. Comments: Fixed value: pmsrequestedrx |
| value[x] | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Definition: The business identifier of the PMS Requested Rx Dispense prescription Comments: This is a reference by business identifier, not by resource id |
This structure is derived from PrescribeIT® Request from PMS Task
Summary
Mandatory: 10 elements (2 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationdispense
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason
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
- The element Task.input is sliced based on the value of value:name (Closed)
This structure is derived from PrescribeIT® Request from PMS Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Task | SI | 0..* | PrescribeIT® Request from PMS Task | RX Dispense Notification p200-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified |
 meta | S | 1..1 | Meta | Metadata about the resource |
 profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
 profile:task-p200-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p200-m |
| ext-task-split-prescription | S | 0..1 | boolean | Task Split Prescription? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription |
| ext-task-split-prescription-reason | S | 0..1 | Shared Health CodeableConcept Code Required with Text Optional | Task Split Prescription Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason Binding: PrescriptionSplitReason (20210501) (required) |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text |
| coding | S | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:taskCode | S | 1..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: p200-m |
| priority | 0..0 | |||
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: completed |
 subject | S | 1..1 | Reference(PrescribeIT® Dispense) {b} | Dispense that was processed |
| reference | S | 1..1 | string | Relative, internal or absolute URL reference |
| input | S | 0..1 | (Slice Definition) | Task Input Slice: Unordered, Closed by value:name |
| input:PMSrequestedRx | S | 0..1 | BackboneElement | Task Input Max Length: 1000 |
 name | S | 1..1 | string | Input Name Fixed Value: pmsrequestedrx |
 value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | PMS Requested Rx Dispense Prescription |
| output | 0..0 | |||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | SI | 0..* | PrescribeIT® Request from PMS Task | RX Dispense Notification p200-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:task-p200-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p200-m |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-task-group-identifier | S | 1..1 | Shared Health Identifier | Group Identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier |
| ext-task-split-prescription | S | 0..1 | boolean | Task Split Prescription? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription |
| ext-task-split-prescription-reason | S | 0..1 | Shared Health CodeableConcept Code Required with Text Optional | Task Split Prescription Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason Binding: PrescriptionSplitReason (20210501) (required) |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..1 | Identifier | Task Instance Identifier | |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20220913) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:All Slices | Content/Rules for all slices | |||
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:taskCode | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: p200-m |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed | |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: completed |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Dispense) {b} | Dispense that was processed |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| for | SΣ | 1..1 | Reference(Shared Health Patient) {b} | Beneficiary of the Task |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| definition | Σ | 0..1 | uri | Task Definition |
| created | SI | 1..1 | dateTime | Task Creation Date created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| lastModified | SΣI | 1..1 | dateTime | Task Last Modified Date lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | S | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Task requestor |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| owner | S | 1..1 | Reference(Shared Health Practitioner) {b} | Task recipient |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| parent | 0..1 | Reference(Task) | Composite task | |
| input | S | 0..1 | (Slice Definition) | Task Input Slice: Unordered, Closed by value:name |
| input:All Slices | Content/Rules for all slices | |||
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | 1..1 | string | Input Name | |
 value[x] | 1..1 | Input Value | ||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueDecimal | decimal | |||
| valueBase64Binary | base64Binary | |||
| valueInstant | instant | |||
| valueString | string | |||
| valueUri | uri | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueCode | code | |||
| valueOid | oid | |||
| valueId | id | |||
| valueUnsignedInt | unsignedInt | |||
| valuePositiveInt | positiveInt | |||
| valueMarkdown | markdown | |||
| valueAnnotation | Annotation | |||
| valueAttachment | Attachment | |||
| valueIdentifier | Identifier | |||
| valueCodeableConcept | CodeableConcept | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valuePeriod | Period | |||
| valueRatio | Ratio | |||
| valueSampledData | SampledData | |||
| valueSignature | Signature | |||
| valueHumanName | HumanName | |||
| valueAddress | Address | |||
| valueContactPoint | ContactPoint | |||
| valueTiming | Timing | |||
| valueReference | Reference(Any) | |||
| valueMeta | Meta | |||
| input:PMSrequestedRx | S | 0..1 | BackboneElement | Task Input Max Length: 1000 |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | S | 1..1 | string | Input Name Fixed Value: pmsrequestedrx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | PMS Requested Rx Dispense Prescription |
| Documentation for this format | ||||
Grid View
This structure is derived from PrescribeIT® Request from PMS Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Task | 0..* | PrescribeIT® Request from PMS Task | inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. p200-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified Definition: A task to be performed. |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the sending application. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
| profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. |
| profile (task-p200-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p200-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-p200-m |
| extension (groupIdentifier) | 1..1 | Task Group Identifier | Definition: This is the common identifier that represents a paper order. It may be shared by multiple Task instances for various Medication Orders, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber Comments: Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. Refer to the PrescribeIT® Version 5.0 Jurisdictional Rules and Task Grouping Excel spreadsheet rules for a full set of scenarios. |
| extension (splitPrescriptionFlag) | 0..1 | Task Split Prescription | Definition: An extension, if true, indicates that a PMS Prescription has been split. |
| extension (splitPrescriptionReason) | 0..1 | Task Split Prescription Reason | Definition: Provides a textual description to convey any relevant reasons/rational related to the why the pharmacist’s split the prescription. The pharmacy staff should have the ability to enter any relevant information related to the pharmacist split prescription which may be required to be sent as per the jurisdictional regulations. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20220913) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| coding (taskCode) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | 1..1 | code | Fixed Value: p200-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: p200-m |
| display | 0..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. Fixed Value: completed Definition: The current status of the task. Comments: Fixed value: completed |
| subject | 1..1 | Reference(PrescribeIT® Dispense) {b} | Definition: The subject of the task. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is the reference to the MedicationDispense.id assigned by the Sending system. This is not a business identifier. Example: value='MedicationDispense/[guid]' |
| for | 1..1 | Reference(Shared Health Patient) {b} | Definition: The entity who benefits from the performance of the service specified in the task (e.g., the patient). Comments: Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message) |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message |
| created | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time this task was created. Comments: This indicates when the request was created. This will generally be the same as the date of message construction. Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00' |
| lastModified | 1..1 | dateTime | lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time of last modification to this task. Comments: This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'. Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification. |
| creator | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Definition: The creator of the task. Comments: This is who is submitting the task and asking for it be done. In the context of all PMS message this is the PrescribeIT® pharmacy that is responsible for initiating the message. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the originating pharmacy Organization. This value will be returned from the Provider Registry Organization query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}' |
| owner | 1..1 | Reference(Shared Health Practitioner) {b} | Definition: The owner of this task. The participant who can execute this task. Comments: This is who is intended to receive/act on the task |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the prescriber Practitioner being requested to act. This value will be returned from the Provider Registry Practitioner query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}' |
| input | 0..1 | BackboneElement | Slice: Unordered, Closed by value:name Definition: Inputs to the task. |
| input (PMSrequestedRx) | 0..1 | BackboneElement | Max Length: 1000 Definition: The business identifier of the Local PMS Prescription that is associated to this Dispense Comments: This is the local PMS prescription number that is associated to this dispense. This prescription number will be same for each dispense that is done against that local prescription. This is different then the dispense identifier which is the unique business identifier that is associated to each dispense. Conformance Rule: The local PMS prescription number must be provided in the scenario of a split prescription. This can be provided all for dispenses but is not mandatory on non split prescription although it is recommended to send it always for consistency. Usage Note: The local pms prescription number can be used on the EMR for sorting and display purposes especially in the scenario of split prescription where multiple dispenses will be done across multiple PMS prescriptions |
| name | 1..1 | string | Fixed Value: pmsrequestedrx Definition: The name of the input parameter. Comments: Fixed value: pmsrequestedrx |
| value[x] | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Definition: The business identifier of the PMS Requested Rx Dispense prescription Comments: This is a reference by business identifier, not by resource id |
This structure is derived from PrescribeIT® Request from PMS Task
Summary
Mandatory: 10 elements (2 nested mandatory elements)
Must-Support: 17 elements
Fixed Value: 5 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationdispense
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason
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
- The element Task.input is sliced based on the value of value:name (Closed)
Differential View
This structure is derived from PrescribeIT® Request from PMS Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | SI | 0..* | PrescribeIT® Request from PMS Task | RX Dispense Notification p200-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified |
| meta | S | 1..1 | Meta | Metadata about the resource |
| profile | S | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:task-p200-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p200-m |
| ext-task-split-prescription | S | 0..1 | boolean | Task Split Prescription? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription |
| ext-task-split-prescription-reason | S | 0..1 | Shared Health CodeableConcept Code Required with Text Optional | Task Split Prescription Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason Binding: PrescriptionSplitReason (20210501) (required) |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text |
| coding | S | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:taskCode | S | 1..* | Coding | Code defined by a terminology system |
| system | S | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: p200-m |
| priority | 0..0 | |||
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: completed |
| subject | S | 1..1 | Reference(PrescribeIT® Dispense) {b} | Dispense that was processed |
| reference | S | 1..1 | string | Relative, internal or absolute URL reference |
| input | S | 0..1 | (Slice Definition) | Task Input Slice: Unordered, Closed by value:name |
| input:PMSrequestedRx | S | 0..1 | BackboneElement | Task Input Max Length: 1000 |
| name | S | 1..1 | string | Input Name Fixed Value: pmsrequestedrx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | PMS Requested Rx Dispense Prescription |
| output | 0..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | SI | 0..* | PrescribeIT® Request from PMS Task | RX Dispense Notification p200-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified |
| id | SΣ | 1..1 | id | Logical id of this artifact |
| meta | SΣ | 1..1 | Meta | Metadata about the resource |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| profile | SΣ | 1..* | (Slice Definition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:value |
| profile:task-p200-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p200-m |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-task-group-identifier | S | 1..1 | Shared Health Identifier | Group Identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier |
| ext-task-split-prescription | S | 0..1 | boolean | Task Split Prescription? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription |
| ext-task-split-prescription-reason | S | 0..1 | Shared Health CodeableConcept Code Required with Text Optional | Task Split Prescription Reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason Binding: PrescriptionSplitReason (20210501) (required) |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..1 | Identifier | Task Instance Identifier | |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20220913) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:All Slices | Content/Rules for all slices | |||
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:taskCode | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: p200-m |
| display | SΣ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed | |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: completed |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Dispense) {b} | Dispense that was processed |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| for | SΣ | 1..1 | Reference(Shared Health Patient) {b} | Beneficiary of the Task |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| definition | Σ | 0..1 | uri | Task Definition |
| created | SI | 1..1 | dateTime | Task Creation Date created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| lastModified | SΣI | 1..1 | dateTime | Task Last Modified Date lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | S | 1..1 | Reference(Shared Health - eRx Service Location) {b} | Task requestor |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| owner | S | 1..1 | Reference(Shared Health Practitioner) {b} | Task recipient |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| parent | 0..1 | Reference(Task) | Composite task | |
| input | S | 0..1 | (Slice Definition) | Task Input Slice: Unordered, Closed by value:name |
| input:All Slices | Content/Rules for all slices | |||
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | 1..1 | string | Input Name | |
| value[x] | 1..1 | Input Value | ||
| valueBoolean | boolean | |||
| valueInteger | integer | |||
| valueDecimal | decimal | |||
| valueBase64Binary | base64Binary | |||
| valueInstant | instant | |||
| valueString | string | |||
| valueUri | uri | |||
| valueDate | date | |||
| valueDateTime | dateTime | |||
| valueTime | time | |||
| valueCode | code | |||
| valueOid | oid | |||
| valueId | id | |||
| valueUnsignedInt | unsignedInt | |||
| valuePositiveInt | positiveInt | |||
| valueMarkdown | markdown | |||
| valueAnnotation | Annotation | |||
| valueAttachment | Attachment | |||
| valueIdentifier | Identifier | |||
| valueCodeableConcept | CodeableConcept | |||
| valueCoding | Coding | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| valuePeriod | Period | |||
| valueRatio | Ratio | |||
| valueSampledData | SampledData | |||
| valueSignature | Signature | |||
| valueHumanName | HumanName | |||
| valueAddress | Address | |||
| valueContactPoint | ContactPoint | |||
| valueTiming | Timing | |||
| valueReference | Reference(Any) | |||
| valueMeta | Meta | |||
| input:PMSrequestedRx | S | 0..1 | BackboneElement | Task Input Max Length: 1000 |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | S | 1..1 | string | Input Name Fixed Value: pmsrequestedrx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | PMS Requested Rx Dispense Prescription |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.124.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Task.meta.tag | example | |
| Task.language | required | http://tools.ietf.org/html/bcp47 |
| Task.type | required | PrescriptionTaskType |
| Task.performerType | preferred | TaskPerformerType |
| Task.status | required | Fixed Value: completed |
3.124.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| inv-2 | Task | A Failure reason may be present only when a task has failed. : failureReason.empty() or status = 'failed' | |
| inv-1 | Task | Last modified date must be greater than or equal to created date. : lastModified >= created | |
| p200-1 | Task | IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified : (extension('http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription').exists() and extension('http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription').value=true) implies extension('http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason').exists() | |
| created-full | Task.created | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 | |
| lastModified-full | Task.lastModified | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 |