PrescribeIT® Specification and Guide Version 5.0

 

5.1 PrescribeIT® API Summary

This section provides details on the APIs that have been defined for the PrescribeIT® domain. Shared Health domain APIs are included on the Shared Health API Summary page.

The endpoints will vary by environment (e.g. Production, Pre-conformance) and may also be context specific. Implementers should make the endpoints' URLs configurable within their systems as these may be updated in future releases. Vendors should not be storing the organization/practitioner URLs; rather they should build it at runtime using configurable prefix's per environment and the identifier itself. The real URLs will be published to Vendors upon onboarding with PrescribeIT®.

5.1 HTTP Request Headers

For PrescribeIT® there will be three new HTTP headers that will be required in the Formulary Query, Deferred Query, and Provider Registry Queries. The headers will be for a) Application Instance Identifier, b) Practitioner CPRID, and c) Organization CPRID.

The headers are required so that PrescribeIT® can determine the originator of the query when an application instance is using a hub/routing application. See the table below for conformance rules.

HTTP Request Header Conformance Rules Expected Format
X-SHAREDHEALTH-EXCHANGE-SENDING-APP-INSTANCE-ID Mandatory for the following:
  • Formulary Query (EMR)
  • Deferred Query (PMS)
  • Acknowledging (clear queue request) related to a retrieved Deferred bundle (PMS)
  • Returning a retrieved deferred bundle request (PMS)
 X-SHAREDHEALTH-EXCHANGE-SENDING-APP-INSTANCE-ID: urn:oid:1.2.0.9.9.4.0994
X-SHAREDHEALTH-EXCHANGE-SENDING-PRACTITIONER-ID

Not applicable for Deferred Query (PMS) or for PMS-initiated Provider Registry Queries

Optional for Formulary Query (EMR) but should be provided if Practitioner is enrolled and known

 X-SHAREDHEALTH-EXCHANGE-SENDING-PRACTITIONER-ID: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-practitioner|190000074
X-SHAREDHEALTH-EXCHANGE-SENDING-ORGANIZATION-ID Mandatory for the following:
  • Formulary Query (EMR)
  • Deferred Query (PMS)
  • Acknowledging (clear queue request) related to a retrieved Deferred bundle (PMS)
  • Returning a retrieved deferred bundle request (PMS)
  • Provider Registry queries
 X-SHAREDHEALTH-EXCHANGE-SENDING-ORGANIZATION-ID: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-organization|190001234

When acknowledging a PrescribeIT® message, a service endpoint behaves in two ways. First, in the context of acknowledging 101, 201, or 305 interactions, no mandatory headers are required. Second, in the context of acknowledgment of a Deferred Query (401) interaction, two mandatory headers (X-SHAREDHEALTH-EXCHANGE-SENDING-APP-INSTANCE-ID and X-SHAREDHEALTH-EXCHANGE-SENDING-ORGANIZATION-ID) must be provided. When a request to acknowledge messages is received, an attempt is made to look up their Bundle IDs in the Inbox (which can contain 101, 201 or 305 messages). If this lookup is unsuccessful, then the service considers this to be a request to acknowledge 401 message(s) and a check is done to ensure that mandatory headers X-SHAREDHEALTH-EXCHANGE-SENDING-APP-INSTANCE-ID and X-SHAREDHEALTH-EXCHANGE-SENDING-ORGANIZATION-ID are present.

5.2 Attachment Upload

API Type REST
Verb PUT
Required Request Headers

X-SHX-SDF-Developer-Key: <value>

NOTE: <value> for X-SHX-SDF-Developer-Key is unique for each caller location. It is a credential which is supplied along with the SDF certificate to each location during its on-boarding.

Accept: application/xml
Content-Type: See PrescribeIT® Clinician Communication

Response Content Type application/xml
Response Headers X-SHX-SDF-TraceId - unique identifier of this transaction generated by the server
Description Service to upload PrescribeIT® (305) attachments, attachment will be uploaded as binary in the HTTP request body
Production Endpoint URL https://api.sharedhealth.exchange/rest/v1/THP/mailbox_vs0/Binary/${AttachmentId}
Pre-Conformance Endpoint URL https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/${AttachmentId}
Request Sample 
PUT https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/60c1242e-017a-4076-961d-2968ef63a81e

