3.34 Extension: Task Group Identifier
The official URL for this extension is:
http://prescribeit.ca/fhir/StructureDefinition/ext-task-group-identifier
Status: draft
Extension maintained by:
The group that this particular task was initiated as part of
Context of Use
This extension may be used on the following element(s):
- {"type"=>"Task"}
Usage info
Usage:
- Use this Extension: PrescribeIT® Deferred Request from EMR Task, PrescribeIT® Request from EMR Task, PrescribeIT® Response from EMR Task, PrescribeIT® Request from PMS Task, PrescribeIT® Response from PMS Task, PrescribeIT® Request Task profile, PrescribeIT® Response Task profile, PrescribeIT® base Task profile, Task e110-m - New RX Fill Request, Task e120-m - Renewal RX Fill Request, Task e140-m - Cancel RX Fill Request, Task e161-m - RX Renewal Response - Denied, Task e162-m - RX Renewal Response - Approved, Task e163-m - RX Renewal Response - Approved with Changes, Task e164-m - RX Renewal Response - Under Review, Task e180-m - Deferred RX Fill Request, Task p141-m - Cancel RX Request Denied, Task p142-m - Cancel RX Request Approved, Task p143-m - Cancel RX Remaining Fills Revoked, Task p160-m - RX Renewal Create Request, Task p170-m - Pharmacist Adapt, Task p190-m - Pharmacist Prescribe, Task p200-m - RX Dispense Notification, Task p210-m - RX Dispense Cancel Notification
3.34.2 Formal Views of Extension Content
Download Excel representation
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Task.groupIdentifier DSTU2 extension
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Extension | 0..1 | Task.groupIdentifier DSTU2 extension | 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. |
 url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier" |
 value[x](valueIdentifier) | 1..1 | Shared Health Identifier | Definition: The group that this particular task was initiated as part of Comments: Links multiple separate MedicationOrder, DeviceRequest and other requests that originated at the same time. In PrescribeIT® v2.0, this was formerly called Requisition Identifier. |
  system | 1..1 | uri | groupIdentifier-branch-3: This must be an OID ending in .3 Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Definition: Establishes the namespace in which set of possible id values is unique. |
 value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
This structure is derived from Task.groupIdentifier DSTU2 extension
This structure is derived from Task.groupIdentifier DSTU2 extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Extension | 0..1 | Task.groupIdentifier DSTU2 extension | Group Identifier | |
 extension | 0..0 | |||
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier" |
 value[x]:valueIdentifier | S | 1..1 | Shared Health Identifier | An identifier intended for computation |
| system | SI | 1..1 | uri | The namespace for the identifier groupIdentifier-branch-3: This must be an OID ending in .3 |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Task.groupIdentifier DSTU2 extension | Group Identifier | |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier" |
 value[x] | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
 value[x]:valueIdentifier | S | 1..1 | Shared Health Identifier | An identifier intended for computation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
 type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | SΣI | 1..1 | uri | The namespace for the identifier groupIdentifier-branch-3: This must be an OID ending in .3 Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Grid View
This structure is derived from Task.groupIdentifier DSTU2 extension
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Extension | 0..1 | Task.groupIdentifier DSTU2 extension | 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. |
| url | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier" |
| value[x] (valueIdentifier) | 1..1 | Shared Health Identifier | Definition: The group that this particular task was initiated as part of Comments: Links multiple separate MedicationOrder, DeviceRequest and other requests that originated at the same time. In PrescribeIT® v2.0, this was formerly called Requisition Identifier. |
| system | 1..1 | uri | groupIdentifier-branch-3: This must be an OID ending in .3 Example' General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Definition: Establishes the namespace in which set of possible id values is unique. |
| value | 1..1 | string | Example' General': 123456 Definition: The portion of the identifier typically relevant to the user and which is unique within the context of the system. Comments: If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. |
This structure is derived from Task.groupIdentifier DSTU2 extension
Differential View
This structure is derived from Task.groupIdentifier DSTU2 extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Task.groupIdentifier DSTU2 extension | Group Identifier | |
| extension | 0..0 | |||
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier" |
| value[x]:valueIdentifier | S | 1..1 | Shared Health Identifier | An identifier intended for computation |
| system | SI | 1..1 | uri | The namespace for the identifier groupIdentifier-branch-3: This must be an OID ending in .3 |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Task.groupIdentifier DSTU2 extension | Group Identifier | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier" |
| value[x] | 1..1 | (Slice Definition) | Value of extension Slice: Unordered, Closed by type:$this | |
| value[x]:valueIdentifier | S | 1..1 | Shared Health Identifier | An identifier intended for computation |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
| system | SΣI | 1..1 | uri | The namespace for the identifier groupIdentifier-branch-3: This must be an OID ending in .3 Example General: http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| Documentation for this format | ||||
Other representations of extension: Schematron
3.34.3 Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Extension.value[x]:valueIdentifier.use | required | IdentifierUse |
| Extension.value[x]:valueIdentifier.type | extensible | Identifier Type Codes |
3.34.4 Constraints
Constraints
| Id | Path | Details | Requirements |
| groupIdentifier-branch-3 | Extension.value[x]:valueIdentifier.system | This must be an OID ending in .3 : $this.matches('^urn\\:oid\\:(\\d+\\.)+3$') |