3.0 Heading Parameter and authentication data

Each procedure call contains a heading parameter as the first parameter. This parameter is a struct and must contain by default the following keys:

Compulsory keys and data.

When the header is missing, the application will return an _ERROR_AUTH_BADHEADER error message and 1000 error code.

Optional keys and data:

The availability of optional keys can be detected either on the fly or during configuration by using the following system procedure calls:

System.Header.Keys.lang

System.Header.Keys.sid

System.Header.Keys.version

If the key is supported by the application, the returned value should be integer 1.

Other keys and data can be added according to the application's design but these are not considered standard and should be documented and published.

1. Sample call with header parameter (php, no error handling)

$header['usr']='demo';

$header['pw']='demo';

$hxpclient->query('Person',$header,2004560032);

$response = $hxp_client->getResponse();

echo $response['name_last'];

4.0 Person Calls

Person

Returns a struct of the person's registration data:

sample php query

$hxpclient->query('Person',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 20031009900;

$hxpclient->query('Person',$header,$pid);

$response=$hxpclient->getResponse();

echo $response['name_last'];

Returned struct has the following keys:

pid	Person Identifier (numeric)
name_last	Last or family name
name_first	First or given name
name_middle	Middle name
name_2	Second name
name_3	Third name
name_maiden	Maiden name
name_others	Other name or aliases
sex	Sex (m = male), (f = female)
date_birth	Date of birth (YYYY-MM-DD)
title	Title
date_reg	Registration date (YYYY-MM-DD)
blood_group	Blood group (A,B,AB,O)
addr_str	Address: street name
addr_str_nr	Address: street number
addr_zip	Address: Zip code
addr_citytown_nr	Address: City or town's number (usually for internal use only)
phone_1_code	Phone area code #1
phone_1_nr	Phone number #1
phone_2_code	Phone area code #2
phone_2_nr	Phone number #2
cellphone_1_nr	Cellphone #1
cellphone_2_nr	Cellphone #2
fax	Fax number
email	Email address
civil_status	Civil status (single, married, divorced, widowed)
photo_filename	Filename of the stored photo ID
ethnic_orig	Ethnic origin
sss_nr	Social security system number/ID
nat_id_nr	National ID number
religion	Religion
mother_pid	Mother's PID
father_pid	Father's PID
contact_person	Contact person's name
contact_pid	Contact person's PID
contact_relation	Relation to contact person
death_date	Date of person's death
death_encounter_nr	Related encounter number related to death
death_cause	Cause of death (free text)
death_cause_code	Cause of death code (e.g. ICD10)
status	Record's status (normal,hidden,deleted,locked)
history	Record's history
modify_id	Username of modifier
modify_time	Modification timestamp (YYYYMMDDhhmmss)
create_id	Username of record creator
create_time	Creation timestamp (YYYYmmddhhmmss)

Returns the person's basic data.

sample php query

$hxpclient->query('Person.Basic',$header,$PID)

Sample use (php, without error handling)

	$header['usr']='demouser';
	$header['pw']='demopass';

	$pid = 20031009900;

	$hxpclient->query('Person.Basic',$header,$pid);
	$response=$hxpclient->getResponse();

	echo $response['addr_str'];

Person.List

	
	Returns an array of struct containing the data of persons who are not hidden, nor deleted, nor locked. 

sample php query

$hxpclient->query('Person.List',$header)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$hxpclient->query('Person.List',$header);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

	The struct contains the following keys:	

pid	Person Identifier (numeric)
name_last	Last or family name
name_first	First or given name
name_middle	Middle name
name_2	Second name
name_3	Third name
name_maiden	Maiden name
name_others	Other name or aliases
sex	Sex (m = male), (f = female)
date_birth	Date of birth (YYYY-MM-DD)
title	Title
date_reg	Registration date (YYYY-MM-DD)
blood_group	Blood group (A,B,AB,O)
addr_str	Address: street name
addr_str_nr	Address: street number
addr_zip	Address: Zip code
addr_citytown_nr	Address: City or town's number (usually for internal use only)
phone_1_code	Phone area code #1
phone_1_nr	Phone number #1
phone_2_code	Phone area code #2
phone_2_nr	Phone number #2
cellphone_1_nr	Cellphone #1
cellphone_2_nr	Cellphone #2
fax	Fax number
email	Email address
civil_status	Civil status (single, married, divorced, widowed)
photo_filename	Filename of the stored photo ID
ethnic_orig	Ethnic origin
sss_nr	Social security system number/ID
nat_id_nr	National ID number
religion	Religion
mother_pid	Mother's PID
father_pid	Father's PID
contact_person	Contact person's name
contact_pid	Contact person's PID
contact_relation	Relation to contact person
death_date	Date of person's death
death_encounter_nr	Related encounter number related to death
death_cause	Cause of death (free text)
death_cause_code	Cause of death code (e.g. ICD10)
status	Record's status (normal,hidden,deleted,locked)
history	Record's history
modify_id	Username of modifier
modify_time	Modification timestamp (YYYYMMDDhhmmss)
create_id	Username of record creator
create_time	Creation timestamp (YYYYmmddhhmmss)

Person.Encounter.ENR



Person.Encounter.ENR.List

	Alias of Person.Encounter.ENR



Person.Encounter.ENR.Current

	Returns the person's current encounter number (numeric).
	

sample php query

$hxpclient->query('Person.Encounter.ENR.Current',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$hxpclient->query('Person.Encounter.ENR.Current',$header);

$response = $hxpclient->getResponse();

echo $response;

Person.Encounter.Search
	
	Reserved

Person.Search

	Returns an array of structs containing the data of persons who are not hidden,deleted, nor locked.
	

sample php query

$hxpclient->query('Person.Search',$header,$keyword)

	The struct contains the following keys:

pid	Person Identifier (numeric)
name_last	Last or family name
name_first	First or given name
sex	Sex (m = male), (f = female)
date_birth	Date of birth (YYYY-MM-DD)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$keyword = 'adam';

$hxpclient->query('Person.Search',$header,$keyword);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

Person.Name.First
	
	Returns the person's first (or given) name.	

sample php query

$hxpclient->query('Person.Name.First',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.First',$header,$pid);

echo $hxpclient->getResponse();

Person.Name.Family
	
	Person.Name.Family(header,PID) = call 

	Returns the person's family (or last) name.
	

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.Family',$header,$pid);

echo $hxpclient->getResponse();

Person.Name.Middle
	
	Returns the person's middle name.	

sample php query

$hxpclient->query('Person.Name.Middle',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.Middle',$header,$pid);

echo $hxpclient->getResponse();

Person.Name.Maiden
	
	Returns the person's maiden name (family name by birth).

sample php query

$hxpclient->query('Person.Name.Maiden',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.Maiden',$header,$pid);

echo $hxpclient->getResponse();

Person.Name.Second
	
	Returns the person's second name.

sample php query

$hxpclient->query('Person.Name.Second',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.Second',$header,$pid);

echo $hxpclient->getResponse();

Person.Name.Third

	Returns the person's third name.

sample php query

$hxpclient->query('Person.Name.Third',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.Third',$header,$pid);

echo $hxpclient->getResponse();

Person.Name.Others

	Returns the person's other names.

sample php query

$hxpclient->query('Person.Name.Others',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Name.Others',$header,$pid);

echo $hxpclient->getResponse();

Person.Birth.Date

	Returns the person's date of birth in YYYY-MM-DD format.

sample php query

$hxpclient->query('Person.Birth.Date.$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Birth.Date',$header,$pid);

echo $hxpclient->getResponse();

Person.Birth.Details

	Reserved




Person.Died.Date

	Returns the person's date when he died.

sample php query

$hxpclient->query('Person.Died.Date',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Died.Date',$header,$pid);

echo $hxpclient->getResponse();

Person.Died.Cause
	

	Returns the cause of person's death in free text.
	

sample php query

$hxpclient->query('Person.Died.Cause',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Died.Cause',$header,$pid);

echo $hxpclient->getResponse();

Person.Died.Cause.Code

	Returns the cause of death code.

sample php query

$hxpclient->query('Person.Died.Cause.Code',$header,$PID)

	The returned  struct contains the following keys:
	

code

The code 

type

The code type e.g. ICD9, ICD10, etc.

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Died.Cause.Code',$header,$pid);

$response = $hxpclient->getResponse();

echo $response['code'];

echo $response['type'];

Person.Died.Encounter.ENR
	
	Returns the encounter number related to the person's death.

sample php query

$hxpclient->query('Person.Died.Encounter.ENR',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Died.Encounter.ENR',$header,$pid);

echo $hxpclient->getResponse();

Person.Registry.Date

	Returns the date of person's registration in the database in YYYY-MM-DD format.

sample php query

$hxpclient->query('Person.Registry.Date',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Registry.Date',$header,$pid);

echo $hxpclient->getResponse();

Person.Appointment.List

	Returns an array of struct containing the person's appointments data which are not hidden, nor locked, nor deleted.

sample php query

$hxpclient->query('Person.Appointment.List',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$response = $hxpclient->query('Person.Registry.Date',$header,$pid);

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

Person.Appointment

	Returns a struct of person's appointments based on a supplied primary key.

sample php query

$hxpclient->query('Person.Registry.Date',$header,$key)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$response = $hxpclient->query('Person.Registry.Date',$header,$pid);

while(list($key,$data)=each($response)){

echo “ $key >>> $data ”;

}

Person.Address

	Person.Address(header,PID) = call 

	Returns a struct containing the person's address.

sample php query

$hxpclient->query('Person.Address',$header,$PID)

	The returned struct contains the following keys:

addr_str

Street name

addr_str_nr

Street number

addr_zip

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address',$header,$pid);

$response = $hxpclient->getResponse();

echo $response['addr_str'];

echo $response['addr_str_nr'];

Person.Address.FullText

	Returns the person's full address in text format.

sample php query

$hxpclient->query('Person.Address.FullText',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address.FullText',$header,$pid);

echo $hxpclient->getResponse();

Person.Address.Street

	Returns the address street name.

sample php query

$hxpclient->query('Person.Address.Street',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address.Street',$header,$pid);

		echo $hxpclient->getResponse();




Person.Address.Street.Nr

	Returns the address street number.

sample php query

$hxpclient->query('Person.Address.Street.Nr',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address.Street.Nr',$header,$pid);

		echo $hxpclient->getResponse();




Person.Address.CityTown

	Returns the city or town's name.

sample php query

$hxpclient->query('Person.Address.CityTown',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address.CityTown',$header,$pid);

		echo $hxpclient->getResponse();



Person.Address.Zip

	Returns the zip code.

sample php query

$hxpclient->query('Person.Address.Zip',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address.Zip',$header,$pid);

		echo $hxpclient->getResponse();




Person.Address.Email

	Returns the email address.

sample php query

$hxpclient->query('Person.Address.Email',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Address.Email',$header,$pid);

		echo $hxpclient->getResponse();




Person.Phone.1

	Returns the first telephone number.

sample php query

$hxpclient->query('Person.Phone.1',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Phone.1',$header,$pid);

		echo $hxpclient->getResponse();




Person.Phone.1.Area.Code


	Returns the first telephone area code.

sample php query

$hxpclient->query('Person.Phone.1.Area.Code',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Phone.1.Area.Code',$header,$pid);

		echo $hxpclient->getResponse();



Person.Phone.2

	Returns the second telephone number.

sample php query

$hxpclient->query('Person.Phone.2',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Phone.2',$header,$pid);

		echo $hxpclient->getResponse();



 Person.Phone.2.Area.Code

	Returns the first telephone area code.

sample php query

$hxpclient->query('Person.Phone.2.Area.Code',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Phone.2.Area.Code',$header,$pid);

		echo $hxpclient->getResponse();
 
 
 
Person.Phone.Cell.1

	Returns the second cellphone number.

sample php query

$hxpclient->query('Person.Phone.Cell.1',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Phone.Cell.1',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Phone.Cell.2

	Returns the second cellphone number.

sample php query

$hxpclient->query('Person.Phone.Cell.2',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Phone.Cell.2',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Fax.Nr

	Returns the fax number.

sample php query

$hxpclient->query('Person.Fax.Nr',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Fax.Nr',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Blood.Group

	Returns the fax number.

sample php query

$hxpclient->query('Person.Blood.Group',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Blood.Group',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Mother.PID

	Returns the mother's PID.

sample php query

$hxpclient->query('Person.Mother.PID',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Mother.PID',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Father.PID

	Returns the  father's PID.

sample php query

$hxpclient->query('Person.Father.PID',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Mother.PID',$header,$pid);

		echo $hxpclient->getResponse();

Person.Insurance.1.Nr

	Returns the  first insurance number.

sample php query

$hxpclient->query('Person.Insurance.1.Nr',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Insurance.1.Nr',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Insurance.1.Co.ID

	Returns the  first insurance company ID.

sample php query

$hxpclient->query('Person.Insurance.1.Co.ID',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Insurance.1.Co.ID',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Insurance.2.Nr

	Returns the  second insurance number.

sample php query

$hxpclient->query('Person.Insurance.2.Nr',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Insurance.2.Nr',$header,$pid);

		echo $hxpclient->getResponse();


 
 
Person.Insurance.2.Co.ID

	Returns the  second insurance company ID.

sample php query

$hxpclient->query('Person.Insurance.2.Co.ID',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Insurance.2.Co.ID',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Contact

	Returns the  contact person's name.

sample php query

$hxpclient->query('Person.Contact',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Contact',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Contact.PID

	Returns the  contact person's PID.

sample php query

$hxpclient->query('Person.Contact.PID',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Contact.PID',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Contact.Relation

	Returns the  relation to the contact person.

sample php query

$hxpclient->query('Person.Contact.Relation',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Contact.Relation',$header,$pid);

		echo $hxpclient->getResponse();

 

Person.Add

	Add new person registration data.

sample php query

$hxpclient->query('Person.Contact.Relation',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$regdata['name_first']= 'Smith';

$regdata['name_last']= 'Peter';

$regdata['date_birth'] = '2001-11-03';

$hxpclient->query('Person.Add',$header,$regdata);

Person.Update

	Update person registration data.

sample php query

$hxpclient->query('Person.Contact.Relation',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$regdata['name_first']= 'Smith';

$regdata['name_last']= 'Peter';

$regdata['date_birth'] = '2001-11-03';

$hxpclient->query('Person.Update',$header,$regdata);

Person.Record.Hide

	Flags the record as “hidden”.

sample php query

$hxpclient->query('Person.Record.Hide',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Record.Hide',$header,$pid);

Person.Record.Lock

	Flags the record as “locked”.

sample php query

$hxpclient->query('Person.Record.Lock',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Record.Lock',$header,$pid);

Person.Record.Delete

	Flags the record as “deleted”.

sample php query

$hxpclient->query('Person.Record.Delete',$header,$PID)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 100300455;

$hxpclient->query('Person.Record.Delete',$header,$pid);

0. Encounter Calls

Encounter

Returns a struct of the patient's encounter (admission) data:

*ENR = encounter number

sample php query

$hxpclient->query('Encounter',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$pid = 20031009900;

$hxpclient->query('Encounter',$header,$pid);

$response=$hxpclient->getResponse();

echo $response['name_last'];

Returned struct contains the following keys and data:

Encounter.List

Returns an array of structs containing the encounter data of patients who are not discharged, hidden,deleted, nor locked.

sample php query

$hxpclient->query('Encounter',$header)

	Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$hxpclient->query('Encounter.List',$header);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

	The struct contains the following keys:

Encounter.Outpatient.List

Returns an array of structs containing the encounter data of outpatients who are not discharged, hidden,deleted, nor locked.

sample php query

$hxpclient->query('Encounter',$header)

	Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$hxpclient->query('Encounter.Outpatient.List',$header);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

	The struct contains the following keys:

Encounter.Inpatient.List

Returns an array of structs containing the encounter data of inpatients who are not discharged, hidden,deleted, nor locked.

sample php query

$hxpclient->query('Encounter',$header)

	Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$hxpclient->query('Encounter.Inpatient.List',$header);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

	The struct contains the following keys:

Encounter.Exists

Returns the PID number if the encounter exists, otherwise returns zero or empty string.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Search

Searches encounters basing on a supplied keyword and returns an array of structs containing the encounter data of patients who are not discharged, hidden,deleted, nor locked.

sample php query

$hxpclient->query('Encounter.Search',$header)

	Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$hxpclient->query('Encounter.Search',$header, $keyword);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

	The struct contains the following keys:

Encounter.Status

Returns the status of the encounter (not the record).

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Status',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Status',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.PID

Returns the PID number of the encounter.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.PID',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.PID',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Admission.Date

Returns the admission date of encounter.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Admission.Date',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Admission.Date',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Admission.Type

Returns the admision type of encounter.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Admission.Type',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Admission.Date',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Discharge.Time

Returns the time of discharge.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Discharge.Time',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Discharge.Time',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Discharge.Is

	Returns the time of discharge.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Discharge.Time',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Discharge.Time',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Discharge.Type

	Returns the type of discharge.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Discharge.Type',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Discharge.Type',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Payment.Type

	Returns the type of payment (financial class).

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Payment.Type',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Payment.Type ',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Dept.Current.Nr

	Returns a numeric key to the current department of the encounter. 
	This key can be used to retrieve more detailed information about the department using appropriate procedure calls.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Dept.Current.Nr ',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Dept.Current.Nr',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Firm.Current.Nr

	Returns a numeric key to the current firm related with the encounter. 
	This key can be used to retrieve more detailed information about the firm using appropriate procedure calls.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Dept.Current.Nr ',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Dept.Current.Nr',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Doctor.Attending

	Returns the attending doctor.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Doctor.Attending',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Doctor.Attending',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Doctor.Consulting

	Returns the consulting doctor.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Doctor.Consulting',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Doctor.Consulting',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Referrer

	Returns the Referrer.

sample php query

$hxpclient->query('Encounter.Referrer',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Referrer.Diagnosis

	Returns the Referrer's preliminary diagnosis.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Referrer.Diagnosis',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer.Diagnosis ',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Referrer.Therapy.Recommended

	Returns the recommended therapy from the Referrer.

*ENR = encounter number

sample php query

$hxpclient->query('Encounter.Referrer.Therapy.Recommend',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer.Therapy.Recommend',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Referrer.Notes

	Returns the Referrer's notes or remarks.

sample php query

$hxpclient->query('Encounter.Referrer.Notes',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer.Notes',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Referrer.Dept

	Returns the referring department.

sample php query

$hxpclient->query('Encounter.Referrer.Dept',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer.Dept',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Referrer.Institution

	Returns the referring department.

sample php query

$hxpclient->query('Encounter.Referrer.Dept',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer.Dept',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Dept.Is.In

	Returns 1 if the patient is admitted in the given department.

sample php query

$hxpclient->query('Encounter.Dept.Is.In',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Referrer.Dept',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Ward.Current.Nr

	Returns a numeric key to the current ward of the encounter. This key can be used to extract more detailed information about the ward using appropriate calls.

sample php query

$hxpclient->query('Encounter.Ward.Current.Nr',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Ward.Current.Nr',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Ward.Is.In

	Returns a numeric key to ward information if the patient is admitted in the given ward. If false, the call returns either a zero or an empty string.

sample php query

$hxpclient->query('Encounter.Ward.Is.In,$header,$ENR,$ward)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Ward.Current.Nr',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Followup.Date

	Returns the followup date.

sample php query

$hxpclient->query('Encounter.Followup.Date',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Followup.Date',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Followup.Responsible

	Returns the name of person (or institution) responsible for follow up.

sample php query

$hxpclient->query('Encounter.Followup.Responsible',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Followup.Responsible',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Post.Notes

	Returns the post-encounter notes.

sample php query

$hxpclient->query('Encounter.Post.Notes',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Post.Notes',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Service.Extra

	Returns extra services information.

sample php query

$hxpclient->query('Encounter.Service.Extra',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Service.Extra',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Record.Status

	Returns the record's status.

sample php query

$hxpclient->query('Encounter.Record.Status',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Record.Status',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Record.History

	Returns the record's history.

sample php query

$hxpclient->query('Encounter.Record.Status',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Record.History',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Record.Hide

	Returns the record's status.

sample php query

$hxpclient->query('Encounter.Record.Status',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Record.Status',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Record.Lock

	Locks the encounter record. Sets the record status to “locked”.

sample php query

$hxpclient->query('Encounter.Record.Lock',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Record.Lock',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Record.Delete

	“Deletes” the encounter record. Sets the record status to “deleted”. The record is not physically deleted.

sample php query

$hxpclient->query('Encounter.Record.Lock',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Record.Delete',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Record.Normal

	“Normalizes” the encounter record. Sets the record status to “normal”. 

sample php query

$hxpclient->query('Encounter.Record.Normal',$header,$ENR)

*ENR = encounter number

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('Encounter.Record.Normal',$header,$ENR);

$response=$hxpclient->getResponse();

echo $response;

Encounter.Pregnancy

Reserved

Electronic Medical Record (EMR) Calls

EMR.History.List

	Returns an array of struct containing pointers to admission history (physical) records of the encounter.
	

sample php query

$hxpclient->query('EMR.History.List',$header,$ENR)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$ENR = 20031009900;

$hxpclient->query('EMR.History.List',$header,$ENR);

$response=$hxpclient->getResponse();

while(list($ar,$st)=each($response)){

while(list($key,$data)=each($st)){

echo “ $key >>> $data ”;

}

}

	The struct contains the following keys:

nr	(integer) Key to the record
short_notes	(string) Short notes
aux_notes	(string) Auxillary notes
ref_notes_nr	(integer) Key to a related record
personell_nr	(integer) Author's personnel number (key)
personell_name	(string) Author's name
date	(string) Date of creation (YYYY-MM-DD)
time	(string) Time of creation (HH:mm:ss)

EMR.History

Returns a struct of the encounter's admission history (physical) based on a key:

sample php query

$hxpclient->query('EMR.History',$header,$key)

Sample use (php, without error handling)

$header['usr']='demouser';

$header['pw']='demopass';

$key = 1032;

$hxpclient->query('EMR.History',$header,$key);

$response=$hxpclient->getResponse();

echo $response['notes'];

Returned struct has the following keys:

nr	(integer) Record's primary key
encounter_nr	(integer) Encounter number
type_nr	(integer) Record type number (foreign key)
notes	(string) Admission history (physical)
short_notes	(string) Short notes or summary
aux_notes	(string) Auxillary notes or remarks
ref_notes_nr	(integer) Key to a related record
personell_nr	(integer) Author's personnel number
personell_name	(string) Author's name
send_to_pid	(integer) PID number of record's receiving person
send_to_name	(string) Name of record's receiver
date	(string) Date of creation (YYYY-MM-DD)
time	(string) Time of creation (HH:mm:ss)
location_type	(string) Location type (e.g. Department,ward.etc)
location_nr	(integer) Key to location
location_id	(string) Location ID
ack_short_id	(string) Acknowledgement ID
date_ack	(string) Date of acknowledgement (YYYY-MM-DD)
date_checked	(string) Date the record checked (YYYY-MM-DD)
date_printed	(string) Date the record printed (YYYY-MM-DD)
send_by_mail	(integer) Record send by mail flag (1 = true, 0 = false)
send_by_email	(integer) Record send by email flag (1 = true, 0 = false)
send_by_fax	(integer) Record send by faxl flag (1 = true, 0 = false)
status	Record's status (normal,hidden,deleted,locked)
history	Record's history
modify_id	Username of modifier
modify_time	Modification timestamp (YYYYMMDDhhmmss)
create_id	Username of record creator
create_time	Creation timestamp (YYYYmmddhhmmss)