Accept: application/xml
Content-Type: text/plain
X-SHX-SDF-Developer-Key: ZTkyM2EyNTktNDQ2OC00ZmNkLThjZjUtMGIzMDc4NTE4MjhhOmY1NjMwYThjZTBkODRkY2I4Mjg3NmZhMjAwZTAzOTJhM2NhMmYxNzJlNipiNDk0ZWE1ZmFkNmI4YmMxYmNkODk=
This is a sample document payload
Response Sample 
HTTP response code is 200, payload is empty, headers are as follows:

Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: text/plain
Date: Thu, 12 Dec 2019 21:04:39 GMT
X-Global-Transaction-ID: b2ba59235df2ab67941a637d
Server: nginx/1.10.2
X-Application-Context: Attachment:precon:8181
accept: application/xml
accept-encoding: gzip
Access-Control-Allow-Headers: Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers
Access-Control-Allow-Methods: GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH
Access-Control-Allow-Origin: *
Access-Control-Max-Age: 3600
ATTACHMENT_CHECK_SUM: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
ATTACHMENT_SIZE: 370
authorization: Basic dGVzdDp0ZXN0
breadcrumbId: eeff88c9-db38-4298-bbef-430cb6826ede
guid: 60c1242e-017a-4076-961d-2968ef63a81e
user-agent: Apache-HttpClient/4.5.3 (Java/1.8.0_221)
x-forwarded-for: 172.31.0.162
x-forwarded-host: 198.96.45.111
x-forwarded-server: 198.96.45.111
x-telus-sdf-appid: 1011622
x-telus-sdf-traceid: fd7127bb-e130-4b84-afa3-2359bab2be74
x-telus-sdf-virtualhostid: shx.external.site2
X-SHX-SDF-Site: site2.api.sharedhealth.exchange
X-SHX-SDF-ServerId: sdfxmlfw21
Service Response HTTP Code header and Payload
  • HTTP 200 and empty response payload in case of success
  • HTTP 4xx or HTTP 5xx for any backend errors + payload. Payload format depends on whether the error is coming from the SDF (API gateway) or PrescribeIT® Central Service. In case of the SDF failure, the response is in custom XML format, in case of PrescribeIT® Central Service the response is an OperationOutcome object

5.3 Attachment Download

API Type REST
Verb GET
Required Request Headers

X-SHX-SDF-Developer-Key: <value>

NOTE: <value> for X-SHX-SDF-Developer-Key is unique for each caller location. It is a credential which is supplied along with the SDF certificate to each location during its on-boarding.

Accept: <value> - one or more Accept headers can be provided. One of the values must match this attachment's content type found in the 305 message
Response Content Type Matches original attachment content type
Description Service to download attachments referenced in FHIR messages with message bundle type 305
Production Endpoint URL https://api.sharedhealth.exchange/rest/v1/THP/mailbox_vs0/Binary/${AttachmentId}
Pre-Conformance Endpoint URL https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/Binary/${AttachmentId}
Response Headers X-SHX-SDF-TraceId - unique identifier of this transaction generated by the server
Content-Type: <value> - value is matching the original content type
Content-Disposition: attachment; filename="<value>"
Service Response HTTP Code header and Payload
  • HTTP 200 for success + payload
  • HTTP 4xx or HTTP 5xx for any backend errors + payload. Payload format depends on whether the error is coming from the SDF (API gateway) or PrescribeIT® Central Service. In case of the SDF failure, the response is in custom XML format, in case of PrescribeIT® Central Service the response is an OperationOutcome object

5.4 RequestOTP

API Type REST
Verb POST
Required Request Headers

X-SHX-SDF-Developer-Key: <value>

NOTE: <value> for X-SHX-SDF-Developer-Key is unique for each caller location. It is a credential which is supplied along with the SDF certificate to each location during its on-boarding.

Accept: application/xml

