3.78 StructureDefinition: Task e161-m - RX Renewal Response - Denied
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/task-e161-m
The following diagram depicts the overall structure of a RX Renewal Response (Denied and Under Review) and the relationships between resources. Each medication in the Renewal request MUST be responded to with either, a Denial, Approved, Approved with Changes or Under Review in the initial response. Further the Renewal response bundle MAY include one or more New RX orders that reference a medication in the Renewal request. This may be useful if the Prescriber is replacing a medication within the request with a different medication as the Pharmacist will have the complete overview of the patient treatment in one response. This task includes an optional recorder that will be used when authorized non-prescribing clinic staff (e.g. Medical Office Assistant) are creating the response on behalf of the prescriber.
Conformance rules specific to this task may exist. Refer to the Business Rules.
3.78.2 Formal Views of Profile Content
Download Excel representation
Description of Profiles, Differentials, Snapshots and how the different presentations work.
>
This structure is derived from PrescribeIT® Response from EMR Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Task | 0..* | PrescribeIT® Response from EMR 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. creator-not-recorder: IF recorder exists, creator MUST not be recorder Definition: A task to be performed. |
 id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the requesting application. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
 profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. |
 profile(task-e161-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e161-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-e161-m |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (groupIdentifier) | 1..1 | Task Group Identifier | Definition: This is the common identifier that represents a paper order. It may be shared by multiple Task instances for various Medication Orders, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber Comments: Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. The following scenarios provide further detail: Scenario 1) Single Task allowed within a Bundle: There are some business scenarios where a given task will be managed individually and only a single task is allowed in a bundle. This is true for the Adapt (p170) and the Pharmacist Prescribe (p190). Multiple tasks of the same type are not allowed, nor are any other task type. Scenario 2) Single Task is sent. For any task type, the source system may send a single task within the bundle. Scenario 3) In either scenario 1 or 2, the task will be assigned its own Group Identifier and will be handled as a group of one. Scenario 4) Bundle restricted to same task type only: There are cases when only tasks of the same type can be grouped together. This is true for the cancel request (e140), Dispense Notifications (p200), Cancel RX Dispense Notification (p210). In this scenario, no other task types are allowed within the bundle. Scenario 5) Same or Mixed Task Types within a single group: There are cases when either all the tasks within a group happen to have the same task type (p160) which are not necessary restricted due to 4 or certain task types that are different can be grouped together. This is true for new (e110) and renewal (e120) where these are part of the same prescription. Another scenario is that renewal responses (e161, e162, e163, e164) may be sent with an e110 and/or an e120. Scenario 6) In either scenario 4 and 5, the same Group Identifier must be assigned to the multiple tasks as they are all part of the same group. All task resources sharing a Group Identifier must be transmitted in the same message bundle and should be treated as a group by the receiving system. Scenario 7) The p160 task type can only be sent within it's own bundle. Multiple Group Identifiers within the same Bundle is not allowed. The Task.extension:groupIdentifier.valueIdentifier.system element will be an OID of the form [Vendor root].[Application instance node].3 expressed as a uri (e.g. urn:oid:1.2.3.4). The branch “.3” is appended to create a unique namespace for the Group Identifer. The Task.extension:groupIdentifier.valueIdentifier.value element will be assigned by the sending system and must be a unique business identifier. |
| extension (basedOn) | 1..1 | Task Order Based On | Definition: Identifies a request, plan or proposal that drove the creation of this task Comments: Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information. |
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| value[x] | 1..1 | Reference() | Slice: Unordered, Closed by type:$this Definition: The identifier of the request task that this task was created based on Comments: Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the Task.id for the task being responded to |
 value[x](valueReference) | 1..1 | Reference() {r} | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Comments: Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the Task.id for the task being responded to |
 extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (multipleResponse) | 0..1 | Task Multiple Response | Definition: If true, indicates that a EMR Prescription has multiple responses. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Conformance Rule: This shall be the Task.id of the request task being responded to, expressed as a uri (i.e. urn:uuid:[original task id]) |
