Web Service:PR-WS-3: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 3: Line 3:
  |description=Fetches details of a provider by their EPID or other identification type.
  |description=Fetches details of a provider by their EPID or other identification type.
  |applications=Interoperability Layer, Point-Of-Care? Facility Registry?
  |applications=Interoperability Layer, Point-Of-Care? Facility Registry?
  |url=/ws/rest/v1/providerDetails/byid
  |url=/ws/rest/v1/providerDetails
  |params=This contains the followng parameters to identify the provider whose details we shall return:
  |params=This contains the followng parameters to identify the provider whose details we shall return:
$epid.  The providers EPID.  Required.
$epid.  The providers EPID.  Required.
*${format}The response format. One of:
*${format}The response format. One of 'json' or 'hl7'.  Defaults to 'json',
**HL7  See [http://www.google.com/url?q=http%3A%2F%2Fjira.jembi.org%2Fwiki%2Fdownload%2Fattachments%2F8912902%2FQueryProfessionalRSS.xml&sa=D&sntz=1&usg=AFQjCNEYi8ytZRJPvq8fWsoqQ1VqAToIAg QueryProfessionalRSS.xml]
|
* The HL7 v2.5 PMU_B01 messages for each professional will be specified as in  [https://docs.google.com/spreadsheet/ccc?key=0Ah8KVMJr8h4pdFlQMjNyMDh0dzhUSlJkWVgyd3lUZGc Register-or-Query-Professional]
|response=*HTTP 200 - OK
**JSON -- in this case we return an associative array containing the provider's details as well as URLs related to various actions to perform on the provider:
*For HL7  See [http://www.google.com/url?q=http%3A%2F%2Fjira.jembi.org%2Fwiki%2Fdownload%2Fattachments%2F8912902%2FQueryProfessionalRSS.xml&sa=D&sntz=1&usg=AFQjCNEYi8ytZRJPvq8fWsoqQ1VqAToIAg QueryProfessionalRSS.xml]
** The HL7 v2.5 PMU_B01 messages for each professional will be specified as in  [https://docs.google.com/spreadsheet/ccc?key=0Ah8KVMJr8h4pdFlQMjNyMDh0dzhUSlJkWVgyd3lUZGc Register-or-Query-Professional]
*For JSON we return an associative array containing the provider's details as well as URLs related to various actions to perform on the provider:
{
{
   firstname: "Bill",
   firstname: "Bill",
Line 20: Line 22:
   nid:  "333",
   nid:  "333",
   actions: {
   actions: {
     'self':
     'details': 'http://rhea.ihris.org/providerDetails?epid=123142',
     'edit':
     'edit': 'http://rhea.ihris.org/editProvider?epid=123142',
     'addPost':
     'addPost': 'http://rhea.ihris.org/addPost?epid=123142',
   }
   }
}
}
|
|response=*HTTP 200 - OK
*The HTTP response body will contain the epid as plain text.
  |error=*HTTP 500 - Server Error - If the server encountered an error.
  |error=*HTTP 500 - Server Error - If the server encountered an error.
*HTTP 400 - Bad Request - If the parameters are malformed.
*HTTP 400 - Bad Request - If the parameters are malformed.
  |resources=[[Use Case:PR-WS-3]]
  |resources=[[Use Case:PR-WS-3]]
}}
}}

Revision as of 12:41, 30 October 2012

Web Service: PR-WS-3 Get Provider Detail

Fetches details of a provider by their EPID or other identification type.

URL /ws/rest/v1/providerDetails
GET Parameters This contains the followng parameters to identify the provider whose details we shall return:

$epid. The providers EPID. Required.

  • ${format}The response format. One of 'json' or 'hl7'. Defaults to 'json',
GET Response
  • HTTP 200 - OK
  • For HL7 See QueryProfessionalRSS.xml
  • For JSON we return an associative array containing the provider's details as well as URLs related to various actions to perform on the provider:

{ 

 firstname: "Bill",
 surname:  "Smith",
 cadre: "Nurse",
 email: "bsmith@example.org",
 passport: "12312312",
 mutuelle: "123123444",
 csr:  "123123",
 nid:  "333",
 actions: {
   'details': 'http://rhea.ihris.org/providerDetails?epid=123142',
   'edit': 'http://rhea.ihris.org/editProvider?epid=123142',
   'addPost': 'http://rhea.ihris.org/addPost?epid=123142',
 }
}
GET Error
  • HTTP 500 - Server Error - If the server encountered an error.
  • HTTP 400 - Bad Request - If the parameters are malformed.

Other Resources: Use Case:PR-WS-3

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Web_Service:PR-WS-3&oldid=46618"