Content-Type: application/xml
Description Description Service to issue one-time password that is sent to user as SMS text message. SMS can only be sent to Canadian cellular phone numbers from a registered service provider (i.e. Bell, Rogers, etc.). Phone numbers based on VoIP, websites or internet applications cannot be used.
Production Endpoint URL https://api.sharedhealth.exchange/rest/v1/THP/STS_vs0/api/requestOTP
Pre-Conformance Endpoint URL https://api.sharedhealth.exchange/rest/v1/preconf/THP/STS_vs1/api/requestOTP
Response Headers X-SHX-SDF-TraceId - unique identifier of this transaction generated by the server
Request Schema 
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.sharedhealth.exchange/erx/2016/06/STS" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="requestOTP" type="requestOTPType">
		<xs:annotation>
			<xs:documentation>STS OTP Request Message</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:complexType name="requestOTPType">
		<xs:sequence>
			<xs:element name="entityBusinessId">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:maxLength value="100"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="appInstanceId">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:maxLength value="100"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="thpsUserId">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:maxLength value="100"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="noPhone" type="xs:boolean"/>
			<xs:element name="debug" type="xs:boolean" minOccurs="0" maxOccurs="1"/>
		</xs:sequence>
	</xs:complexType>
</xs:schema>
Notes:
  • noPhone element is no longer used in the current release of PrescribeIT®, its value should be always sent as false
  • debug element must be always set to false in Production Environment
Request Sample 
<ns2:requestOTP xmlns:ns2="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sharedhealth.exchange/erx/2016/06/STS/STS-requestToken.xsd">
	<ns2:entityBusinessId>https://api.preprd.sharedhealth.teluslabs.net/rest/v1/THP/PR_vs1/Organization/190000104</ns2:entityBusinessId>
	<ns2:appInstanceId>urn:oid:1.2.2.3.3.7.7.9003012</ns2:appInstanceId>
	<ns2:thpsUserId>190000126</ns2:thpsUserId>
	<ns2:noPhone>false</ns2:noPhone>
	<ns2:debug>false</ns2:debug>
</ns2:requestOTP>
Response Schema 
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.sharedhealth.exchange/erx/2016/06/STS" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="responseStatus" type="responseStatusType">
		<xs:annotation>
			<xs:documentation>Common Response Structure</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:complexType name="responseStatusType">
		<xs:sequence>
			<xs:element name="status">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:enumeration value="Success"/>
						<xs:enumeration value="Fail"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="message" minOccurs="0">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:maxLength value="255"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="code" type="xs:int"/>
			<xs:element name="timeStamp" type="customDT"/>
			<xs:element name="X-TELUS-SDF-TraceId">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:simpleType name="customDT">
		<xs:restriction base="xs:string">
			<xs:pattern value="[0-9]{4}-[01][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-6][0-9]\.[0-9]{3}"/>
			<!-- Example: 2009-12-31 00:00:00.123    yyyy-MM-dd HH:mm:ss.SSS -->
		</xs:restriction>
	</xs:simpleType>
</xs:schema>
Response Sample

Production Environment

<ns:responseStatus xmlns:ns="http://www.sharedhealth.exchange/erx/2016/06/STS">
	<ns:status>Success</ns:status>
	<ns:message/>
	<ns:code>200</ns:code>
	<ns:timeStamp>2018-04-13 13:02:23.955</ns:timeStamp>
	<ns:X-TELUS-SDF-TraceId>8c2e8706-e7d7-4467-8b61-e3d7c49ee093</ns:X-TELUS-SDF-TraceId>
</ns:responseStatus>

Non-Production Environments (e.g. Pre-Conformance)

<ns:responseStatus xmlns:ns="http://www.sharedhealth.exchange/erx/2016/06/STS">
	<ns:status>Success</ns:status>
	<ns:message/>
	<ns:code>200</ns:code>
	<ns:timeStamp>2018-04-13 13:02:23.955</ns:timeStamp>
	<ns:X-TELUS-SDF-TraceId>8c2e8706-e7d7-4467-8b61-e3d7c49ee093</ns:X-TELUS-SDF-TraceId>
