FHIR Models is an open source library of FHIR Resources for Node.js. Currently, the library supports r4 version 4.0.1.
NOTE: For R3, please install version FHIR Kit Models version: 0.1.2
Please view our roadmap to get a better understanding of what future features are planned.
Assuming you are using yarn as your package
manager, install with:
$ yarn add fhir-kit-models
Then include only the FHIR resources you need and instantiate with valid FHIR JSON.
const { Patient } = require('fhir-kit-models');
const patientJSON = {}; // or valid FHIR payload;
const patient = new Patient(patientJSON);
// List non-null property keys and key-value pairs for the patient instance
const keys = patient.keys();
const entries = patient.entries();
// Return a specific property value
const patientGender = patient.gender;
const patientLastNames = patient.name.map(name => name.family)
const patientAddress = patient.address[0];
const patientHomePhone = patient.telecom.find(contact => contact.use === 'home');
// Iterate over the patient instance
for (let [attr, value] of patient) {console.log(attr)}
// Return the FHIR object as a POJO
for patientObject = patient.toObject();Most likely, if you are working with FHIR data you are interfacing with a FHIR server. Visit our sister project fhir-kit-client.
We welcome and encourage contributions to this open source project. We use GitHub issues to track bug fixes and improvements. We encourage the community to join discussion, seek clarifications and create pull requests for new features. Before you start, make sure you take a look at our project roadmap and our Code of Conduct.
To interact with a sample patient run the following:
$ yarn install && yarn demo
Command c will jump to your breakpoint and repl will read and evaluate code
within the current execution context.
If you are using yarn as your package manager:
yarn install
Build javascript classes of FHIR Resources from FHIR resource schemas in dist
directory:
yarn build
To run both testing and linting:
yarn lint && yarn test
To run tests with the debugging utility add the debugger statement to set a
breakpoint and run tests with the debug option:
yarn test debug
Command c will jump to your breakpoint and repl will read and evaluate code
within the current execution context. Read more about the available commands in
the node debugger api
and the
REPL api.
Our goal is to encourage a safe environment for all contributors through promoting an open environment free from harassment. In that goal we expect participants to adhere to a Code of Conduct.
This project has been published under the MIT LICENSE.