Tools for consuming data from a FHIR server with PHP
Tools for creating PHP classes from the HL7 FHIR Specification
If you're looking to use the classes generated by this library, you may want the php-fhir-generated repo instead.
If you wish to use this package as a standalone generator:
composer install
from root of project directory./bin/generate.sh
./input
and
classes will be generated under ./output
./bin/generate.sh --help
for details on how to utilize this scriptThis script will download configured major versions of FHIR into the input
folder and
generate classes for every version in the output
folder.
If you wish to use the generator as part of a project, you can include it as a composer dependency:
composer require dcarbone/php-fhir
From there, you can reference the Example block for a quick example on how to configure and execute the generator.
PHPFHIR Version | PHP Versions | FHIR Versions |
---|---|---|
v2 | 5.4-7.4 | DSTU1, DSTU2, STU3, R4 (<v4.3.0) |
v3 | 7.4-8.1 | DSTU1, DSTU2, STU3, R4 |
The first step is to determine the version of the FHIR spec your implementation supports. Once done, download the appropriate class definition XSDs from http://hl7.org/fhir/directory.html.
Uncompress the XSD's and place them in a directory that is readable by PHP's runtime user.
Next comes the fun:
The class generator utility included with this library is designed to parse the XSD's provided by the FHIR group into PHP classes, complete with markup and type hinting.
There are 2 important things to note with this section:
require __DIR__.'/vendor/autoload.php';
$schemaPath = 'schema/path';
// first, build new configuration class
$config = new \DCarbone\PHPFHIR\Config([
// The path to look look for and optionally download source XSD files to
'schemaPath' => __DIR__ . '/../input',
// The path to place generated type class files
'classesPath' => __DIR__ . '/../output',
// If true, will use a noop null logger
'silent' => false,
// If true, will skip generation of test classes
'skipTests' => false,
// Map of versions and configurations to generate
// Each entry in this map will grab the latest revision of that particular version. If you wish to use a specific
// version, please see http://www.hl7.org/fhir/directory.cfml
'versions' => [
'DSTU1' => [
// Source URL
'url' => 'http://hl7.org/fhir/DSTU1/fhir-all-xsd.zip',
// Namespace to prefix the generated classes with
'namespace' => '\\HL7\\FHIR\\DSTU1',
],
'DSTU2' => [
'url' => 'http://hl7.org/fhir/DSTU2/fhir-all-xsd.zip',
'namespace' => '\\HL7\\FHIR\\DSTU2',
],
'STU3' => [
'url' => 'http://hl7.org/fhir/STU3/definitions.xml.zip',
'namespace' => '\\HL7\\FHIR\\STU3',
],
'R4' => [
'url' => 'http://www.hl7.org/fhir/fhir-codegen-xsd.zip',
'namespace' => '\\HL7\\FHIR\\R4',
],
'Build' => [
'url' => 'http://build.fhir.org/fhir-all-xsd.zip',
'namespace' => '\\HL7\\FHIR\\Build',
],
],
]);
// next, build definition class
$version_config = new \DCarbone\PHPFHIR\Config\VersionConfig($config, $config->getVersion('R4'));
$definition = new \DCarbone\PHPFHIR\Definition($version_config);
$definition->buildDefinition();
$builder = new \DCarbone\PHPFHIR\Builder($config, $definition);
$builder->build();
Using the above code will generate class files under the included output directory, under the namespace
HL7\\FHIR\\{version}
If you wish the files to be placed under a different directory, pass the path in as the 2nd argument in the generator constructor.
If you wish the classes to have a different base namespace, pass the desired NS name in as the 3rd argument in the generator constructor.
There are a plethora of good HTTP clients you can use to get data out of a FHIR server, so I leave that up to you.
As part of the class generation above, a response parsing class called PHPFHIRResponseParser
will be created
and added into the root namespace directory. It currently supports JSON and XML response types.
The parser class takes a single optional boolean argument that will determine if it should attempt to load up the generated Autoloader class. By default it will do so, but you are free to configure your own autoloader and not use the generated one if you wish.
require 'path to PHPFHIRResponseParserConfig.php';
require 'path to PHPFHIRResponseParser.php';
// build config
$config = new \YourConfiguredNamespace\PHPFHIRResponseParserConfig([
'registerAutoloader' => true, // use if you are not using Composer
'sxeArgs' => LIBXML_COMPACT | LIBXML_NSCLEAN // choose different libxml arguments if you want, ymmv.
]);
// build parser
$parser = new \YourConfiguredNamespace\PHPFHIRResponseParser($config);
// provide input, receive output.
$object = $parser->parse($yourResponseData);
$json = json_encode($object);
// To get an instance of \DOMElement...
$element = $object->xmlSerialize();
// to get as XML string...
$xml = $element->ownerDocument->saveXML($element);
XML Serialization utilizes DOM.
As part of class generation, a directory & namespace called PHPFHIRTests
is created under the root namespace and
output directory.
If you have some suggestions for how this lib could be made more useful, more applicable, easier to use, etc, please let me know.