</ns:responseStatus>
Service Response Code Headers
  • HTTP 200 for Success
  • HTTP 4xx or HTTP 5xx for any backend errors + payload. Payload format depends on whether the error is coming from the SDF (API gateway) or PrescribeIT® Central Service. In case of the SDF failure, the response is in custom XML format, in case of PrescribeIT® Central Service the response is in XML format compatible with the Response XML schema documented above (in this case, responseStatusType object has status set to Fail and message contains the details of the failure)

5.5 RequestToken

API Type REST
Verb POST
Request Content Type application/xml
Response Content Type application/xml
Required Request Headers

X-SHX-SDF-Developer-Key: <value>

NOTE: <value> for X-SHX-SDF-Developer-Key is unique for each caller location. It is a credential which is supplied along with the SDF certificate to each location during its on-boarding.

Accept: application/xml

Content-Type: application/xml
Description Service to issue SAML Token
Response Header from Service

X-SHAREDHEALTH-EXCHANGE-SAML-EXPIRY - Date and time the returned token is going to expire. This time is always in UTC
X-SHX-SDF-TraceId - unique identifier of this transaction generated by the server
Production Endpoint URL https://api.sharedhealth.exchange/rest/v1/THP/STS_vs0/api/requestToken
Pre-Conformance Endpoint URL https://api.sharedhealth.exchange/rest/v1/preconf/THP/STS_vs1/api/requestToken
Request Schema
  1. Production Environment 
    <xs:schema xmlns="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.sharedhealth.exchange/erx/2016/06/STS" elementFormDefault="qualified" attributeFormDefault="unqualified">
    <xs:element name="requestToken" type="requestTokenType">
        <xs:annotation>
            <xs:documentation>STS Token Request Message</xs:documentation>
        </xs:annotation>
    </xs:element>
    <xs:complexType name="requestTokenType">
        <xs:sequence>
            <xs:element name="entityBusinessId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="appInstanceId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="thpsUserId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="OTP" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="10"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="localUserId">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="firstName" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="50"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="lastName">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="50"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="licenseNumber" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="50"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="licenseIssuer" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="100"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="roleCode" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="50"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
			<xs:element name="externalToken" minOccurs="0">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:maxLength value="4000"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
        </xs:sequence>
    </xs:complexType>
</xs:schema>
Request Sample

Request using practitioner’s license number and license issuer

<requestToken xsi:schemaLocation="http://www.sharedhealth.exchange/erx/2016/06/STS/STS-requestToken.xsd" xmlns="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<entityBusinessId>https://api.sharedhealth.exchange/rest/v1/THP/TPR_vs0/Organization/200328629</entityBusinessId>
	<appInstanceId> urn:oid:2.16.840.1.113883.3.1467.1014915</appInstanceId>
	<thpsUserId>200328635</thpsUserId>
	<OTP>8upwh</OTP>
	<localUserId>10179</localUserId>
	<lastName>Wang</lastName>
	<licenseNumber>35981</licenseNumber>
	<licenseIssuer>urn:oid:2.16.840.1.113883.4.44</licenseIssuer>
</requestToken>

Request With External Token

This is to be used only by vendors who have been instructed and approved by Infoway to supply this additional piece of data in order to complete the 2FA process.

