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

From IHRIS Wiki
(Created page with "{{WebServicePage|Get Enterprise Professional ID |number=PR-WS-1 |description=Fetches a HC Professional Enterprise ID for the professional specified by the professional ID param...")
 
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 3: Line 3:
  |description=Fetches a HC Professional Enterprise ID for the professional specified by the professional ID parameter.
  |description=Fetches a HC Professional Enterprise ID for the professional specified by the professional ID parameter.
  |applications=Interoperability Layer, Point-Of-Care?
  |applications=Interoperability Layer, Point-Of-Care?
  |url=/ws/rest/v1/professional/${pro-id}/epid
  |url=/ws/rest/v1/lookupbyid/epid
  |params=This contains only 1 parameter to identify the professional to return ${pro-ID}
  |params=This contains only 2 parameters to identify the professional to return ${id_type} and ${id_number}
The unique professional ID for the professional requested with the following format:
Where ${id-type} is one of the following:
 
*NID - for a national identification number
<ID-type>-<ID-number>
*APN - for an application number
 
*PPN - for passport number
Where <ID-type> is one of the following:
*SSN - for social security number
 
and ${id_number} is the value of the associated id
            NID - for a national identification number
|example=?id_type=NID&id_number=1234567890
            APN - for an application number
            PPN - for passport number
            SSN - for social security number
 
        Eg. GET /ws/rest/v1/professional/NID-1234567890/epid
  |response=*HTTP 200 - OK
  |response=*HTTP 200 - OK
*The HTTP response body will contain the epid as plain text.
*The HTTP response body will contain the epid as plain text.

Latest revision as of 12:27, 30 October 2012

Web Service: PR-WS-1 Get Enterprise Professional ID

Fetches a HC Professional Enterprise ID for the professional specified by the professional ID parameter.

URL /ws/rest/v1/lookupbyid/epid
GET Parameters This contains only 2 parameters to identify the professional to return ${id_type} and ${id_number}

Where ${id-type} is one of the following:

  • NID - for a national identification number
  • APN - for an application number
  • PPN - for passport number
  • SSN - for social security number
and ${id_number} is the value of the associated id
GET Response
  • HTTP 200 - OK
  • The HTTP response body will contain the epid as plain text.
GET Error
  • HTTP 500 - Server Error - If the server encountered an error.
  • HTTP 400 - Bad Request - If the parameters are malformed.
GET Example /ws/rest/v1/lookupbyid/epid/?id_type=NID&id_number=1234567890

Other Resources: Use Case:PR-WS-1

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