Skip to content

installation.md

Latest commit

 

History

History
72 lines (56 loc) · 2.28 KB

installation.md

File metadata and controls

72 lines (56 loc) · 2.28 KB
Raw
description Install PHP FHIR Tools as standalone components or via the Symfony bundle.
icon download

Installation

{% hint style="info" %} Requirements: PHP 8.3 or newer and Composer. Packages that integrate with Symfony require Symfony ^6.4 | ^7.4. Code generation additionally needs the zip extension. {% endhint %}

Standalone components

Install only the packages you need. Each is published independently and shares the Ardenexal\FHIRTools\Component\… namespace.

{% tabs %} {% tab title="Serialization" %}

composer require ardenexal/fhir-serialization

ardenexal/fhir-serialization already depends on ardenexal/fhir-models (the pre-generated R4 / R4B / R5 model classes) and ardenexal/fhir-metadata, so they are pulled in automatically. {% endtab %}

{% tab title="Validation" %}

composer require ardenexal/fhir-validation

Provides the Symfony Validator constraints and FHIRValidationService. It depends on ardenexal/fhir-models and ardenexal/fhir-path. {% endtab %}

{% tab title="FHIRPath" %}

composer require ardenexal/fhir-path

Provides the FHIRPath 2.0 engine (FHIRPathService). Depends only on ardenexal/fhir-metadata, not on the model classes. {% endtab %}

{% tab title="Code Generation" %}

composer require ardenexal/fhir-code-generation

Generates model classes from FHIR packages. Needs the zip extension and pulls in nette/php-generator for code emission. {% endtab %} {% endtabs %}

Symfony application

composer require ardenexal/fhir-bundle

The bundle pulls in the code-generation, serialization, validation, FHIRPath, and metadata components and registers all of their services automatically. With Symfony Flex it also registers the bundle, copies the config/packages/fhir.yaml configuration, seeds .env variables (FHIR_OUTPUT_DIRECTORY, FHIR_CACHE_DIRECTORY, FHIR_DEFAULT_VERSION, FHIR_VALIDATION_ENABLED, FHIR_VALIDATION_STRICT_MODE), and updates .gitignore.

{% hint style="info" %} Without Symfony Flex, register the bundle manually in config/bundles.php and copy the configuration files yourself. See Installation & Configuration and the Flex Recipe for the full manual steps. {% endhint %}