<requestToken xsi:schemaLocation="http://www.sharedhealth.exchange/erx/2016/06/STS STS-requestToken.xsd" xmlns="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
               <entityBusinessId>https://api.preprd.sharedhealth.teluslabs.net/rest/v1/THP/TPR_vs0/Organization/200146119</entityBusinessId>
               <appInstanceId>urn:oid:1.2.2.3.3.7.7.10007939</appInstanceId>
               <thpsUserId>200146121</thpsUserId>
               <localUserId>PractThomas Pots</localUserId>
               <lastName>Pots</lastName>
               <licenseNumber>23423</licenseNumber>
               <licenseIssuer>urn:oid:2.16.840.1.113883.3.7752</licenseIssuer>
               <externalToken>eyJraWQiOiJpajJWZjlTOEhDb21UWVU3NGJhc0VPY0VMSFYybG9aYm5SVWZ0NlZCTDc4IiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiIwMHV2a284YTVsdVhyUkJyNTBoNyIsIm5hbWUiOiJNaXlhIFdoZWF0bGV5IiwidmVyIjoxLCJpc3MiOiJodHRwczovL29rdGEtZC5xaHJ0ZWNoLmNvbS9vYXV0aDIvZGVmYXVsdCIsImF1ZCI6IjBvYXZrbDNxa3dtbVpaa21FMGg3IiwiaWF0IjoxNjA5ODYxMjkwLCJleHAiOjE2MDk4NjQ4OTAsImp0aSI6IklELnNoRkN3cDZXNXdVc3RSNVVDWTdjVUZHc2Y5TXdDOXlhd3hDdmppUjgybUEiLCJhbXIiOlsicHdkIl0sImlkcCI6IjAwb2tydDI0ZWdMd1hFVnQ0MGg3IiwicHJlZmVycmVkX3VzZXJuYW1lIjoibWl5YS53aGVhdGxleUBwcmVzY3JpYmVpdC5jYSIsImF1dGhfdGltZSI6MTYwOTg2MTI5MCwiYXRfaGFzaCI6InhYZGlEalJEeWtVR1RsWlUzSWhpV0EiLCJsaWNlbnNlX2lzcyI6InVybjpvaWQ6Mi4xNi44NDAuMS4xMTM4ODMuNC43NTYiLCJsaWNlbnNlX251bSI6IjIzNDIzIiwiZ3JvdXBzIjpbIkV2ZXJ5b25lIiwiUHJvdmlkZXIgVXNlcnMiLCJGZWRlcmF0ZWQgVXNlcnMiXSwic3F1aWQiOiJlZGU0MTFiNS01YzE4LTQ4ZWItOTg2My01MzY1YmRmMjhkODkifQ.UvZB6PoVnzbHVdpTLCc1mrVL__Gr6h5xMjBjslPqmATI7SFEI53N72pz95NhROiFR5qHfxZ1uipm9lVYZoCpZ-v338BFN3Pswah0GM8nrZ96Tyhose8Nq1_zAk1MfyeNpg575LT_g_LW1owxCMmbd8uQ6pyfWBXDaShfkIWj6mIi0s1j_BHkRXzOz2inA6T7YliZBE-8L-gVSa2xjC3xUAUHcNqjYtJXoGQrXattku1LDhPD5N1d266DTB7xF9KZp4STmDJFjsDNO3IA6fhgeztSHYUJUhVR6g7RzSIS1p9lNFTSRTN2Ntdo3oXVo_EQlx7Il0wo40ug7AYzNV2mQQ</externalToken>
</requestToken>
Response Schema

STSResponseStatus.xsd

<xs:schema xmlns="http://www.sharedhealth.exchange/erx/2016/06/STS" xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.sharedhealth.exchange/erx/2016/06/STS" elementFormDefault="qualified" attributeFormDefault="unqualified">
	<xs:element name="responseStatus" type="responseStatusType">
		<xs:annotation>
			<xs:documentation>Common Response Structure</xs:documentation>
		</xs:annotation>
	</xs:element>
	<xs:complexType name="responseStatusType">
		<xs:sequence>
			<xs:element name="status">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:enumeration value="Success"/>
						<xs:enumeration value="Fail"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="message" minOccurs="0">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:maxLength value="10000"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
			<xs:element name="code" type="xs:int"/>
			<xs:element name="timeStamp" type="customDT"/>
			<xs:element name="X-TELUS-SDF-TraceId">
				<xs:simpleType>
					<xs:restriction base="xs:string">
						<xs:pattern value="[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"/>
					</xs:restriction>
				</xs:simpleType>
			</xs:element>
		</xs:sequence>
	</xs:complexType>
	<xs:simpleType name="customDT">
		<xs:restriction base="xs:string">
			<xs:pattern value="[0-9]{4}-[01][0-9]-[0-3][0-9] [0-2][0-9]:[0-5][0-9]:[0-6][0-9]\.[0-9]{3}"/>
			<!-- Example: 2009-12-31 00:00:00.123    yyyy-MM-dd HH:mm:ss.SSS -->
		</xs:restriction>
	</xs:simpleType>
</xs:schema>
Response + response header sample

X-SHAREDHEALTH-EXCHANGE-SAML-EXPIRY: 2020-10-28 01:11:13.521

