PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

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

PrescribeIT® provides functionality to allow pharmacies to send a dispense notification – cancelled.

The following diagram depicts the overall structure of a Task p210-m - RX Dispense Cancel 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.

Download Excel representation

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

>

This structure is derived from PrescribeIT® Request from PMS Task

NameCard.TypeConstraints and Usage
.  Task 0..*PrescribeIT® Request from PMS Taskinv-2: A Failure reason may be present only when a task has failed.
inv-1: Last modified date must be greater than or equal to created date.
p210-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified
Definition:
A task to be performed.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


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

..  meta 1..1MetaDefinition:
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

...  profile 1..*uriSlice: Unordered, Open by value:value
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.

...  profile
       (task-p210-m)
1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p210-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-p210-m

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

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


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

..  extension
     (reason)
1..1Task ReasonDefinition:
Indicates the reason for the current task's status or existence - used for reasons other than 'failed'


Comments:
Conformance Rule: This will contain the reason for the cancellation

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
...  value[x] 1..1Shared Health CodeableConcept Text RequiredSlice: Unordered, Closed by type:$this
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

..  extension
     (splitPrescriptionFlag)
0..1Task Split PrescriptionDefinition:
An extension, if true, indicates that a PMS Prescription has been split.

..  extension
     (splitPrescriptionReason)
0..1Task Split Prescription ReasonDefinition:
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..1Shared Health CodeableConcept CodeBinding: PrescriptionTaskType (20220913) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


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

...  coding 1..*CodingSlice: Unordered, Open by value:system
Definition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


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

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

...  coding
       (taskCode)
1..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype

....  code 1..1codeFixed Value: p210-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: p210-m

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

..  status 1..1codeBinding: TaskStatus (required): The current status of the task.


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


Comments:
Fixed value: completed

..  subject 1..1Reference(PrescribeIT® Dispense) {b}Definition:
The subject of 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 the reference to the MedicationDispense.id assigned by the Sending system. This is not a business identifier. Example: value='MedicationDispense/[guid]'

..  for 1..1Reference(Shared Health Patient) {b}Definition:
The entity who benefits from the performance of the service specified in the task (e.g., the patient).


Comments:
Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message

..  created 1..1dateTimecreated-full: Must be at least a full date. i.e. yyyy-mm-dd
Definition:
The date and time this task was created.


Comments:
This indicates when the request was created. This will generally be the same as the date of message construction.



Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored.



Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'

..  lastModified 1..1dateTimelastModified-full: Must be at least a full date. i.e. yyyy-mm-dd
Definition:
The date and time of last modification to this task.


Comments:
This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR.



Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'.



Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification.

..  creator 1..1Reference(Shared Health - eRx Service Location) {b}Definition:
The creator of the task.


Comments:
This is who is submitting the task and asking for it be done.



In the context of all PMS message this is the PrescribeIT® pharmacy that is responsible for initiating the message.

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the originating pharmacy Organization. This value will be returned from the Provider Registry Organization query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

..  owner 1..1Reference(Shared Health Practitioner) {b}Definition:
The owner of this task. The participant who can execute this task.


Comments:
This is who is intended to receive/act on the task

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the prescriber Practitioner being requested to act. This value will be returned from the Provider Registry Practitioner query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}'

..  input 0..1BackboneElementSlice: Unordered, Closed by value:name
Definition:
Inputs to the task.

..  input
     (PMSrequestedRx)
0..1BackboneElementMax Length: 1000
Definition:
Inputs to the task.


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..1stringFixed Value: pmsrequestedrx
Definition:
The name of the input parameter.


Comments:
Fixed value: pmsrequestedrx

