3.11 Extension: Referenced Business identifier
The official URL for this extension is:
http://sharedhealth.exchange/fhir/StructureDefinition/ext-reference-identifier
Status: draft
Extension maintained by:
Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL
Context of Use
This extension may be used on the following element(s):
- {"type"=>"Reference"}
Usage info
Usage:
- This Extension is not used in this Implementation Guide
3.11.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 Reference.identifier DSTU2 extension
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
 Extension | 0..1 | Reference.identifier DSTU2 extension | Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted. Usage Note: This provides the medication order identifier that the dispense is associated with Usage Note: In the context of p160 and p200, PMS's will populate this identifier value with the appropriate value Usage Note: In the context of p200, EMRs need to use this value to find the corresponding medication order in their local system in order to associate the incoming dispense it to. Usage Note: In the context of p160, EMRs can use either this value or the MedicationOrder.identifier:EMR-id to find the corresponding medication order in their local system which is related to the medication order which is asking to be renewed. 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-Reference.identifier" |
 value[x] | 1..1 | Shared Health Identifier | Slice: Unordered, Closed by type:$this Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted. Comments: In the context of a p200 this will represent the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which the dispense is associated with. In the context of a p160 this will represent either the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which is the dispense is associated with or it will be the pharmacies own medication order identifier when the dispense is associated with a previous non-electronic order (i.e. paper or fax). Usage: EMR's should use the identifier.system and identifier.value to determine whether medication order relates to an order within the local application. The identifier.system value represents the application (application instance id) that assigned the identifier and identifier.value represents the actual medication order value. When the system value does NOT match the local application then this identifier was assigned by another application and should be treated like a non-electronic (i.e. paper or fax) order. When the system value matches the local application then this identifier was assigned by this application and the system should then proceed to find the value. If the value cannot be found it should be treated like a non-electronic (i.e. paper or fax) order. Only when both the system and value match a local medication order can the application treat it as a electronic medication order. |
This structure is derived from Reference.identifier DSTU2 extension
This structure is derived from Reference.identifier DSTU2 extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
 Extension | 0..1 | Reference.identifier DSTU2 extension | Referenced identifier | |
 extension | 0..0 | |||
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
 value[x] | S | 1..1 | Shared Health Identifier | Referenced identifier |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Reference.identifier DSTU2 extension | Referenced identifier | |
 id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
 value[x] | S | 1..1 | (Slice Definition) | Referenced identifier Slice: Unordered, Closed by type:$this |
   value[x]:valueIdentifier | 1..1 | Identifier | Value of extension | |
| Documentation for this format | ||||
Grid View
This structure is derived from Reference.identifier DSTU2 extension
| Name | Card. | Type | Constraints and Usage |
|---|---|---|---|
| Extension | 0..1 | Reference.identifier DSTU2 extension | Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted. Usage Note: This provides the medication order identifier that the dispense is associated with Usage Note: In the context of p160 and p200, PMS's will populate this identifier value with the appropriate value Usage Note: In the context of p200, EMRs need to use this value to find the corresponding medication order in their local system in order to associate the incoming dispense it to. Usage Note: In the context of p160, EMRs can use either this value or the MedicationOrder.identifier:EMR-id to find the corresponding medication order in their local system which is related to the medication order which is asking to be renewed. 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-Reference.identifier" |
| value[x] | 1..1 | Shared Health Identifier | Slice: Unordered, Closed by type:$this Definition: Allows a reference to identify the target prescription, dispense or task by business identifier rather than URL Comments: When this is present, the reference is typically omitted. Comments: In the context of a p200 this will represent the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which the dispense is associated with. In the context of a p160 this will represent either the mediation order identifier of the original electronic prescription (e110, e120, e162, e163, e180) which is the dispense is associated with or it will be the pharmacies own medication order identifier when the dispense is associated with a previous non-electronic order (i.e. paper or fax). Usage: EMR's should use the identifier.system and identifier.value to determine whether medication order relates to an order within the local application. The identifier.system value represents the application (application instance id) that assigned the identifier and identifier.value represents the actual medication order value. When the system value does NOT match the local application then this identifier was assigned by another application and should be treated like a non-electronic (i.e. paper or fax) order. When the system value matches the local application then this identifier was assigned by this application and the system should then proceed to find the value. If the value cannot be found it should be treated like a non-electronic (i.e. paper or fax) order. Only when both the system and value match a local medication order can the application treat it as a electronic medication order. |
This structure is derived from Reference.identifier DSTU2 extension
Differential View
This structure is derived from Reference.identifier DSTU2 extension
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Reference.identifier DSTU2 extension | Referenced identifier | |
| extension | 0..0 | |||
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| value[x] | S | 1..1 | Shared Health Identifier | Referenced identifier |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Extension | 0..1 | Reference.identifier DSTU2 extension | Referenced identifier | |
| id | 0..1 | id | xml:id (or equivalent in JSON) | |
| url | S | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/extension-Reference.identifier" |
| value[x] | S | 1..1 | (Slice Definition) | Referenced identifier Slice: Unordered, Closed by type:$this |
| value[x]:valueIdentifier | 1..1 | Identifier | Value of extension | |
| Documentation for this format | ||||
Other representations of extension: Schematron
3.11.3 Terminology Bindings
3.11.4 Constraints
Constraints
| Id | Path | Details | Requirements |