National Health Data Dictionary

Web Service

Date : December 29, 2020

View the WSDL for the service. Click on an operation name to view it's details

  Web Service Menu

WSDL = http://uhmistrn.doh.gov.ph/nhdd/webservice/index.php/phpcss/NHDD_V3.css/phpjs/jsrender.js?wsdl

Response Code List
Code Description
100Web Service is Running
101Web Service is Under Maintenance
102Web Service Authentication Failed!
103Error : Invalid Parameter
104Success
105Reference ID Doesn't Exists
106Reference Data is not available
107Reference Data is available for download
108Reference Data Count Retrieved
109Reference Data Retrieved
XML Tags Description
response_codeContains Response Code
response_descContains Response Description
response_datetimeServer Response Date and Time
response_valueContains Function Return Value. it can be a string value or array value
XML Format
Sample Raw XML Response for WS_Check
<NHDD>
   <response_code>100</response_code>
   <response_desc>Web Service is UP</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
</NHDD>
Sample Raw XML Response for string value
<NHDD>
   <response_code>100</response_code>
   <response_desc>Web Service is UP</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
   <response_value>Welcome</response_value>
</NHDD>
Sample Raw XML Response for array value
<NHDD>
   <response_code>104</response_code>
   <response_desc>Success</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
   <response_value>
        <SampleData>
             <lastname>Dela Cruz</lastname>
             <firstname>Juanna</firstname>
             <middlename>Damulag</middlename>
        </SampleData>
   </response_value>
</NHDD>

Web Service Function List

WS_Check
Function : WS_Check()
Description :
This Function can be used to check if the Web Service is alive
Parameters :
None
Return Value : RAW XML Format
XML Tags Description
response_codeContains Response Code
response_descContains Response Description
response_datetimeServer Response Date and Time
Code Description
100Web Service is UP
101Web Service is under Maintenance
XML Format
<MNDRS>
   <response_code>100</response_code>
   <response_desc>Web Service is UP</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
</MNDRS>
Sample Usage :
/* initialize the soapclient class */
$server = new SoapClient(http://uhmistrn.doh.gov.ph/nhdd/webservice/index.php/phpcss/NHDD_V3.css/phpjs/jsrender.js?wsdl);
/* call the function */
$check = $server->WS_Check();
checkReference
Function : checkReference()
Description :
This Function can be used to check if the Reference Data is available for download
Parameters :
checkReference($param)
Parameters Description
account_mail Account Mail
account_password Account Password
referenceid Reference ID
Return Value : RAW XML Format
XML Tags Description
response_codeContains Response Code
response_descContains Response Description
response_datetimeServer Response Date and Time
XML Format
<NHDD>
   <response_code>100</response_code>
   <response_desc>Web Service is UP</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
</NHDD>
Sample Usage :
/* initialize the soapclient class */
$server = new SoapClient(http://uhmistrn.doh.gov.ph/nhdd/webservice/index.php/phpcss/NHDD_V3.css/phpjs/jsrender.js?wsdl);

/* Parameter */
$param = array(
     'account_mail' => 'account_mail value',
     'account_password' => 'account_password value',
     'referenceid' => 'referenceid value'
);

/* call the function */
$callService = $server->checkReference($param);
getReferenceDataCount
Function : getReferenceDataCount()
Description :
This Function can be used to check the Reference Data Count
Parameters :
getReferenceDataCount($param)
Parameters Description
account_mail Account Mail
account_password Account Password
referenceid Reference ID
Return Value : RAW XML Format
XML Tags Description
response_codeContains Response Code
response_descContains Response Description
response_datetimeServer Response Date and Time
XML Format
<NHDD>
   <response_code>100</response_code>
   <response_desc>Web Service is UP</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
</NHDD>
Sample Usage :
/* initialize the soapclient class */
$server = new SoapClient(http://uhmistrn.doh.gov.ph/nhdd/webservice/index.php/phpcss/NHDD_V3.css/phpjs/jsrender.js?wsdl);

/* Parameter */
$param = array(
     'account_mail' => 'account_mail value',
     'account_password' => 'account_password value',
     'referenceid' => 'referenceid value'
);

/* call the function */
$callService = $server->getReferenceDataCount($param);
getReferenceData
Function : getReferenceData()
Description :
This Function can be used to Download the Reference Data
Parameters :
getReferenceData($param)
Parameters Description
account_mail Account Mail
account_password Account Password
referenceid Reference ID
filter Data Filter in array format ex: array( array("field"=>"Field Name","operator"=>"equal or like","value"=>"value to filter") )
limit Data Limit
offset Data Offset
Return Value : RAW XML Format
XML Tags Description
response_codeContains Response Code
response_descContains Response Description
response_datetimeServer Response Date and Time
XML Format
<NHDD>
   <response_code>100</response_code>
   <response_desc>Web Service is UP</response_desc>
   <response_datetime>June 15, 2013 1:43 AM</response_datetime>
</NHDD>
Sample Usage :
/* initialize the soapclient class */
$server = new SoapClient(http://uhmistrn.doh.gov.ph/nhdd/webservice/index.php/phpcss/NHDD_V3.css/phpjs/jsrender.js?wsdl);

/* Parameter */
$param = array(
     'account_mail' => 'account_mail value',
     'account_password' => 'account_password value',
     'referenceid' => 'referenceid value',
     'filter' => 'filter value',
     'limit' => 'limit value',
     'offset' => 'offset value'
);

/* call the function */
$callService = $server->getReferenceData($param);