PrescribeIT® Specification and Guide Version 5.0

 

PrescribeIT® Elecronic Medical Record

(Requirements Definition)

http://prescribeit.ca/fhir/Conformance/conformance-erx-emr Published: 2016-06-03 (draft)

Published by: Canada Health Infoway

This role defines the capabilities of PrescribeIT® Switch. It performs security, routing and reliable message delivery to support ePrescribing and related functionality. It manages the 'inboxes' in which messages are deposited and subsequently polled for retrieval. This Conformance statement builds on the conformance-common-pos Conformance statement which the EMR must also comply with.

General

FHIR Version: $ver$
Supported formats: xml

REST behavior

Operations:



Messaging

Messages are sent by POSTing them to the Bundle end-point of PrescribeIT® Switch. They are received by querying the Bundle endpoint for all current messages and then subsequently deleting messages that have been successfully retrieved and committed.

Event Category Mode Focus Request Response Notes
Consequence sender Task http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999

This message allows the transmission of one or more tasks from an EMR system to an PMS or another EMR system. A response is only sent if the receiver has an inability to parse or otherwise consume the received message.

Notification receiver OperationOutcome

This message allows the EMR to indicate that it was uable to process a received message

Consequence receiver Task http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999

This message allows the receipt of one or more tasks from a PMS system or another EMR. The response is only sent if the receiver has an inability to parse or otherwise consume the received message. In some cases, the EMR may receive a 901 indicating that the message was delivered by fax rather than electronically.

Consequence receiver Task http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997

