Dictation Provisioning

From TeleFlow

Provisioning for the TeleFlow Open Medical Dictation environment is provided in PHP code. XML is received by the PHP processor, validated and updated in the MySQL database for the application.

Contents 1 System Review 2 Commands 2.1 Testing Tool 2.2 Dictation Last 2.3 Client/Physician Add 2.4 Physician Delete 2.5 Physician Modify 3 Response Procedure

System Review

The following page will provide some feedback about recent XML requests and responses that occurred on the dictation system. The last three clients, and the last 10 physicians added to the system can be found here for verification purposes. The last five XML statements that were sent to the system and the responses are linked and can be viewed using this link:

http://222.111.222.111/client/latestadds.php

Note: 222.111.222.111 and client must be replaced with the appropriate system identifiers.

Commands

XML requests and their responses are sent and received using a PHP page. The following XML commands must be posted to this URL:

http://222.111.222.111/client/syscommand.php

Note: 222.111.222.111 and client must be replaced with the appropriate system identifiers.

The Body must include one of the commands as described in the following section.

Testing Tool

A testing tool has been created to make it easier to test XML Posts and Requests on test and live systems. Refer to the HTTP XML Post testing tool page for information an download links.

Dictation Last

If you are setting up a new XML application or simply want to test to see that the Dictation environment is being responsive, use the following command. This commands provides information about the last Dictation made to the system.

Request (body)

<?xml version="1.0" encoding="utf-8"?>
  <REQUEST action="DictationLast"></REQUEST>

Response (example)

<?xml version="1.0" encoding="utf-8"?> 
<RESPONSE action="DictationLast"> 
  <RESULT PhysicianID="5000" Confirmation="000999"  
      FileStatus="Uploaded" CallDNIS="8885551233"  
      FileDate="2007/05/23" FileTime="17:19:39">SUCCESS</RESULT> 
</RESPONSE>

Client/Physician Add

Add a new Physician to a Client (and create client if it does not exist). This command will also write an entry in the TeleFlowVoiceOffice database to create a DNIS for a new Client.

Request (body)

<?xml version="1.0" encoding="utf-8"?>
  <REQUEST action="Add"> 
    <PHYSICIAN id="9999" firstname="PhysFirst" lastname="PhysLast" clientid="8885551234" clientname="XXXX" />
  </REQUEST>

Response (example)

<RESPONSE action="Add"> 
  <RESULT DNIS="8885551234">Added</RESULT>
  <RESULT PhysicianID="9999" ClientID="8885551234" ClientStatus="Added">Added</RESULT>
</RESPONSE>

Physician Delete

Delete a Physician from a Client. This command will not actually remove the record from the database, but will only mark it as “deleted”. The only way to undelete a Physician is to use the “Physician Modify” command, which will implicitly enable the record.

Request (body)

<?xml version="1.0" encoding="utf-8"?>
  <REQUEST action="Delete"> 
    <PHYSICIAN id="9999" clientid="8885551234" clientname="XXXX" />
  </REQUEST>

Response (example)

<RESPONSE action="Delete"> 
  <RESULT PhysicianID="9999" ClientID="8885551234" ClientStatus="Exists">Deleted</RESULT>
</RESPONSE>

Physician Modify

Add a new Physician to a Client (and create client if it does not exist)

Request (body)

<?xml version="1.0" encoding="utf-8"?>
<REQUEST action="Modify"> 
  <PHYSICIAN id="9999" firstname="Robert" lastname="Smith" clientid="8885551234" clientname="XXXX" />
</REQUEST>

Response (example)

<RESPONSE action="Modify"> 
  <RESULT PhysicianID="9999" ClientID="8885551234" ClientStatus="Exists">Modified</RESULT>
</RESPONSE>

Response Procedure

The XML will return to the HTTP request for the XML request. Any errors will occur with some statements as to what the problem is. However, XML response codes should be reviewed to ensure the appropriate action did indeed occur.

These should be considered SUCCESS conditions:

	Added	Physician [and possibly Client] Added
	Modified	Physician updated
	Deleted	Physician is marked as Deleted - Not removed
	Exists	Client or Physician is in the database already

These should be considered ERROR conditions:

	Failed	Data not updated
	NotFound	Data not located to update

These should be considered FATAL conditions:

DataError

Critical failure - Bug

This is superfluous:

Unknown

Data was not needed or referenced for the command