X-SHX-SDF-TraceId: 578834ee-b176-45de-a26f-3fcc8e35324f

<ns:responseStatus xmlns:ns="http://www.sharedhealth.exchange/erx/2016/06/STS">
	<ns:status>Success</ns:status>
	<ns:message><?xml version="1.0" encoding="UTF-8"?>
<saml2:Assertion ID="7c63873f-3ca1-4aa9-a7c7-cda831dd09f9" IssueInstant="2020-10-27T13:11:13.521Z" Version="2.0" xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion" xmlns:xs="http://www.w3.org/2001/XMLSchema"><saml2:Issuer>https://api.sharedhealth.exchange/rest/v1/THP/STS_vs0</saml2:Issuer><ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:SignedInfo><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><ds:SignatureMethod Algorithm="http://www.w3.org/2000/09/xmldsig#rsa-sha1"/><ds:Reference URI="#7c63873f-3ca1-4aa9-a7c7-cda831dd09f9"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"><ec:InclusiveNamespaces PrefixList="xs" xmlns:ec="http://www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transform></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><ds:DigestValue>MMiQcvh5Cd2B8JBCE0itjTuXWys=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>fSOb85xAF2kk5FaCt8NAQ9hgYxWpieMsSr54FX9ePvB13lioseUXSdBxiFpm/dNrQOEpCnp2Lo51937H1qZLOswjRXjpe/n/VyxT62p++0BQ++A+43E0tSV8GZZjMe/pFSR70uhHAx4J+fN/UhftDDINsfv25TokkIdUpr0sIIQaXanQcQh/p922ObeW3W16CjVYmOesGPwt66fyvHStKG1s3g1UscFux/NVlepL78HpZ0b83WTPLHIXyu+p/XRMknwiEIBWPCpKqhJSo/flFHGnLovSkf6moOfwt89JjB0jgDRZo/yHGCbFeHd7qxSy87UC9+6U7nFxbMlueBe+mg==</ds:SignatureValue><ds:KeyInfo><ds:X509Data><ds:X509Certificate>MIIGrjCCBZagAwIBAgIQKI8XD7oxTHIAAAAAUQXCCzANBgkqhkiG9w0BAQsFADCBujELMAkGA1UE
BhMCVVMxFjAUBgNVBAoTDUVudHJ1c3QsIEluYy4xKDAmBgNVBAsTH1NlZSB3d3cuZW50cnVzdC5u
ZXQvbGVnYWwtdGVybXMxOTA3BgNVBAsTMChjKSAyMDEyIEVudHJ1c3QsIEluYy4gLSBmb3IgYXV0
aG9yaXplZCB1c2Ugb25seTEuMCwGA1UEAxMlRW50cnVzdCBDZXJ0aWZpY2F0aW9uIEF1dGhvcml0
eSAtIEwxSzAeFw0yMDA2MDUxODI1MDlaFw0yMTA3MTgxODU1MDlaMGoxCzAJBgNVBAYTAkNBMQ8w
DQYDVQQIEwZRdWViZWMxETAPBgNVBAcTCE1vbnRyZWFsMR4wHAYDVQQKExVDYW5hZGEgSGVhbHRo
IEluZm93YXkxFzAVBgNVBAMTDnByZXNjcmliZWl0LmNhMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKCAQEAoUUgGj2K5w4kxOkk3sydtMkpLQFU/vA0I2HbwzJbjzZHQvUXp1Qe0En7USskgLwl
Cm6IqlUtk9IIE+0o3HsXXS9eqs7UNjlUoUmqrsayFpifvseRLLwivdA7o152N5rOcJg7bikpVoXP
aW+5lykXUGyUoRkg9VND5yvrSGHIBxE+UcDZjGUpU2xUnpkY8vnzfV8a3PTDsNV2+P0PRMNxGjRw
ZVMtLuLymO8hzw3fgtd7H6ToDjhF5Z5+3jlaZ4U4XbkmNPQLyh5DkJn+Eo+7G+n28wqCLYdcV1t5
Jkuoo5i9/KG6nf7kpurLdGFkNlt7e7Ph4Ph9XwLZ8MGIBOOrpQIDAQABo4IC/TCCAvkwGQYDVR0R
BBIwEIIOcHJlc2NyaWJlaXQuY2EwggF+BgorBgEEAdZ5AgQCBIIBbgSCAWoBaAB1AFWB1MIWkDYB
SuoLm1c8U/DA5Dh4cCUIFy+jqh0HE9MMAAABcoXWPUwAAAQDAEYwRAIgA4ua0zXh3XUTbg/a20C8
sgctJG4Go7XpfgC60OvruQQCIHPUc9MldQomVjQ/nLmC5XRwbe0pH/+TeFuFATh7Fw7YAHcAVhQG
mi/XwuzT9eG9RLI+x0Z2ubyZEVzA75SYVdaJ0N0AAAFyhdY9ZAAABAMASDBGAiEAiOlJPFg0LK6h
GZEzWmL+xoptLcFgrzyOQUsbFfoe4akCIQDyQwcHMUz/C63J111AVQoGj8b8Ot8oLSFGiZnK2E6H
JAB2APZclC/RdzAiFFQYCDCUVo7jTRMZM7/fDC8gC8xO8WTjAAABcoXWPXEAAAQDAEcwRQIhAKXk
y+F3gxAAubUnwP5y7wTbc9e3FJZcwx7ADafnnaLtAiBHa9/QzujwfRMAIeQ6MEb72kTu+0M+bzgQ
4YGsetDj5zAOBgNVHQ8BAf8EBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwEwMwYDVR0fBCwwKjAo
oCagJIYiaHR0cDovL2NybC5lbnRydXN0Lm5ldC9sZXZlbDFrLmNybDBLBgNVHSAERDBCMDYGCmCG
SAGG+mwKAQUwKDAmBggrBgEFBQcCARYaaHR0cDovL3d3dy5lbnRydXN0Lm5ldC9ycGEwCAYGZ4EM
AQICMGgGCCsGAQUFBwEBBFwwWjAjBggrBgEFBQcwAYYXaHR0cDovL29jc3AuZW50cnVzdC5uZXQw
MwYIKwYBBQUHMAKGJ2h0dHA6Ly9haWEuZW50cnVzdC5uZXQvbDFrLWNoYWluMjU2LmNlcjAfBgNV
HSMEGDAWgBSConB03bxTP8971PfNf6dgxgpMvzAdBgNVHQ4EFgQU0Wrcn2q8lQCfKrKPI+xxoIO8
hg8wCQYDVR0TBAIwADANBgkqhkiG9w0BAQsFAAOCAQEAjR9CDgFeA/5RK05cz6Lule9RAVjvGgSe
ts7cgCiKkQNrTpkrdlLslDLbpMURElyXLLYjstUySWGGNjHifBE2sloC+DgWa5Kp6vJotyXuJRJ0
3yjXu0y+CYNwR+EyzpVKbGYKNahnRQZ5W4KqhcXdWzZ7baaRT6h3U2j9iw8l/UDA+D7IXE/B3odO
kIKHv7ZumMrhcUDIROBGKLC2tilDD6NPgSKcdrfre46gq+YHhAkrr6dqZl0Ft5RKwDhlmp0kGYLY
2RZqNh1IuoRRE5RifK8P/SdpjKOKlg6VO7UAn5AmUq7L8GkTRGQc61URIeqMyyclKOO6wwGlKlHe
eEEGeA==</ds:X509Certificate></ds:X509Data></ds:KeyInfo></ds:Signature><saml2:Subject><saml2:NameID Format="Telushealth.com" NameQualifier="Telushealth.com">200000026</saml2:NameID><saml2:SubjectConfirmation Method="urn:oasis:names:tc:SAML:2.0:cm:bearer"><saml2:SubjectConfirmationData NotOnOrAfter="2020-10-28T01:11:13.521Z"/></saml2:SubjectConfirmation></saml2:Subject><saml2:Conditions NotBefore="2020-10-27T13:06:13.521Z" NotOnOrAfter="2020-10-28T01:11:13.521Z"/><saml2:AuthnStatement AuthnInstant="2020-10-28T01:11:13.521Z"><saml2:AuthnContext><saml2:AuthnContextClassRef>urn:oasis:names:tc:SAML:2.0:ac:classes:SecureRemotePassword</saml2:AuthnContextClassRef></saml2:AuthnContext></saml2:AuthnStatement><saml2:AttributeStatement><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/License"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">urn:oid:2.16.840.1.113883.4.347:ON500026</saml2:AttributeValue></saml2:Attribute><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/RoleCode"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">http://hl7.org/fhir/practitioner-role|doctor</saml2:AttributeValue></saml2:Attribute><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/ServiceLocationEntityID"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">https://webservices.telus.com/rest/v1/THP/TPR_vs0/Organization/200000028</saml2:AttributeValue></saml2:Attribute><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/LastName"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Wang</saml2:AttributeValue></saml2:Attribute><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/LocalUserID"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Colomba DeAngelis MD</saml2:AttributeValue></saml2:Attribute><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/FirstName"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">Binhua</saml2:AttributeValue></saml2:Attribute><saml2:Attribute Name="http://schemas.telushealth.com/2016/05/identity/claims/AppInstanceID"><saml2:AttributeValue xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="xs:string">urn:oid:0.0.0.0.0.0.200000028</saml2:AttributeValue></saml2:Attribute></saml2:AttributeStatement></saml2:Assertion></ns:message>
	<ns:code>200</ns:code>
	<ns:timeStamp>2020-10-27 09:11:13.528</ns:timeStamp>
	<ns:X-TELUS-SDF-TraceId>578834ee-b176-45de-a26f-3fcc8e35324f</ns:X-TELUS-SDF-TraceId>
