Web Service:PR-WS-1: Difference between revisions
From IHRIS Wiki
No edit summary |
No edit summary |
||
(One intermediate revision 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/ | |url=/ws/rest/v1/lookupbyid/epid | ||
|params=This contains only 2 parameters to identify the professional to return ${id_type} and ${id_number} | |params=This contains only 2 parameters to identify the professional to return ${id_type} and ${id_number} | ||
Where ${id-type} is one of the following: | Where ${id-type} is one of the following: | ||
Line 10: | Line 10: | ||
*PPN - for passport number | *PPN - for passport number | ||
*SSN - for social security number | *SSN - for social security number | ||
and ${id_number} is the value of the associated id | |||
|example=?id_type=NID&id_number=1234567890 | |example=?id_type=NID&id_number=1234567890 | ||
|response=*HTTP 200 - OK | |response=*HTTP 200 - OK |
Latest revision as of 13: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:
|
GET Response |
|
GET Error |
|
GET Example | /ws/rest/v1/lookupbyid/epid/?id_type=NID&id_number=1234567890 |
Other Resources: Use Case:PR-WS-1