3.97 PrescribeIT® Switch
PrescribeIT® Switch
(Requirements Definition)
http://prescribeit.ca/fhir/Conformance/conformance-erx-sdf Published: 2016-06-03 (draft)
Published by: Shared Health
This role defines the capabilities of the Shared Health messaging hub. The hub or inbox serves as a secure repository for delivering messages between electronic medical records (EMRs) and pharmacy management systems (PMSs). EMRs and PMSs post message bundles to the inbox to be delivered to others and query to retrieve message bundles intended for themselves. This conformance statement is based on the conformance-common-hub statement from the Shared Health specification which the PrescribeIT® Switch also adheres to
General
| FHIR Version: | $ver$ |
|---|---|
| Supported formats: | xml |
REST behavior
Operations:
Messaging
Because the SDF doesn't technically initiate the transfer of messages, the role of sender is not provided. However, in practice the SDF is both sender and receiver of these messages, acting as a relay between PMS and EMR systems
| Event | Category | Mode | Focus | Request | Response | Notes |
|---|---|---|---|---|---|---|
| Consequence | receiver | Task | http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999 |
This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to a PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax. |
||
| Consequence | receiver | Task | http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999 |
This message allows the SDF to receive a request to execute one or more tasks from a PMS system to be delivered to an EMR. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. Note - in some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax. |
||
| Consequence | receiver | Task | http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997 |
This message allows the hub to receive a communication request from a point of service for delivery to another point of service, in some cases with cc instructions to additional recipients. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 997 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 998 may be sent in place of a 997 if the hub determines that no recipients will be able to receive the message. |
||
| Consequence | receiver | Task | http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999 |
This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to an as-yet unselected PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax. |
||
| Notification | sender |
This message allows the hub to communicate the rejection the receipt of a particular 305 message by a particular system. Potential reasons include: patient not recognized, message was directed to the wrong system, system is currently unable to process the message, message fails validation checks, etc. |
||||
| Notification | sender |
This message allows the hub to inform the PoS that initiated a 301 message that the PoS system that was an identified recipient of that 301 message did not receive it. Potential reasons include: attachments were not received, attachments failed virus checking, system failure of the inbox, etc. |
Raw XML
<Conformance xmlns="http://hl7.org/fhir">
<id value="conformance-erx-sdf"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>PrescribeIT® Switch</h2>
<p>(Requirements Definition)</p>
<p>http://prescribeit.ca/fhir/Conformance/conformance-erx-sdf Published: 2016-06-03 (draft)</p>
<p>Published by: <b>Shared Health</b>
</p>
<p>This role defines the capabilities of the Shared Health messaging hub. The hub or inbox serves as a secure repository for delivering messages between electronic medical records (EMRs) and pharmacy management systems (PMSs). EMRs and PMSs post message bundles to the inbox to be delivered to others and query to retrieve message bundles intended for themselves. This conformance statement is based on the conformance-common-hub statement from the Shared Health specification which the PrescribeIT® Switch also adheres to</p>
<h2>General</h2>
<div class="table-wrapper">
<table>
<tbody>
<tr>
<th>FHIR Version:</th>
<td>$ver$</td>
</tr>
<tr>
<th>Supported formats:</th>
<td>xml</td>
</tr>
</tbody>
</table>
</div>
<h2>REST behavior</h2>
<p>
<b>Operations:</b>
</p>
<ul>
<li>
<a href="http://prescribeit.ca/fhir/operationdefinition/formulary">formulary</a>
</li>
</ul>
<br/>
<br/>
<h2>Messaging</h2>
<p>Because the SDF doesn't technically initiate the transfer of messages, the role of sender is not provided. However, in practice the SDF is both sender and receiver of these messages, acting as a relay between PMS and EMR systems</p>
<div class="table-wrapper">
<table class="grid">
<thead>
<tr>
<th>Event</th>
<th>Category</th>
<th>Mode</th>
<th>Focus</th>
<th>Request</th>
<th>Response</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td/>
<td>Consequence</td>
<td>receiver</td>
<td>Task</td>
<td/>
<td>
<a href="../common/interaction-bundle-999.html">http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999</a>
</td>
<td>
<p>This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to a PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax.</p>
</td>
</tr>
<tr>
<td/>
<td>Consequence</td>
<td>receiver</td>
<td>Task</td>
<td/>
<td>
<a href="../common/interaction-bundle-999.html">http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999</a>
</td>
<td>
<p>This message allows the SDF to receive a request to execute one or more tasks from a PMS system to be delivered to an EMR. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. Note - in some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax.</p>
</td>
</tr>
<tr>
<td/>
<td>Consequence</td>
<td>receiver</td>
<td>Task</td>
<td/>
<td>
<a href="../common/interaction-bundle-997.html">http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997</a>
</td>
<td>
<p>This message allows the hub to receive a communication request from a point of service for delivery to another point of service, in some cases with cc instructions to additional recipients. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 997 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 998 may be sent in place of a 997 if the hub determines that no recipients will be able to receive the message.</p>
</td>
</tr>
<tr>
<td/>
<td>Consequence</td>
<td>receiver</td>
<td>Task</td>
<td/>
<td>
<a href="../common/interaction-bundle-999.html">http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999</a>
</td>
<td>
<p>This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to an as-yet unselected PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax.</p>
</td>
</tr>
<tr>
<td/>
<td>Notification</td>
<td>sender</td>
<td/>
<td/>
<td/>
<td>
<p>This message allows the hub to communicate the rejection the receipt of a particular 305 message by a particular system. Potential reasons include: patient not recognized, message was directed to the wrong system, system is currently unable to process the message, message fails validation checks, etc.</p>
</td>
</tr>
<tr>
<td/>
<td>Notification</td>
<td>sender</td>
<td/>
<td/>
<td/>
<td>
<p>This message allows the hub to inform the PoS that initiated a 301 message that the PoS system that was an identified recipient of that 301 message did not receive it. Potential reasons include: attachments were not received, attachments failed virus checking, system failure of the inbox, etc.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</text>
<url value="http://prescribeit.ca/fhir/Conformance/conformance-erx-sdf"/>
<version value="3.0 Revision C"/>
<name value="PrescribeIT® Switch"/>
<status value="draft"/>
<date value="2016-06-03T00:00:00-04:00"/>
<publisher value="Shared Health"/>
<contact>
<telecom>
<system value="other"/>
<value value="http://prescribeit.ca"/>
</telecom>
</contact>
<description
value="This role defines the capabilities of the Shared Health messaging hub. The hub or inbox serves as a secure repository for delivering messages between electronic medical records (EMRs) and pharmacy management systems (PMSs). EMRs and PMSs post message bundles to the inbox to be delivered to others and query to retrieve message bundles intended for themselves. This conformance statement is based on the conformance-common-hub statement from the Shared Health specification which the PrescribeIT® hub also adheres to"/>
<kind value="requirements"/>
<fhirVersion value="1.4.0"/>
<acceptUnknown value="extensions"/>
<format value="xml"/>
<rest>
<mode value="server"/>
<operation>
<name value="formulary"/>
<definition>
<reference
value="http://prescribeit.ca/fhir/OperationDefinition/formulary"/>
</definition>
</operation>
</rest>
<messaging>
<extension
url="http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event">
<extension url="code">
<valueCoding>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="101"/>
</valueCoding>
</extension>
<extension url="category">
<valueCode value="Consequence"/>
</extension>
<extension url="mode">
<valueCode value="receiver"/>
</extension>
<extension url="focus">
<valueString value="Task"/>
</extension>
<extension url="request">
<valueReference>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-101"/>
</valueReference>
</extension>
<extension url="response">
<valueReference>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
</valueReference>
</extension>
<extension url="documentation">
<valueString
value="This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to a PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax."/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event">
<extension url="code">
<valueCoding>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="201"/>
</valueCoding>
</extension>
<extension url="category">
<valueCode value="Consequence"/>
</extension>
<extension url="mode">
<valueCode value="receiver"/>
</extension>
<extension url="focus">
<valueString value="Task"/>
</extension>
<extension url="request">
<valueReference>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-201"/>
</valueReference>
</extension>
<extension url="response">
<valueReference>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
</valueReference>
</extension>
<extension url="documentation">
<valueString
value="This message allows the SDF to receive a request to execute one or more tasks from a PMS system to be delivered to an EMR. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. Note - in some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax."/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event">
<extension url="code">
<valueCoding>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="305"/>
</valueCoding>
</extension>
<extension url="category">
<valueCode value="Consequence"/>
</extension>
<extension url="mode">
<valueCode value="receiver"/>
</extension>
<extension url="focus">
<valueString value="Task"/>
</extension>
<extension url="request">
<valueReference>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-305"/>
</valueReference>
</extension>
<extension url="response">
<valueReference>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997"/>
</valueReference>
</extension>
<extension url="documentation">
<valueString
value="This message allows the hub to receive a communication request from a point of service for delivery to another point of service, in some cases with cc instructions to additional recipients. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 997 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 998 may be sent in place of a 997 if the hub determines that no recipients will be able to receive the message."/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event">
<extension url="code">
<valueCoding>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="401"/>
</valueCoding>
</extension>
<extension url="category">
<valueCode value="Consequence"/>
</extension>
<extension url="mode">
<valueCode value="receiver"/>
</extension>
<extension url="focus">
<valueString value="Task"/>
</extension>
<extension url="request">
<valueReference>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-401"/>
</valueReference>
</extension>
<extension url="response">
<valueReference>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
</valueReference>
</extension>
<extension url="documentation">
<valueString
value="This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to an as-yet unselected PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax."/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event">
<extension url="code">
<valueCoding>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="997"/>
</valueCoding>
</extension>
<extension url="category">
<valueCode value="Notification"/>
</extension>
<extension url="mode">
<valueCode value="sender"/>
</extension>
<extension url="focus">
<valueCode>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="unsupported"/>
</extension>
</valueCode>
</extension>
<extension url="request">
<valueReference>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997"/>
</valueReference>
</extension>
<extension url="response">
<valueReference>
<display value="N/A"/>
</valueReference>
</extension>
<extension url="documentation">
<valueString
value="This message allows the hub to communicate the rejection the receipt of a particular 305 message by a particular system. Potential reasons include: patient not recognized, message was directed to the wrong system, system is currently unable to process the message, message fails validation checks, etc."/>
</extension>
</extension>
<extension
url="http://hl7.org/fhir/1.0/StructureDefinition/extension-Conformance.messaging.event">
<extension url="code">
<valueCoding>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="998"/>
</valueCoding>
</extension>
<extension url="category">
<valueCode value="Notification"/>
</extension>
<extension url="mode">
<valueCode value="sender"/>
</extension>
<extension url="focus">
<valueCode>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="unsupported"/>
</extension>
</valueCode>
</extension>
<extension url="request">
<valueReference>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-998"/>
</valueReference>
</extension>
<extension url="response">
<valueReference>
<display value="N/A"/>
</valueReference>
</extension>
<extension url="documentation">
<valueString
value="This message allows the hub to inform the PoS that initiated a 301 message that the PoS system that was an identified recipient of that 301 message did not receive it. Potential reasons include: attachments were not received, attachments failed virus checking, system failure of the inbox, etc."/>
</extension>
</extension>
<documentation
value="Because the SDF doesn't technically initiate the transfer of messages, the role of sender is not provided. However, in practice the SDF is both sender and receiver of these messages, acting as a relay between PMS and EMR systems"/>
<event>
<code>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="101"/>
</code>
<category value="Consequence"/>
<mode value="receiver"/>
<focus value="Task"/>
<request>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-101"/>
</request>
<response>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
</response>
<documentation
value="This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to a PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax."/>
</event>
<event>
<code>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="201"/>
</code>
<category value="Consequence"/>
<mode value="receiver"/>
<focus value="Task"/>
<request>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-201"/>
</request>
<response>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
</response>
<documentation
value="This message allows the SDF to receive a request to execute one or more tasks from a PMS system to be delivered to an EMR. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. Note - in some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax."/>
</event>
<event>
<code>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="305"/>
</code>
<category value="Consequence"/>
<mode value="receiver"/>
<focus value="Task"/>
<request>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-305"/>
</request>
<response>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997"/>
</response>
<documentation
value="This message allows the hub to receive a communication request from a point of service for delivery to another point of service, in some cases with cc instructions to additional recipients. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 997 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 998 may be sent in place of a 997 if the hub determines that no recipients will be able to receive the message."/>
</event>
<event>
<code>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="401"/>
</code>
<category value="Consequence"/>
<mode value="receiver"/>
<focus value="Task"/>
<request>
<reference
value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-401"/>
</request>
<response>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
</response>
<documentation
value="This message allows the SDF to receive a request to execute one or more tasks from an EMR to be delivered to an as-yet unselected PMS. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. 999 is relayed from the target system if it was unable to consume the message or is initiated directly by the hub if the message was not picked up in a sufficiently timely fashion by the target recipient. In some cases a 901 may be sent in place of a 999 if the hub determines it is able to relay the content by fax."/>
</event>
<event>
<code>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="997"/>
</code>
<category value="Notification"/>
<mode value="sender"/>
<focus>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="unsupported"/>
</extension>
</focus>
<request>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997"/>
</request>
<response>
<display value="N/A"/>
</response>
<documentation
value="This message allows the hub to communicate the rejection the receipt of a particular 305 message by a particular system. Potential reasons include: patient not recognized, message was directed to the wrong system, system is currently unable to process the message, message fails validation checks, etc."/>
</event>
<event>
<code>
<system
value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
<code value="998"/>
</code>
<category value="Notification"/>
<mode value="sender"/>
<focus>
<extension
url="http://hl7.org/fhir/StructureDefinition/data-absent-reason">
<valueCode value="unsupported"/>
</extension>
</focus>
<request>
<reference
value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-998"/>
</request>
<response>
<display value="N/A"/>
</response>
<documentation
value="This message allows the hub to inform the PoS that initiated a 301 message that the PoS system that was an identified recipient of that 301 message did not receive it. Potential reasons include: attachments were not received, attachments failed virus checking, system failure of the inbox, etc."/>
</event>
</messaging>
</Conformance>