FHIR Types

Overview

• Description: This repository contains reference FHIR templates in JSON format for resources of interest for the CODA project. The templates contain dummy data and are validated against the FHIR schema. The repository exports a FHIR terminology dictionary that can be accessed by uing fhir-types as a git submodule.
• Primary author(s): Jeffrey Li [@JeffreyLi16], Louis Mullie [@louism], Pascal St-Onge [@stongepa].
• Contributors: Julien Levesque [@JulienL3vesque], Rajeev Das [@rajeevdas2507], Rima Bouchakri [@Rima-B], Kip Brown.
• License: The code in this repository is released under the GNU General Public License, V3.

FHIR version

Types are currently validated against version 4.0 of the FHIR schema definition. Tests are run automatically every time the repository is modified.

Templates

• Patient
• Encounter
• Location - Bed
• Location - Ward
• Observation - Culture data
• Observation - Lab data
• Observation - PCR data
• Observation - Ventilation data
• Observation - Vital signs
• ImagingStudy
• Condition
• MedicationAdministration
• Procedure
• ServiceRequest

Requirements

• NodeJS version 16+
• Node package manager (NPM)

Install

To install, clone the repository and install the dependencies:

git clone https://github.com/coda-platform/fhir-types
cd fhir-types
npm install

Generate terminology dictionary

To generate the terminology dictionary and update the auto-generated index.js, execute:

npm run generate

An example of how to require the terminology dictionary, by requiring fhir-types as a git submodule, can be found in the dashboard app repository.

Tests

To execute tests manually, run:

npm run test