An easy to use PHP library to connect to
Microsoft® HealthVault™
on top of
HVRawConnectorPHP.
It adds a nicer object oriented programming interface and hides (most) of the
complicated XML parts in the HealthVault protocol., (*1)
This library was forked from HVClientPHP and many new features have been created and added to the library. A list of changes is at the bottom of this document., (*2)
Installation
HVClientLibPHP depends on
HVRawConnectorPHP., (*3)
You can simply use composer to install HVRawConnectorPHP and it's dependencies., (*4)
To add HVClientLibPHP as a library in your project, add something like that to
the 'require' section of your composer.json:, (*5)
{
"require": {
"communitychair1/hv-client-lib": "dev-master"
}
}
If composer complains about an unknown pear channel, add this to your composer.json:, (*6)
{
"repositories": [
{
"type": "pear",
"url": "http://pear.php.net"
}
]
}
Earlier version of HVClientLibPHP could also be installed by pear including all
it's dependencies:, (*7)
pear channel-discover pear.biologis.com
pear channel-discover pear.querypath.org
pear install biologis/HVClient
This method will install HVClientLibPHP as a library, but without the
available demo application., (*8)
Status
HVClientLibPHP is not a full featured HealthVault SDK, but should provide all
the required stuff to create powerful HealthVault applications with PHP., (*9)
It can basically handle all
Things already,
but over the time we will add some more convenience function to the representing
classes., (*10)
But the number of implemented
Methods is very
limited at the moment (the essential ones are available):
* GetPersonInfo
* GetThings
* PutThings, (*11)
If you need more and understand the available
Documentation, you can always
use HVRawConnectorPHP directly. In that case you should ideally contribute your
work to let HVClientLibPHP grow faster., (*12)
Usage
This is a simple example to display all weight measurements:, (*13)
$hv = new HVClient($yourAppId, $_SESSION);
$hv->connect($yourCertThumbPrint, $yourPrivateKey);
$personInfo = $hv->getPersonInfo();
$recordId = $personInfo->selected_record_id;
$things = $hv->getThings('Weight Measurement', $recordId);
foreach ($things as $thing) {
print $thing->weight->value->kg;
}
Connect a different HealthVault™ instance using a different country and
language:, (*14)
$hv = new HVClient($yourAppId, $_SESSION);
$hv->setHealthVaultPlatform(
'https://platform.healthvault-ppe.co.uk/platform/wildcat.ashx');
$hv->setLanguage('de');
$hv->setCountry('DE');
$hv->connect($yourCertThumbPrint, $yourPrivateKey);
To connect your PHP based HealthVault™ app, your app needs to authorized by
the user and the user himself needs to be authenticated against HealthVault™.
If any of these requirements are not met, HVClientLibPHP throws corresponding
exceptions. In this case you can create a link that takes the user to
HealthVault™ to authenticate himself and to authorize your app and takes him
back to your site afterwards:, (*15)
$hv = new HVClient($yourAppId, $_SESSION);
try {
$hv->connect($yourCertThumbPrint, $yourPrivateKey);
$personInfo = $hv->getPersonInfo();
}
catch (HVRawConnectorUserNotAuthenticatedException $e) {
print '<a href="' .
$hv->getAuthenticationURL($yourReturnURL) .
">Authenticate</a>';
}
For more examples have a look at the demo_app source code included in
HVClientLibPHP., (*16)
The HVClientLibPHP will never provide an API to register a new HealthVault™ app
or to guide you through the on-boarding process, because this could be easily
done using the
Application Configuration Center., (*17)
So register your app there first and start coding afterwards., (*18)
The demo_app (aka Hello World) is already registered. For your first tests you
can also use it's credentials to start right away., (*19)
Demo
The demo_app included in this repository currently demonstrates two features:
* It queries a user's HealthVault record for all
"Things" and dumps the
raw XML content.
* It lists all files uploaded to your selected health record and lets you upload
additional files., (*20)
By default it uses the US pre production instance of HealthVault., (*21)
To get started, follow the install instructions above and put the demo_app folder
on a web server and access "demo_app/index.php"., (*22)
Changes And Additions
- Several things types have been added to the library, such as emotional state, sleep session, sleep related activity, and health journal entry.
- Helper methods have been created to export health vault thing types as JSON and to facilitate creation of various thing types.
- The HV Connect function has been updated to support both online and offline connection modes.
- The Get Things function has been updated to support putting of pictures and files
- Unit tests have been created to test all of this functionality and some of the functionality of the original library.
Licence
GPLv2., (*23)
Wallogit.com