...  value[x] 1..1PrescribeIT® Prescriber Prescription IdentifierDefinition:
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: 12 elements (2 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 5 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
  • The element Task.input is sliced based on the value of value:name (Closed)

This structure is derived from PrescribeIT® Request from PMS Task

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task SI0..*PrescribeIT® Request from PMS TaskRX Dispense Notification
p210-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:task-p210-m S1..1uriProfiles this resource claims to conform to
Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p210-m
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... value[x] S1..1Shared Health CodeableConcept Text RequiredConcept - reference to a terminology or just text
... ext-task-split-prescription S0..1booleanTask Split Prescription?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription
... ext-task-split-prescription-reason S0..1Shared Health CodeableConcept Code Required with Text OptionalTask Split Prescription Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason
Binding: PrescriptionSplitReason (20210501) (required)
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:taskCode S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: p210-m
... priority 0..0
... status S1..1codedraft | requested | received | accepted | +
Fixed Value: completed
... subject S1..1Reference(PrescribeIT® Dispense) {b}Dispense that was cancelled
.... reference S1..1stringRelative, internal or absolute URL reference
... input S0..1(Slice Definition)Task Input
Slice: Unordered, Closed by value:name
.... input:PMSrequestedRx S0..1BackboneElementTask Input
Max Length: 1000
..... name S1..1stringInput Name
Fixed Value: pmsrequestedrx
..... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierPMS Requested Rx Dispense Prescription
... output 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Task SI0..*PrescribeIT® Request from PMS TaskRX Dispense Notification
p210-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified
... id SΣ1..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:task-p210-m SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p210-m
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-group-identifier S1..1Shared Health IdentifierGroup Identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
.... value[x] S1..1(Slice Definition)Concept - reference to a terminology or just text
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
... ext-task-split-prescription S0..1booleanTask Split Prescription?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription
... ext-task-split-prescription-reason S0..1Shared Health CodeableConcept Code Required with Text OptionalTask Split Prescription Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason
Binding: PrescriptionSplitReason (20210501) (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierTask Instance Identifier
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20220913) (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:taskCode SΣ1..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: p210-m
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1stringTask Description
... performerType 0..*Codingrequester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
Binding: TaskPerformerType (preferred): The type(s) of task performers allowed


... status SΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.


Fixed Value: completed
... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT® Dispense) {b}Dispense that was cancelled
.... 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
... for SΣ1..1Reference(Shared Health Patient) {b}Beneficiary of the Task
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... definition Σ0..1uriTask Definition
... created SI1..1dateTimeTask Creation Date
created-full: Must be at least a full date. i.e. yyyy-mm-dd
... lastModified SΣI1..1dateTimeTask Last Modified Date
lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd
... creator S1..1Reference(Shared Health - eRx Service Location) {b}Task requestor
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... owner S1..1Reference(Shared Health Practitioner) {b}Task recipient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... parent 0..1Reference(Task)Composite task
... input S0..1(Slice Definition)Task Input
Slice: Unordered, Closed by value:name
.... input:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringInput Name
..... value[x] 1..1Input Value
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueBase64Binarybase64Binary
...... valueInstantinstant
...... valueStringstring
...... valueUriuri
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueCodecode
...... valueOidoid
...... valueIdid
...... valueUnsignedIntunsignedInt
...... valuePositiveIntpositiveInt
...... valueMarkdownmarkdown
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueIdentifierIdentifier
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueQuantityQuantity
...... valueRangeRange
...... valuePeriodPeriod
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueHumanNameHumanName
...... valueAddressAddress
...... valueContactPointContactPoint
...... valueTimingTiming
...... valueReferenceReference(Any)
...... valueMetaMeta
.... input:PMSrequestedRx S0..1BackboneElementTask Input

Max Length: 1000
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name S1..1stringInput Name
Fixed Value: pmsrequestedrx
..... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierPMS Requested Rx Dispense Prescription

doco Documentation for this format

Grid View

This structure is derived from PrescribeIT® Request from PMS Task

NameCard.TypeConstraints and Usage
.  Task 0..*PrescribeIT® Request from PMS Taskinv-2: A Failure reason may be present only when a task has failed.
inv-1: Last modified date must be greater than or equal to created date.
p210-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified
Definition:
A task to be performed.

..  id 1..1idDefinition:
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.


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

..  meta 1..1MetaDefinition:
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

...  profile 1..*uriSlice: Unordered, Open by value:value
Definition:
A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]].


Comments:
It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time.

...  profile
       (task-p210-m)
1..1uriFixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p210-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-p210-m

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

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


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

..  extension
     (reason)
1..1Task ReasonDefinition:
Indicates the reason for the current task's status or existence - used for reasons other than 'failed'


Comments:
Conformance Rule: This will contain the reason for the cancellation

...  url 1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
...  value[x] 1..1Shared Health CodeableConcept Text RequiredSlice: Unordered, Closed by type:$this
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


Comments:
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

..  extension
     (splitPrescriptionFlag)