</ns:responseStatus>
  • X-SHAREDHEALTH-EXCHANGE-SAML-EXPIRY: 2018-09-25 02:54:28.136
  • X-TELUS-ERX-SAML-EXPIRY: 2018-09-25 02:54:28.136
  • X-SHX-SDF-TraceId: a1ba12a0-19d1-456a-a831-c877d3ae21ed
  • X-SHX-SDF-Site: site1.api.sharedhealth.exchange
  • X-SHX-SDF-ServerId: sdfxmlfw1
Service Response Code Headers
  • HTTP 200 for Success
  • HTTP 4xx or HTTP 5xx for any backend errors + payload. Payload format depends on whether the error is coming from the SDF (API gateway) or PrescribeIT® Central Service. In case of the SDF failure, the response is in custom XML format, in case of PrescribeIT® Central Service the response is in XML format compatible with the Response XML schema documented above (in this case, responseStatusType object has status set to Fail and message contains the details of the failure)

5.6 Formulary Query

API Type REST
Verb GET
Required Request Headers

X-SHX-SDF-Developer-Key: <value>

NOTE: <value> for X-SHX-SDF-Developer-Key is unique for each caller location. It is a credential which is supplied along with the SDF certificate to each location during its on-boarding.

Accept: application/xml+fhir
X-SHAREDHEALTH-EXCHANGE-SENDING-APP-INSTANCE-ID: <value>

X-SHAREDHEALTH-EXCHANGE-SENDING-ORGANIZATION-ID: http://sharedhealth.exchange/fhir/NamingSystem/registry-id-organization|<value>
Response Content Type application/xml+fhir
Description Query to the formulary service
Production Endpoint URL https://api.sharedhealth.exchange/rest/v1/THP/mailbox_vs0/$formulary">https://api.sharedhealth.exchange/rest/v1/THP/mailbox_vs0/$formulary
Pre-Conformance Endpoint URL https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/$formulary">https://api.sharedhealth.exchange/rest/v1/preconf/THP/mailbox_vs1/$formulary
Response Headers X-SHX-SDF-TraceId - unique identifier of this transaction generated by the server
Content-Type: application/xml+fhir
Service Response HTTP Code header and Payload
  • HTTP 200 for success + payload
  • HTTP 4xx or HTTP 5xx for any backend errors + payload. Payload format depends on whether the error is coming from the SDF (API gateway) or PrescribeIT® Central Service. In case of the SDF failure, the response is in custom XML format, in case of PrescribeIT® Central Service the response is an OperationOutcome object
Sample query

5.7 Shared Health - API Summary

The API summary for Shared Health can be found here.