Shared Health Specification and Guide Version 5.0

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
Content-Type: application/xml+fhir

<OperationOutcome xmlns="http://hl7.org/fhir">
	<id value="0b1f172e-572b-4d84-a35e-8065ef4d9a07"/>
	<issue>
		<extension url="http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-usertext">
			<valueString value="Please log into PrescribeIT again.  If issue persists, please call Technical Support Team and provide the Detail Code and Reference Number shown below. 
 Detail Code ISS142 - Reference # 72efc58a-1f1a-44d9-b964-1cebd10eb04f.">
				<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ST-translation">
					<valueString value="Veuillez vous reconnecter à PrescripTIon. Si le problème persiste, communiquez avec le soutien technique et fournissez-lui le code de détail et le numéro de référence indiqués ci-dessous. 
 Code de détail ISS142 - Numéro de référence 72efc58a-1f1a-44d9-b964-1cebd10eb04f.">
						<extension url="http://hl7.org/fhir/StructureDefinition/iso21090-ST-language">
							<valueCode value="fr-CA"/>
						</extension>
					</valueString>
				</extension>
			</valueString>
		</extension>
		<extension url="http://sharedhealth.exchange/fhir/StructureDefinition/ext-operationoutcome-referencenum">
			<valueString value="72efc58a-1f1a-44d9-b964-1cebd10eb04f"/>
		</extension>
		<severity value="error"/>
		<code value="security"/>
		<details>
			<coding>
				<code value="ISS142"/>
			</coding>
			<text value="Invalid SAML claim."/>
		</details>
	</issue>
</OperationOutcome>

• HTTP 201 for success. Response payload is always empty for all bundle types except 401. Response payload for 401 bundle contains an updated FHIR message containing additional bundle-level metadata (message key, last name and birth date tags)
• 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

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

• HTTP 200 for success + payload as FHIR bundle
• 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

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
Content-Type: application/xml+fhir

• HTTP 200 for success + payload as FHIR bundle. Note: any failure(s) encountered during the acknowledgment of the individual message(s) will be reported in the response payload, in this case HTTP 200 will still be returned from the API call
• 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

<Bundle xmlns="http://hl7.org/fhir">
	<id value="message-clear-queue-request"/>
	<meta>
		<profile value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-request/"/>
	</meta>
	<type value="batch"/>
	<entry>
		<request>
			<method value="DELETE"/>
			<url value="https://SDF.Telus.com/mailbox/v1/Bundle/54a05d42-5da2-4c8c-8e14-876441d71b70"/>
		</request>
	</entry>
	<entry>
		<request>
			<method value="DELETE"/>
			<url value="https://SDF.Telus.com/mailbox/v1/Bundle/1377f0f6-243a-4c07-964b-8a46143f3cc4"/>
		</request>
	</entry>
</Bundle>
          

<Bundle xmlns="http://hl7.org/fhir">
   <id value="3079b918-8fcc-45cf-b64b-a1629337f889"/>
   <meta>
      <profile value="http://sharedhealth.exchange/fhir/StructureDefinition/interaction-bundle-clear-queue-response"/>
   </meta>
   <type value="batch-response"/>
   <entry>
      <response>
         <status value="202 Accepted"/>
      </response>
   </entry>
   <entry>
      <response>
         <status value="202 Accepted"/>
      </response>
   </entry>
</Bundle>

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

• HTTP 200 for success, response payload is Organization or Practitioner object in FHIR format
• 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

https://api.sharedhealth.exchange/rest/v1/THP/TPR_vs0/Organization?${OrganizationSearchParameters}
https://api.sharedhealth.exchange/rest/v1/THP/TPR_vs0/Practitioner?${PractitionerSearchParameters}

https://api.sharedhealth.exchange/rest/v1/preconf/THP/TPR_vs1/Organization?${OrganizationSearchParameters}
https://api.sharedhealth.exchange/rest/v1/preconf/THP/TPR_vs1/Practitioner?${PractitionerSearchParameters}

• Search returns only organizations/practitioners with active PrescribeIT® and/or Clinician Communication contracts
• Wildcards in parameter values are not allowed

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

• HTTP 200 for success, response payload contains search results in FHIR format
• 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

As per the FHIR Search this is a POST using the standard application/x-www-form-urlencoded.

This endpoint will support two use cases as described in Group No 4 Bulk TPR Queries:

Periodic Sync of Matched Records

Supported parameters are:

• role=OUTPHARM (required, 1..1)
• identifier (required, 1..*)
• _lastUpdated (optional, 0..1) "gt" is mandatory as this is the only supported date prefix. Example (non-encoded): &_lastUpdated=gt2020-10-01T10:00:00

Bulk Update of unmatched Records

Supported parameters are:

• role=OUTPHARM (required, 1..1)
• telecom-fax:exact (required, 1..*)

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

Content-Type: application/x-www-form-urlencoded

POST https://api.sharedhealth.exchange/rest/v1/THP/TPR_vs0/Organization/_search?_query=bulkSync

Body:

role=OUTPHARM&telecom-fax%3Aexact=5555551212,905673435,4162004566

Service to search organizations to support bulk registry queries.

HTTP 200 for success

HTTP 500 for any backend errors+ Operation Outcome with errors details.