Akinox-fhir-sdk NPM

Akinox FHIR SDK

The Akinox FHIR SDK contains all necessary and common components to deal with FHIR. The SDK has been created to be used along the Chrono Innovation TypeScript template OR the Akinox Connector template.

Current supported FHIR versions:

FHIR R4 (root)
FHIR R5 (in the r5 package)

Content

DTOs

The SDK contains all relevant DTOs with class-validator and class-transformer annotations.

Usage:

Can be used in the controllers (with routing-controllers) to have default validations;
Can be used to create custom validators in the system;
Can be used to generate OpenAPI contract (with routing-controllers-openapi);

Mappers

The SDK contains all common mapper and mapping functions. The Bundle, BundleEntry, OperationOutcome and Reference mappers will always have the exact same signature, therefore they were moved to the SDK to avoid duplication of code.

All common formatter such as the PhoneNumberMapper should also be moved to the SDK so that every project can use it.

Models

The SDK contains all common models that is relevant to any project using FHIR.

Validators

The SDK contains basic validators for all request parameter (models/parameter) and bodies (models/requests).

Tests

Every class exposing logic has Unit Tests and Mocks. The tests were added to make sure the SDK stays stable and doesn't break any further implementation.