| extension (reason) | 1..1 | Task Reason | Definition: Indicates the reason for the current task's status or existence - used for reasons other than 'failed' Comments: Conformance Rule: A reason MUST be provided so the Pharmacy can determine the appropriate action to take. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Slice: Unordered, Closed by type:$this Binding: PrescriptionRenewalRejectReason (20210501) (required) 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. |
| value[x] (valueCodeableConcept) | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | 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. |
| coding | 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 | 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 | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| text | 0..1 | string | Max Length: 2500 Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Comments: Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner |
| extension (recorder) | 0..1 | Task Recorder | Definition: Indicates who was responsible for recording the task if other than the requester Comments: Conformance Rule: This must only be populated when the MOA is responding with either Task e161-m (Denied) or e164-m (Under Review). When this occurs, Task.creator must not reference the SAML Practitioner profile but rather the Shared Health Practitioner profile. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20190315) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
 system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
 code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
| coding (taskCode) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | 1..1 | code | Fixed Value: e161-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: e161-m |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (20190415) (required) Definition: The priority of the task among other tasks of the same type. Comments: This element does not apply to Tasks p170-m (Pharmacist Adapt), p200-m (RX Dispense Notification), and p210-m (RX Dispense Cancel Notification) Conformance Rule: If one of the medications within a group is a high priority, the EMR should present the entire renewal request (based on Group Identifier) as a high priority item within the queue. Conformance Rule: For Tasks p141-m (Cancel RX Request Denied) and p143-m (Cancel RX Remaining Fills Revoked) the priority must be set to high. Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber. |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. Fixed Value: rejected Definition: The current status of the task. Comments: Fixed value: rejected |
| subject | 1..1 | Reference(PrescribeIT® Prescription) {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: Conformance Rule: This is the reference to the Medication Order resource id. This is not a business identifier. Example: value='MedicationOrder/[guid].' Conformance Rule: The Medication Order reference must be for the Medication Order that is being Denied or Under Review (i.e. the Medication Order requested by the pharmacy as part of the Renewal Request p160). |
| for | 1..1 | Reference(Shared Health Patient) {b} | Definition: The entity who benefits from the performance of the service specified in the task (e.g., the patient). Comments: Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message) |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message |
| created | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time this task was created. Comments: This indicates when the request was created. This will generally be the same as the date of message construction. Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00' |
| lastModified | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time of last modification to this task. Comments: This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'. Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification. |
| creator | 1..1 | Reference(Shared Health Practitioner | Shared Health SAML Practitioner) {b} | Definition: The creator of the task. Comments: Conformance Rule: The Shared Health Practitioner is used when the practitioner is responding but does not have a SAML or when the MOA is identified as the Task.extension(recorder). When a recorder is present the Task.creator represents the practitioner for which the MOA is responding on behalf of. |
| 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: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| owner | 1..1 | Reference(Shared Health - eRx Service Location) {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 pharmacy Organization being responded to. This value should echo the Task.creator from the request task being responded to. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/CPRID' |
| output | 0..5 | BackboneElement | Slice: Unordered, Closed by value:name Definition: Outputs produced by the Task. |
| output (newRx) | 0..5 | BackboneElement | Definition: The active prescription that is taking the place of the prescription for which renewal had been requested |
| extension (drugName) | 1..1 | Task Drug Name | Definition: The name of the New Rx drug. |
| extension (taskReference) | 1..1 | Task NewRx Reference | Definition: The local reference for the Task corresponding to the prescription that was created to replace the prescription that was the target of the renewal. |
| name | 1..1 | string | Fixed Value: newRx Definition: The name of the Output parameter. Comments: Fixed value: newRx |
| value[x] | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Definition: The business identifier of the prescription that was created to replace the prescription that was the target of the renewal Comments: This is a reference by business identifier, not by resource id |
This structure is derived from PrescribeIT® Response from EMR Task
Summary
Mandatory: 15 elements (4 nested mandatory elements)
Must-Support: 25 elements
Fixed Value: 5 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-saml
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-drug-name
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-newrx-reference
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.output is sliced based on the value of value:name (Closed)
This structure is derived from PrescribeIT® Response from EMR Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Task | I | 0..* | PrescribeIT® Response from EMR Task | RX Renewal Response - Denied creator-not-recorder: IF recorder exists, creator MUST not be recorder |
 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-e161-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e161-m |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
 value[x] | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionRenewalRejectReason (20210501) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| coding | S | 1..* | Coding | Code defined by a terminology system |
| display | S | 1..1 | string | Representation defined by the system |
| ext-task-recorder | SI | 0..1 | Reference(Shared Health Non-Clinician Practitioner) {b} | Task reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder |
| 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: e161-m |
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: rejected |
 subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription whose renewal is rejected |
| reference | S | 1..1 | string | Relative, internal or absolute URL reference |
| creator | SI | 1..1 | Reference(Shared Health Practitioner | Shared Health SAML Practitioner) {b} | Task requestor |
| reference | S | 1..1 | string | Relative, internal or absolute URL reference |
| input | 0..0 | |||
| output | S | 0..5 | (Slice Definition) | Task Output Slice: Unordered, Closed by value:name |
| output:newRx | S | 0..5 | BackboneElement | Replacement prescription |
| ext-task-drug-name | S | 1..1 | string | new Prescription drug name URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-drug-name |
| ext-task-newrx-reference | S | 1..1 | Reference(PrescribeIT® base Task profile) {b} | Extension URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-newrx-reference |
| name | S | 1..1 | string | Output Name Fixed Value: newRx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Replacement Prescription |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Response from EMR Task | RX Renewal Response - Denied creator-not-recorder: IF recorder exists, creator MUST not be recorder |
 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-e161-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e161-m |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-group-identifier | S | 1..1 | Shared Health Identifier | Group Identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier |
| ext-task-basedon | S | 1..1 | Reference() | Plan, request or referral URL: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-basedon |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| value[x] | S | 1..1 | (Slice Definition) | e-Renewal request Slice: Unordered, Closed by type:$this |
| value[x]:valueReference | S | 1..1 | Reference() {r} | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-multiple-response | S | 0..1 | boolean | Task Multiple Response? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-multiple-response |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | S | 1..1 | (Slice Definition) | Concept - reference to a terminology or just text Slice: Unordered, Closed by type:$this Binding: PrescriptionRenewalRejectReason (20210501) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 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 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
| ext-task-recorder | SI | 0..1 | Reference(Shared Health Non-Clinician Practitioner) {b} | Task reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..1 | Identifier | Task Instance Identifier | |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20190315) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:All Slices | Content/Rules for all slices | |||
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:taskCode | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: e161-m |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (20190415) (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: rejected |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription whose renewal is rejected |
| 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 created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | SI | 1..1 | Reference(Shared Health Practitioner | Shared Health SAML Practitioner) {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 - eRx Service Location) {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 | |
| output | S | 0..5 | (Slice Definition) | Task Output Slice: Unordered, Closed by value:name |
| output: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 | Output Name | |
 value[x] | 1..1 | Output 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 | |||
| output:newRx | S | 0..5 | BackboneElement | Replacement prescription |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-task-drug-name | S | 1..1 | string | new Prescription drug name URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-drug-name |
| ext-task-newrx-reference | S | 1..1 | Reference(PrescribeIT® base Task profile) {b} | Extension URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-newrx-reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | S | 1..1 | string | Output Name Fixed Value: newRx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Replacement Prescription |
| Documentation for this format | ||||
Grid View
This structure is derived from PrescribeIT® Response from EMR Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Task | 0..* | PrescribeIT® Response from EMR 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. creator-not-recorder: IF recorder exists, creator MUST not be recorder Definition: A task to be performed. |
| id | 1..1 | id | Definition: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. Comments: Usage Note: This will usually be a GUID and is assigned by the requesting application. |
| meta | 1..1 | Meta | Definition: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
| profile | 1..* | uri | Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. |
| profile (task-e161-m) | 1..1 | uri | Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e161-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-e161-m |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (groupIdentifier) | 1..1 | Task Group Identifier | Definition: This is the common identifier that represents a paper order. It may be shared by multiple Task instances for various Medication Orders, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber Comments: Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. The following scenarios provide further detail: Scenario 1) Single Task allowed within a Bundle: There are some business scenarios where a given task will be managed individually and only a single task is allowed in a bundle. This is true for the Adapt (p170) and the Pharmacist Prescribe (p190). Multiple tasks of the same type are not allowed, nor are any other task type. Scenario 2) Single Task is sent. For any task type, the source system may send a single task within the bundle. Scenario 3) In either scenario 1 or 2, the task will be assigned its own Group Identifier and will be handled as a group of one. Scenario 4) Bundle restricted to same task type only: There are cases when only tasks of the same type can be grouped together. This is true for the cancel request (e140), Dispense Notifications (p200), Cancel RX Dispense Notification (p210). In this scenario, no other task types are allowed within the bundle. Scenario 5) Same or Mixed Task Types within a single group: There are cases when either all the tasks within a group happen to have the same task type (p160) which are not necessary restricted due to 4 or certain task types that are different can be grouped together. This is true for new (e110) and renewal (e120) where these are part of the same prescription. Another scenario is that renewal responses (e161, e162, e163, e164) may be sent with an e110 and/or an e120. Scenario 6) In either scenario 4 and 5, the same Group Identifier must be assigned to the multiple tasks as they are all part of the same group. All task resources sharing a Group Identifier must be transmitted in the same message bundle and should be treated as a group by the receiving system. Scenario 7) The p160 task type can only be sent within it's own bundle. Multiple Group Identifiers within the same Bundle is not allowed. The Task.extension:groupIdentifier.valueIdentifier.system element will be an OID of the form [Vendor root].[Application instance node].3 expressed as a uri (e.g. urn:oid:1.2.3.4). The branch “.3” is appended to create a unique namespace for the Group Identifer. The Task.extension:groupIdentifier.valueIdentifier.value element will be assigned by the sending system and must be a unique business identifier. |
| extension (basedOn) | 1..1 | Task Order Based On | Definition: Identifies a request, plan or proposal that drove the creation of this task Comments: Usage Note: The URL for this extension does not refer to an existing web-page as is a pre-adoption extension. Refer to the Shared Health implementation Guide for more information. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| value[x] | 1..1 | Reference() | Slice: Unordered, Closed by type:$this Definition: The identifier of the request task that this task was created based on Comments: Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the Task.id for the task being responded to |
| value[x] (valueReference) | 1..1 | Reference() {r} | Definition: Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list). Comments: Conformance Rule: The will be a URN (form urn:uuid:[guid]) containing the Task.id for the task being responded to |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (multipleResponse) | 0..1 | Task Multiple Response | Definition: If true, indicates that a EMR Prescription has multiple responses. |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: Conformance Rule: This shall be the Task.id of the request task being responded to, expressed as a uri (i.e. urn:uuid:[original task id]) |
| extension (reason) | 1..1 | Task Reason | Definition: Indicates the reason for the current task's status or existence - used for reasons other than 'failed' Comments: Conformance Rule: A reason MUST be provided so the Pharmacy can determine the appropriate action to take. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Slice: Unordered, Closed by type:$this Binding: PrescriptionRenewalRejectReason (20210501) (required) 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. |
| value[x] (valueCodeableConcept) | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | 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. |
| coding | 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 | 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 | 1..1 | string | Definition: A representation of the meaning of the code in the system, following the rules of the system. |
| text | 0..1 | string | Max Length: 2500 Definition: A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. Comments: Conformance Rule: This is the text used to convey the exact word that was displayed to the practitioner |
| extension (recorder) | 0..1 | Task Recorder | Definition: Indicates who was responsible for recording the task if other than the requester Comments: Conformance Rule: This must only be populated when the MOA is responding with either Task e161-m (Denied) or e164-m (Under Review). When this occurs, Task.creator must not reference the SAML Practitioner profile but rather the Shared Health Practitioner profile. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (20190315) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| coding | 1..* | Coding | Slice: Unordered, Open by value:system Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: This is the URI that represents the coding system as defined within the binding. |
| code | 1..1 | code | Definition: A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Comments: This is the code as defined within the binding. |
| coding (taskCode) | 1..* | Coding | Definition: A reference to a code defined by a terminology system. Comments: Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true. |
| system | 1..1 | uri | Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| code | 1..1 | code | Fixed Value: e161-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: e161-m |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (20190415) (required) Definition: The priority of the task among other tasks of the same type. Comments: This element does not apply to Tasks p170-m (Pharmacist Adapt), p200-m (RX Dispense Notification), and p210-m (RX Dispense Cancel Notification) Conformance Rule: If one of the medications within a group is a high priority, the EMR should present the entire renewal request (based on Group Identifier) as a high priority item within the queue. Conformance Rule: For Tasks p141-m (Cancel RX Request Denied) and p143-m (Cancel RX Remaining Fills Revoked) the priority must be set to high. Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber. |
| status | 1..1 | code | Binding: TaskStatus (required): The current status of the task. Fixed Value: rejected Definition: The current status of the task. Comments: Fixed value: rejected |
| subject | 1..1 | Reference(PrescribeIT® Prescription) {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: Conformance Rule: This is the reference to the Medication Order resource id. This is not a business identifier. Example: value='MedicationOrder/[guid].' Conformance Rule: The Medication Order reference must be for the Medication Order that is being Denied or Under Review (i.e. the Medication Order requested by the pharmacy as part of the Renewal Request p160). |
| for | 1..1 | Reference(Shared Health Patient) {b} | Definition: The entity who benefits from the performance of the service specified in the task (e.g., the patient). Comments: Identifies the patient tied to the task. (FHIR prohibits inheritance of context, so this must be explicitly declared rather than inferred from the presence of the Patient resource in the message) |
| reference | 1..1 | string | Definition: A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. Comments: This is a reference to the Patient associated with the task. It will be a URN pointing to the id of the patient record in the message |
| created | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time this task was created. Comments: This indicates when the request was created. This will generally be the same as the date of message construction. Conformance Rule: Date-Time must be specified down to the day. Time is optional and may be ignored. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00' |
| lastModified | 1..1 | dateTime | created-full: Must be at least a full date. i.e. yyyy-mm-dd Definition: The date and time of last modification to this task. Comments: This is required by FHIR but is not needed. It should generally be set to the same value as Task.created. This is the date of the most recent transaction as recorded in the EMR. Usage Note: If time is present, FHIR requires the UTC offset and for time to be specified down to the seconds. If seconds aren't available, they may be filled with '00'. Conformance Rule: PMS is not expected to display this date as it is irrelevant to the Pharmacist or to the processing of the discontinue notification. |
| creator | 1..1 | Reference(Shared Health Practitioner | Shared Health SAML Practitioner) {b} | Definition: The creator of the task. Comments: Conformance Rule: The Shared Health Practitioner is used when the practitioner is responding but does not have a SAML or when the MOA is identified as the Task.extension(recorder). When a recorder is present the Task.creator represents the practitioner for which the MOA is responding on behalf of. |
| 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: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
| owner | 1..1 | Reference(Shared Health - eRx Service Location) {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 pharmacy Organization being responded to. This value should echo the Task.creator from the request task being responded to. Example: value='https://EnvironmentSpecificHost/EnvironmentAndContextSpecificPathRegistry/Organization/CPRID' |
| output | 0..5 | BackboneElement | Slice: Unordered, Closed by value:name Definition: Outputs produced by the Task. |
| output (newRx) | 0..5 | BackboneElement | Definition: The active prescription that is taking the place of the prescription for which renewal had been requested |
| extension (drugName) | 1..1 | Task Drug Name | Definition: The name of the New Rx drug. |
| extension (taskReference) | 1..1 | Task NewRx Reference | Definition: The local reference for the Task corresponding to the prescription that was created to replace the prescription that was the target of the renewal. |
| name | 1..1 | string | Fixed Value: newRx Definition: The name of the Output parameter. Comments: Fixed value: newRx |
| value[x] | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Definition: The business identifier of the prescription that was created to replace the prescription that was the target of the renewal Comments: This is a reference by business identifier, not by resource id |
This structure is derived from PrescribeIT® Response from EMR Task
Summary
Mandatory: 15 elements (4 nested mandatory elements)
Must-Support: 25 elements
Fixed Value: 5 elements
Prohibited: 1 element
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code-required-with-text
- http://prescribeit.ca/fhir/StructureDefinition/profile-medicationorder
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-practitioner-saml
- http://prescribeit.ca/fhir/StructureDefinition/dtprofile-identifier-prescription
Extensions
This structure refers to these extensions:
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-drug-name
- http://prescribeit.ca/fhir/StructureDefinition/ext-task-newrx-reference
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.output is sliced based on the value of value:name (Closed)
Differential View
This structure is derived from PrescribeIT® Response from EMR Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Response from EMR Task | RX Renewal Response - Denied creator-not-recorder: IF recorder exists, creator MUST not be recorder |
| 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-e161-m | S | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e161-m |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
| value[x] | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text Binding: PrescriptionRenewalRejectReason (20210501) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| coding | S | 1..* | Coding | Code defined by a terminology system |
| display | S | 1..1 | string | Representation defined by the system |
| ext-task-recorder | SI | 0..1 | Reference(Shared Health Non-Clinician Practitioner) {b} | Task reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder |
| 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: e161-m |
| status | S | 1..1 | code | draft | requested | received | accepted | + Fixed Value: rejected |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription whose renewal is rejected |
| reference | S | 1..1 | string | Relative, internal or absolute URL reference |
| creator | SI | 1..1 | Reference(Shared Health Practitioner | Shared Health SAML Practitioner) {b} | Task requestor |
| reference | S | 1..1 | string | Relative, internal or absolute URL reference |
| input | 0..0 | |||
| output | S | 0..5 | (Slice Definition) | Task Output Slice: Unordered, Closed by value:name |
| output:newRx | S | 0..5 | BackboneElement | Replacement prescription |
| ext-task-drug-name | S | 1..1 | string | new Prescription drug name URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-drug-name |
| ext-task-newrx-reference | S | 1..1 | Reference(PrescribeIT® base Task profile) {b} | Extension URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-newrx-reference |
| name | S | 1..1 | string | Output Name Fixed Value: newRx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Replacement Prescription |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | I | 0..* | PrescribeIT® Response from EMR Task | RX Renewal Response - Denied creator-not-recorder: IF recorder exists, creator MUST not be recorder |
| 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-e161-m | SΣ | 1..1 | uri | Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/task-e161-m |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language. | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-group-identifier | S | 1..1 | Shared Health Identifier | Group Identifier URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier |
| ext-task-basedon | S | 1..1 | Reference() | Plan, request or referral URL: http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-basedon |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.basedOn" |
| value[x] | S | 1..1 | (Slice Definition) | e-Renewal request Slice: Unordered, Closed by type:$this |
| value[x]:valueReference | S | 1..1 | Reference() {r} | Value of extension |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | S | 0..* | Extension | Extension Slice: Unordered, Open by value:url |
| ext-task-multiple-response | S | 0..1 | boolean | Task Multiple Response? URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-multiple-response |
| reference | SΣI | 1..1 | string | Relative, internal or absolute URL reference |
| display | Σ | 0..1 | string | Text alternative for the resource |
| ext-task-reason | S | 1..1 | CodeableConcept | Task reason URL: http://hl7.org/fhir/StructureDefinition/extension-Task.reason profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-reason |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.reason" |
| value[x] | S | 1..1 | (Slice Definition) | Concept - reference to a terminology or just text Slice: Unordered, Closed by type:$this Binding: PrescriptionRenewalRejectReason (20210501) (required) |
| value[x]:valueCodeableConcept | S | 1..1 | Shared Health CodeableConcept Code Required with Text Optional | Concept - reference to a terminology or just text |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | 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 |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | SΣ | 1..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | SΣ | 0..1 | string | Plain text representation of the concept Max Length: 2500 |
| ext-task-recorder | SI | 0..1 | Reference(Shared Health Non-Clinician Practitioner) {b} | Task reason URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | 0..1 | Identifier | Task Instance Identifier | |
| type | S | 1..1 | Shared Health CodeableConcept Code | Concept - reference to a terminology or just text Binding: PrescriptionTaskType (20190315) (required) |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| coding | SΣ | 1..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:All Slices | Content/Rules for all slices | |||
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| coding:taskCode | SΣ | 1..* | Coding | Code defined by a terminology system |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/prescriptiontasktype |
| version | Σ | 0..1 | string | Version of the system - if relevant |
| code | SΣ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: e161-m |
| display | Σ | 0..1 | string | Representation defined by the system |
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user |
| text | Σ | 0..1 | string | Plain text representation of the concept |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred): The type(s) of task performers allowed | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (20190415) (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required): The current status of the task. Fixed Value: rejected |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 1..1 | Reference(PrescribeIT® Prescription) {b} | Prescription whose renewal is rejected |
| 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 created-full: Must be at least a full date. i.e. yyyy-mm-dd |
| creator | SI | 1..1 | Reference(Shared Health Practitioner | Shared Health SAML Practitioner) {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 - eRx Service Location) {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 | |
| output | S | 0..5 | (Slice Definition) | Task Output Slice: Unordered, Closed by value:name |
| output: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 | Output Name | |
| value[x] | 1..1 | Output 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 | |||
| output:newRx | S | 0..5 | BackboneElement | Replacement prescription |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ext-task-drug-name | S | 1..1 | string | new Prescription drug name URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-drug-name |
| ext-task-newrx-reference | S | 1..1 | Reference(PrescribeIT® base Task profile) {b} | Extension URL: http://prescribeit.ca/fhir/StructureDefinition/ext-task-newrx-reference |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | S | 1..1 | string | Output Name Fixed Value: newRx |
| value[x] | S | 1..1 | PrescribeIT® Prescriber Prescription Identifier | Replacement Prescription |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.78.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet / Code |
| Task.meta.tag | example | |
| Task.language | required | http://tools.ietf.org/html/bcp47 |
| Task.extension:reason.value[x] | required | PrescriptionRenewalRejectReason |
| Task.type | required | PrescriptionTaskType |
| Task.performerType | preferred | TaskPerformerType |
| Task.priority | required | PrescriptionTaskPriority |
| Task.status | required | Fixed Value: rejected |
3.78.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 | |
| creator-not-recorder | Task | IF recorder exists, creator MUST not be recorder : extension('http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder').exists() implies (creator.reference != extension('http://prescribeit.ca/fhir/StructureDefinition/ext-task-recorder').value.reference) | |
| created-full | Task.created | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 | |
| created-full | Task.lastModified | Must be at least a full date. i.e. yyyy-mm-dd : length()>=10 |