This message allows the transmission of a Communication from the PoS system to another PoS system. The PoS will only get a response if the receiver has an inability to parse or otherwise consume the received message or cannot deliver it to one of the intended recipients. In addition to receiving back a 997, the system may also receive back a 998 (FHIR STU 2 does not support the declaration of multiple response messages so it's not listed in the table.)

Consequence receiver Task http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999

This message allows the transmission of one or more tasks from an EMR system to an unspecified PMS or another EMR system. A response is only sent if the receiver has an inability to parse or otherwise consume the received message.

Notification sender

This message allows the PoS to reject the receipt of a particular 305 message. 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 receiver

This message indicates that the PoS system that was an identified recipient of a 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-emr"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
			<h2>PrescribeIT® Elecronic Medical Record</h2>
			<p>(Requirements Definition)</p>
			<p>http://prescribeit.ca/fhir/Conformance/conformance-erx-emr Published: 2016-06-03 (draft)</p>
			<p>Published by: <b>Canada Health Infoway</b>
			</p>
			<p>This role defines the capabilities of PrescribeIT® Switch.  It performs security, routing and reliable message delivery to support ePrescribing and related functionality.  It manages the 'inboxes' in which messages are deposited and subsequently polled for retrieval. This Conformance statement builds on the conformance-common-pos Conformance statement which the EMR must also comply with.</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>Messages are sent by POSTing them to the Bundle end-point of PrescribeIT® Switch.  They are received by querying the Bundle endpoint for all current messages and then subsequently deleting messages that have been successfully retrieved and committed.</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>sender</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 transmission of one or more tasks from an EMR system to an PMS or another EMR system.  A response is only sent if the receiver has an inability to parse or otherwise consume the received message.</p>
							</td>
						</tr>
						<tr>
							<td/>
							<td>Notification</td>
							<td>receiver</td>
							<td>OperationOutcome</td>
							<td/>
							<td/>
							<td>
								<p>This message allows the EMR to indicate that it was uable to process a received 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 receipt of one or more tasks from a PMS system or another EMR.  The response is only sent if the receiver has an inability to parse or otherwise consume the received message.  In some cases, the EMR may receive a 901 indicating that the message was delivered by fax rather than electronically.</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 transmission of a Communication from the PoS system to another PoS system.  The PoS will only get a response if the receiver has an inability to parse or otherwise consume the received message or cannot deliver it to one of the intended recipients.  In addition to receiving back a 997, the system may also receive back a 998 (FHIR STU 2 does not support the declaration of multiple response messages so it's not listed in the table.)</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 transmission of one or more tasks from an EMR system to an unspecified PMS or another EMR system.  A response is only sent if the receiver has an inability to parse or otherwise consume the received message.</p>
							</td>
						</tr>
						<tr>
							<td/>
							<td>Notification</td>
							<td>sender</td>
							<td/>
							<td/>
							<td/>
							<td>
								<p>This message allows the PoS to reject the receipt of a particular 305 message.  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>receiver</td>
							<td/>
							<td/>
							<td/>
							<td>
								<p>This message indicates that the PoS system that was an identified recipient of a 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-emr"/>
  <version value="5.0"/>
  <name value="PrescribeIT® Elecronic Medical Record"/>
  <status value="draft"/>
  <date value="2016-06-03T00:00:00-04:00"/>
  <publisher value="Canada Health Infoway"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value value="http://prescribeit.ca"/>
    </telecom>
  </contact>
  <description
               value="This role defines the capabilities of PrescribeIT® Switch.  It performs security, routing and reliable message delivery to support ePrescribing and related functionality.  It manages the &#39;inboxes&#39; in which messages are deposited and subsequently polled for retrieval. This Conformance statement builds on the conformance-common-pos Conformance statement which the EMR must also comply with."/>
  <kind value="requirements"/>
  <fhirVersion value="1.4.0"/>
  <acceptUnknown value="extensions"/>
  <format value="xml"/>
  <rest>
    <mode value="client"/>
    <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="sender"/>
      </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 transmission of one or more tasks from an EMR system to an PMS or another EMR system.  A response is only sent if the receiver has an inability to parse or otherwise consume the received 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="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 receipt of one or more tasks from a PMS system or another EMR.  The response is only sent if the receiver has an inability to parse or otherwise consume the received message.  In some cases, the EMR may receive a 901 indicating that the message was delivered by fax rather than electronically."/>
      </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="sender"/>
      </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 transmission of a Communication from the PoS system to another PoS system.  The PoS will only get a response if the receiver has an inability to parse or otherwise consume the received message or cannot deliver it to one of the intended recipients.  In addition to receiving back a 997, the system may also receive back a 998 (FHIR STU 2 does not support the declaration of multiple response messages so it&#39;s not listed in the table.)"/>
      </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="sender"/>
      </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 transmission of one or more tasks from an EMR system to the Switch or in certain jurisdictions (e.g. QC), a specified PMS.  A response is only sent if the receiver has an inability to parse or otherwise consume the received 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="902"/>
        </valueCoding>
      </extension>
      <extension url="category">
        <valueCode value="Notification"/>
      </extension>
      <extension url="mode">
        <valueCode value="receiver"/>
      </extension>
      <extension url="focus">
        <valueString value="MedicationOrder"/>
      </extension>
      <extension url="request">
        <valueReference>
          <reference
                     value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-902"/>
        </valueReference>
      </extension>
      <extension url="response">
        <valueReference>
          <display value="N/A"/>
        </valueReference>
      </extension>
      <extension url="documentation">
        <valueString
                     value="This message allows the receipt of one or more Jurisdictional RX IDs for a Prescription from a Central Switch to a specified EMR."/>
      </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="receiver"/>
      </extension>
      <extension url="focus">
        <valueString value="OperationOutcome"/>
      </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 PoS to reject the receipt of a particular 305 message.  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="receiver"/>
      </extension>
      <extension url="focus">
        <valueString value="OperationOutcome"/>
      </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 indicates that the PoS system that was an identified recipient of a 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>
    <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="999"/>
        </valueCoding>
      </extension>
      <extension url="category">
        <valueCode value="Notification"/>
      </extension>
      <extension url="mode">
        <valueCode value="sender"/>
      </extension>
      <extension url="focus">
        <valueString value="OperationOutcome"/>
      </extension>
      <extension url="request">
        <valueReference>
          <reference
                     value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
        </valueReference>
      </extension>
      <extension url="response">
        <valueReference>
          <display value="N/A"/>
        </valueReference>
      </extension>
      <extension url="documentation">
        <valueString
                     value="This message allows the EMR to indicate that it was uable to process a received message"/>
      </extension>
    </extension>
    <documentation
                   value="Messages are sent by POSTing them to the Bundle end-point of PrescribeIT® Switch.  They are received by querying the Bundle endpoint for all current messages and then subsequently deleting messages that have been successfully retrieved and committed."/>
    <event>
      <code>
        <system
                value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
        <code value="101"/>
      </code>
      <category value="Consequence"/>
      <mode value="sender"/>
      <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 transmission of one or more tasks from an EMR system to an PMS or another EMR system.  A response is only sent if the receiver has an inability to parse or otherwise consume the received message."/>
    </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 receipt of one or more tasks from a PMS system or another EMR.  The response is only sent if the receiver has an inability to parse or otherwise consume the received message.  In some cases, the EMR may receive a 901 indicating that the message was delivered by fax rather than electronically."/>
    </event>
    <event>
      <code>
        <system
                value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
        <code value="305"/>
      </code>
      <category value="Consequence"/>
      <mode value="sender"/>
      <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 transmission of a Communication from the PoS system to another PoS system.  The PoS will only get a response if the receiver has an inability to parse or otherwise consume the received message or cannot deliver it to one of the intended recipients.  In addition to receiving back a 997, the system may also receive back a 998 (FHIR STU 2 does not support the declaration of multiple response messages so it&#39;s not listed in the table.)"/>
    </event>
    <event>
      <code>
        <system
                value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
        <code value="401"/>
      </code>
      <category value="Consequence"/>
      <mode value="sender"/>
      <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 transmission of one or more tasks from an EMR system to the Switch or in certain jurisdictions (e.g. QC), a specified PMS.  A response is only sent if the receiver has an inability to parse or otherwise consume the received message."/>
    </event>
    <event>
      <code>
        <system
                value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
        <code value="902"/>
      </code>
      <category value="Notification"/>
      <mode value="receiver"/>
      <focus value="MedicationOrder"/>
      <request>
        <reference
                   value="http://prescribeit.ca/fhir/StructureDefinition/interaction-bundle-902"/>
      </request>
      <response>
        <display value="N/A"/>
      </response>
      <documentation
                     value="This message allows the receipt of one or more Jurisdictional RX IDs for a Prescription from a Central Switch to a specified EMR."/>
    </event>
    <event>
      <code>
        <system
                value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
        <code value="997"/>
      </code>
      <category value="Notification"/>
      <mode value="receiver"/>
      <focus value="OperationOutcome"/>
      <request>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-997"/>
      </request>
      <response>
        <display value="N/A"/>
      </response>
      <documentation
                     value="This message allows the PoS to reject the receipt of a particular 305 message.  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="receiver"/>
      <focus value="OperationOutcome"/>
      <request>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-998"/>
      </request>
      <response>
        <display value="N/A"/>
      </response>
      <documentation
                     value="This message indicates that the PoS system that was an identified recipient of a 301 message did not receive it.  Potential reasons include: attachments were not received, attachments failed virus checking, system failure of the inbox, etc."/>
    </event>
    <event>
      <code>
        <system
                value="https://fhir.infoway-inforoute.ca/CodeSystem/sharedmessageevents"/>
        <code value="999"/>
      </code>
      <category value="Notification"/>
      <mode value="sender"/>
      <focus value="OperationOutcome"/>
      <request>
        <reference
                   value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-999"/>
      </request>
      <response>
        <display value="N/A"/>
      </response>
      <documentation
                     value="This message allows the EMR to indicate that it was uable to process a received message"/>
    </event>
  </messaging>
</Conformance>