PrescribeIT® Specification and Guide Version 5.0

 

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:

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

NameCard.TypeConstraints and Usage
.  Extension 0..1Task.groupIdentifier DSTU2 extensionDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier"
..  value[x]
     (valueIdentifier)
1..1Shared Health IdentifierDefinition:
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..1urigroupIdentifier-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..1stringExample' 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

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Task.groupIdentifier DSTU2 extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Task.groupIdentifier DSTU2 extensionGroup Identifier
... extension 0..0
... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier"
... value[x]:valueIdentifier S1..1Shared Health IdentifierAn identifier intended for computation
.... system SI1..1uriThe namespace for the identifier
groupIdentifier-branch-3: This must be an OID ending in .3

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Task.groupIdentifier DSTU2 extensionGroup Identifier
... id 0..1idxml:id (or equivalent in JSON)
... url S1..1uri"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 S1..1Shared Health IdentifierAn identifier intended for computation
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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ΣI1..1uriThe 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..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

Grid View

This structure is derived from Task.groupIdentifier DSTU2 extension

NameCard.TypeConstraints and Usage
.  Extension 0..1Task.groupIdentifier DSTU2 extensionDefinition:
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..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier"
..  value[x]
     (valueIdentifier)
1..1Shared Health IdentifierDefinition:
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..1urigroupIdentifier-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..1stringExample' 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

Summary

Mandatory: 3 elements
Must-Support: 3 elements
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Task.groupIdentifier DSTU2 extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Task.groupIdentifier DSTU2 extensionGroup Identifier
... extension 0..0
... url S1..1uri"http://hl7.org/fhir/StructureDefinition/extension-Task.groupIdentifier"
... value[x]:valueIdentifier S1..1Shared Health IdentifierAn identifier intended for computation
.... system SI1..1uriThe namespace for the identifier
groupIdentifier-branch-3: This must be an OID ending in .3

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..1Task.groupIdentifier DSTU2 extensionGroup Identifier
... id 0..1idxml:id (or equivalent in JSON)
... url S1..1uri"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 S1..1Shared Health IdentifierAn identifier intended for computation
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ0..1CodeableConceptDescription 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ΣI1..1uriThe 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..1stringThe value that is unique
Example General: 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)

doco Documentation for this format

 

Other representations of extension: Schematron

3.62.3 Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Extension.value[x]:valueIdentifier.userequiredIdentifierUse
Extension.value[x]:valueIdentifier.typeextensibleIdentifier Type Codes

Constraints

IdPathDetailsRequirements
groupIdentifier-branch-3Extension.value[x]:valueIdentifier.systemThis must be an OID ending in .3
: $this.matches('^urn\\:oid\\:(\\d+\\.)+3$')