0..1Task Split PrescriptionDefinition:
An extension, if true, indicates that a PMS Prescription has been split.

..  extension
     (splitPrescriptionReason)
0..1Task Split Prescription ReasonDefinition:
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..1Shared Health CodeableConcept CodeBinding: PrescriptionTaskType (20220913) (required)
Definition:
A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.


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

...  coding 1..*CodingSlice: Unordered, Open by value:system
Definition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriDefinition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
This is the URI that represents the coding system as defined within the binding.

....  code 1..1codeDefinition:
A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).


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

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

...  coding
       (taskCode)
1..*CodingDefinition:
A reference to a code defined by a terminology system.


Comments:
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

....  system 1..1uriFixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
Definition:
The identification of the code system that defines the meaning of the symbol in the code.


Comments:
Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype

....  code 1..1codeFixed Value: p210-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: p210-m

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

..  status 1..1codeBinding: TaskStatus (required): The current status of the task.


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


Comments:
Fixed value: completed

..  subject 1..1Reference(PrescribeIT® Dispense) {b}Definition:
The subject of 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 the reference to the MedicationDispense.id assigned by the Sending system. This is not a business identifier. Example: value='MedicationDispense/[guid]'

..  for 1..1Reference(Shared Health Patient) {b}Definition:
The entity who benefits from the performance of the service specified in the task (e.g., the patient).


Comments:
Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message)

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message

..  created 1..1dateTimecreated-full: Must be at least a full date. i.e. yyyy-mm-dd
Definition:
The date and time this task was created.


Comments:
This indicates when the request was created. This will generally be the same as the date of message construction.



Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored.



Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'

..  lastModified 1..1dateTimelastModified-full: Must be at least a full date. i.e. yyyy-mm-dd
Definition:
The date and time of last modification to this task.


Comments:
This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR.



Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'.



Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification.

..  creator 1..1Reference(Shared Health - eRx Service Location) {b}Definition:
The creator of the task.


Comments:
This is who is submitting the task and asking for it be done.



In the context of all PMS message this is the PrescribeIT® pharmacy that is responsible for initiating the message.

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the originating pharmacy Organization. This value will be returned from the Provider Registry Organization query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Organization/{CPRID}'

..  owner 1..1Reference(Shared Health Practitioner) {b}Definition:
The owner of this task. The participant who can execute this task.


Comments:
This is who is intended to receive/act on the task

...  reference 1..1stringDefinition:
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.


Comments:
This is a reference to the prescriber Practitioner being requested to act. This value will be returned from the Provider Registry Practitioner query. Example: value='https://{environmentSpecificHost}/{environmentAndContextSpecificPath}/Practitioner/{CPRID}'

..  input 0..1BackboneElementSlice: Unordered, Closed by value:name
Definition:
Inputs to the task.

..  input
     (PMSrequestedRx)
0..1BackboneElementMax Length: 1000
Definition:
Inputs to the task.


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..1stringFixed Value: pmsrequestedrx
Definition:
The name of the input parameter.


Comments:
Fixed value: pmsrequestedrx

...  value[x] 1..1PrescribeIT® Prescriber Prescription IdentifierDefinition:
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: 12 elements (2 nested mandatory elements)
Must-Support: 20 elements
Fixed Value: 5 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
  • 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task SI0..*PrescribeIT® Request from PMS TaskRX Dispense Notification
p210-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:task-p210-m S1..1uriProfiles this resource claims to conform to
Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p210-m
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... value[x] S1..1Shared Health CodeableConcept Text RequiredConcept - reference to a terminology or just text
... ext-task-split-prescription S0..1booleanTask Split Prescription?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription
... ext-task-split-prescription-reason S0..1Shared Health CodeableConcept Code Required with Text OptionalTask Split Prescription Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason
Binding: PrescriptionSplitReason (20210501) (required)
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
.... coding S1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:taskCode S1..*CodingCode defined by a terminology system
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... code S1..1codeSymbol in syntax defined by the system
Fixed Value: p210-m
... priority 0..0
... status S1..1codedraft | requested | received | accepted | +
Fixed Value: completed
... subject S1..1Reference(PrescribeIT® Dispense) {b}Dispense that was cancelled
.... reference S1..1stringRelative, internal or absolute URL reference
... input S0..1(Slice Definition)Task Input
Slice: Unordered, Closed by value:name
.... input:PMSrequestedRx S0..1BackboneElementTask Input
Max Length: 1000
..... name S1..1stringInput Name
Fixed Value: pmsrequestedrx
..... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierPMS Requested Rx Dispense Prescription
... output 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Task SI0..*PrescribeIT® Request from PMS TaskRX Dispense Notification
p210-1: IF splitPrescriptionFlag = TRUE, splitPrescriptionReason must be specified
... id SΣ1..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen the resource version last changed
.... profile SΣ1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:task-p210-m SΣ1..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-p210-m
.... tag Σ0..*CodingTags applied to this resource
Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"


... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension S0..*ExtensionExtension
Slice: Unordered, Open by value:url
... ext-task-group-identifier S1..1Shared Health IdentifierGroup Identifier
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier
... ext-task-reason S1..1CodeableConceptTask reason
URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
.... id 0..1idxml:id (or equivalent in JSON)
.... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.reason"
.... value[x] S1..1(Slice Definition)Concept - reference to a terminology or just text
Slice: Unordered, Closed by type:$this
..... value[x]:valueCodeableConcept 1..1CodeableConceptValue of extension
... ext-task-split-prescription S0..1booleanTask Split Prescription?
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription
... ext-task-split-prescription-reason S0..1Shared Health CodeableConcept Code Required with Text OptionalTask Split Prescription Reason
URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-split-prescription-reason
Binding: PrescriptionSplitReason (20210501) (required)
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier 0..1IdentifierTask Instance Identifier
... type S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionTaskType (20220913) (required)
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... coding SΣ1..*(Slice Definition)Code defined by a terminology system
Slice: Unordered, Open by value:system
..... coding:All Slices Content/Rules for all slices
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... coding:taskCode SΣ1..*CodingCode defined by a terminology system
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: p210-m
...... display SΣ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1stringTask Description
... performerType 0..*Codingrequester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer
Binding: TaskPerformerType (preferred): The type(s) of task performers allowed


... status SΣI1..1codedraft | requested | received | accepted | +
Binding: TaskStatus (required): The current status of the task.


Fixed Value: completed
... failureReason ΣI0..1CodeableConceptTask Failure Reason
... subject S1..1Reference(PrescribeIT® Dispense) {b}Dispense that was cancelled
.... 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
... for SΣ1..1Reference(Shared Health Patient) {b}Beneficiary of the Task
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... definition Σ0..1uriTask Definition
... created SI1..1dateTimeTask Creation Date
created-full: Must be at least a full date. i.e. yyyy-mm-dd
... lastModified SΣI1..1dateTimeTask Last Modified Date
lastModified-full: Must be at least a full date. i.e. yyyy-mm-dd
... creator S1..1Reference(Shared Health - eRx Service Location) {b}Task requestor
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... owner S1..1Reference(Shared Health Practitioner) {b}Task recipient
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... reference SΣI1..1stringRelative, internal or absolute URL reference
.... display Σ0..1stringText alternative for the resource
... parent 0..1Reference(Task)Composite task
... input S0..1(Slice Definition)Task Input
Slice: Unordered, Closed by value:name
.... input:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringInput Name
..... value[x] 1..1Input Value
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueBase64Binarybase64Binary
...... valueInstantinstant
...... valueStringstring
...... valueUriuri
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueCodecode
...... valueOidoid
...... valueIdid
...... valueUnsignedIntunsignedInt
...... valuePositiveIntpositiveInt
...... valueMarkdownmarkdown
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueIdentifierIdentifier
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueQuantityQuantity
...... valueRangeRange
...... valuePeriodPeriod
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueHumanNameHumanName
...... valueAddressAddress
...... valueContactPointContactPoint
...... valueTimingTiming
...... valueReferenceReference(Any)
...... valueMetaMeta
.... input:PMSrequestedRx S0..1BackboneElementTask Input

Max Length: 1000
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name S1..1stringInput Name
Fixed Value: pmsrequestedrx
..... value[x] S1..1PrescribeIT® Prescriber Prescription IdentifierPMS Requested Rx Dispense Prescription

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet / Code
Task.meta.tagexample
Task.languagerequiredhttp://tools.ietf.org/html/bcp47
Task.typerequiredPrescriptionTaskType
Task.performerTypepreferredTaskPerformerType
Task.statusrequiredFixed Value: completed

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