3.38 StructureDefinition: PrescribeIT™ base Task profile
The official URL for this profile is:
http://prescribeit.ca/fhir/StructureDefinition/profile-task
3.38.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 Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Task | 0..* | inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. Definition: A task to be performed. | |
 id | 1..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 | 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. |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (requisitionIdentifier) | 1..1 | Task Requisition ID | Definition: This is the common number that represents a paper order. It may be shared by multiple MedicationOrder, DeviceRequest and Task instances, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber Comments: Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. There are some business scenarios where a given task will be managed individually (eg cancel request). If a particular task is not part of a logical group, it will have its own requisition identifier (i.e. it will be handled as a group of 1). In other scenarios, the same requisition identifier is assigned to multiple tasks as they are considered to be part of a group. Example: medications that would be part of the same written paper Prescription or Renewal request will share the same Requisition Identifier. Usage Note: Tasks corresponding to different requisition identifiers may be present in the same Bundle. The recipient must take this into account when grouping content for display/actioning by requisition identifier. Suggested Structure: Assigned by the EMR; scoped by the application instance; this is an OID. An OID may be structured as Vendor.ApplicationInstance.RX#Branch Ext = Requisition Id. Conformance Rule: All task resources sharing a common requisition number must be transmitted in the same message bundle. Conformance Rule: All medication orders sharing the same requisition identifier in a renewal request must be viewed, managed and responded to together. Conformance Rule: Different task types can share a requisition identifier when a task was performed in the shared context of other tasks with the same requisition id. For example, medication 1 was discontinued in the same context that medication 2 was prescribed. Receiving systems SHOULD display/manage tasks that are part of the same requisition together when this is feasible. Conformance Rule: In the context of a 401 - Execute deferred (prescription) tasks from an EMR, this will map to the 'PrescribeIT™ RX ID' on the printed Patient Copy. Usage Note: Requisition ID would be used by PMS to establish which medications belong to the same prescription. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (required) Definition: The priority of the task among other tasks of the same type. Comments: This element does not apply to either Task p200-m - RX Dispense Notification or Task p210-m - RX Dispense Cancel Notification Conformance Rule: If one of the medications within a requisition is a high priority, the EMR should present the entire renewal request (based on requisision.id) as a high priority item within the queue. Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber. |
| status | 1..1 | code | Binding: TaskStatus (required) Definition: The current status of the task. Comments: This will be fixed based on the task code being used as the architecture calls for different tasks for each state rather than updating of existing tasks. |
| subject | 0..1 | Reference(Resource) | Definition: The subject of the task. |
| 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(Device | Organization | Patient | Practitioner | RelatedPerson) | Definition: The creator of the task. Comments: This is who is submitting the task and asking it be done |
This structure is derived from Task
Summary
Mandatory: 9 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-patient
Extensions
This structure refers to these extensions:
This structure is derived from Task
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Task | SI | 0..* | A task to be performed | |
 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..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example) |
| 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) | |
| text | I | 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-requisition-id | S | 1..1 | Shared Health Identifier | Prescription Number URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-requisition-id |
 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 (required) |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred) | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required) |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
 subject | S | 0..1 | Reference(Resource) | Focus of task |
| 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 | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Task requestor |
| owner | 0..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Task recipient | |
| parent | 0..1 | Reference(Task) | Composite task | |
| input | 0..* | BackboneElement | Task Input | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | 1..1 | string | Input Name | |
 value[x] | 1..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(), Meta | Input Value | |
| output | 0..* | BackboneElement | Task Output | |
 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 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(), Meta | Output Value | |
| Documentation for this format | ||||
Grid View
This structure is derived from Task
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Task | 0..* | inv-2: A Failure reason may be present only when a task has failed. inv-1: Last modified date must be greater than or equal to created date. Definition: A task to be performed. | |
| id | 1..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 | 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. |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url Definition: An Extension |
| extension (requisitionIdentifier) | 1..1 | Task Requisition ID | Definition: This is the common number that represents a paper order. It may be shared by multiple MedicationOrder, DeviceRequest and Task instances, reflecting multiple requests that are authorized simultaneously for a patient by a single prescriber Comments: Usage Note: This business identifier is assigned by the sending application and is used to group tasks together that need to be processed and managed together. There are some business scenarios where a given task will be managed individually (eg cancel request). If a particular task is not part of a logical group, it will have its own requisition identifier (i.e. it will be handled as a group of 1). In other scenarios, the same requisition identifier is assigned to multiple tasks as they are considered to be part of a group. Example: medications that would be part of the same written paper Prescription or Renewal request will share the same Requisition Identifier. Usage Note: Tasks corresponding to different requisition identifiers may be present in the same Bundle. The recipient must take this into account when grouping content for display/actioning by requisition identifier. Suggested Structure: Assigned by the EMR; scoped by the application instance; this is an OID. An OID may be structured as Vendor.ApplicationInstance.RX#Branch Ext = Requisition Id. Conformance Rule: All task resources sharing a common requisition number must be transmitted in the same message bundle. Conformance Rule: All medication orders sharing the same requisition identifier in a renewal request must be viewed, managed and responded to together. Conformance Rule: Different task types can share a requisition identifier when a task was performed in the shared context of other tasks with the same requisition id. For example, medication 1 was discontinued in the same context that medication 2 was prescribed. Receiving systems SHOULD display/manage tasks that are part of the same requisition together when this is feasible. Conformance Rule: In the context of a 401 - Execute deferred (prescription) tasks from an EMR, this will map to the 'PrescribeIT™ RX ID' on the printed Patient Copy. Usage Note: Requisition ID would be used by PMS to establish which medications belong to the same prescription. |
| type | 1..1 | Shared Health CodeableConcept Code | Binding: PrescriptionTaskType (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments: This will be a fixed code for each type of task. Review usage comments on child elements. |
| priority | 0..1 | code | Binding: PrescriptionTaskPriority (required) Definition: The priority of the task among other tasks of the same type. Comments: This element does not apply to either Task p200-m - RX Dispense Notification or Task p210-m - RX Dispense Cancel Notification Conformance Rule: If one of the medications within a requisition is a high priority, the EMR should present the entire renewal request (based on requisision.id) as a high priority item within the queue. Conformance Rule: For Task p166-m - RX Renewal Remindar, if the priority has escalated to high, the EMR must present this to the Prescriber. |
| status | 1..1 | code | Binding: TaskStatus (required) Definition: The current status of the task. Comments: This will be fixed based on the task code being used as the architecture calls for different tasks for each state rather than updating of existing tasks. |
| subject | 0..1 | Reference(Resource) | Definition: The subject of the task. |
| 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(Device | Organization | Patient | Practitioner | RelatedPerson) | Definition: The creator of the task. Comments: This is who is submitting the task and asking it be done |
This structure is derived from Task
Summary
Mandatory: 9 elements
Must-Support: 14 elements
Structures
This structure refers to these other structures:
- http://sharedhealth.exchange/fhir/StructureDefinition/dtprofile-codeableconcept-code
- http://sharedhealth.exchange/fhir/StructureDefinition/profile-patient
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Task
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Task | SI | 0..* | A task to be performed | |
| 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..* | uri | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: (unbound) (example) |
| 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) | |
| text | I | 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-requisition-id | S | 1..1 | Shared Health Identifier | Prescription Number URL: http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier profiled by http://prescribeit.ca/fhir/StructureDefinition/ext-task-requisition-id |
| 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 (required) |
| description | Σ | 0..1 | string | Task Description |
| performerType | 0..* | Coding | requester | dispatcher | scheduler | performer | monitor | manager | acquirer | reviewer Binding: TaskPerformerType (preferred) | |
| priority | S | 0..1 | code | normal | high Binding: PrescriptionTaskPriority (required) |
| status | SΣI | 1..1 | code | draft | requested | received | accepted | + Binding: TaskStatus (required) |
| failureReason | ΣI | 0..1 | CodeableConcept | Task Failure Reason |
| subject | S | 0..1 | Reference(Resource) | Focus of task |
| 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 | S | 1..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Task requestor |
| owner | 0..1 | Reference(Device | Organization | Patient | Practitioner | RelatedPerson) | Task recipient | |
| parent | 0..1 | Reference(Task) | Composite task | |
| input | 0..* | BackboneElement | Task Input | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| name | 1..1 | string | Input Name | |
| value[x] | 1..1 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(), Meta | Input Value | |
| output | 0..* | BackboneElement | Task Output | |
| 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 | boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference(), Meta | Output Value | |
| Documentation for this format | ||||
Other representations of profile: Schematron
3.38.3 Terminology Bindings
Terminology Bindings
| Path | Name | Conformance | ValueSet |
| Task.meta.security | All Security Labels | extensible | All Security Labels |
| Task.meta.tag | ?ext | example | |
| Task.language | ?ext | required | http://tools.ietf.org/html/bcp47 |
| Task.type | PrescriptionTaskType | required | PrescriptionTaskType |
| Task.performerType | TaskPerformerType | preferred | TaskPerformerType |
| Task.priority | PrescriptionTaskPriority | required | PrescriptionTaskPriority |
| Task.status | TaskStatus | required | TaskStatus |
3.38.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 | |
| 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 |