@iehr/core NPM

iEHR JS Client Library

The iEHR JS Client Library is a pure TypeScript library for calling a FHIR server from the browser.

Key Features

FHIR validation and operations
FHIR client to create, read, update, delete, patch, and search
WebSockets for realtime communication
Evaluation of FhirPath
No external dependencies

Installation

Add as a dependency:

npm install @iehr/core

Basic Usage

Create a new IEHRClient:

import { IEHRClient } from '@iehr/core';

const iehr = new IEHRClient();

Create a IEHRClient with additional configuration options:

import { IEHRClient } from '@iehr/core';

const iehr = new IEHRClient({
  baseUrl: 'https://www.example.com/fhir/R4/',
  clientId: 'MY_CLIENT_ID',
});

Authenticate with client credentials

const iehr = new IEHRClient();
await iehr.startClientLogin(MY_CLIENT_ID, MY_CLIENT_SECRET);

Authenticating with iEHR

If you are using iEHR as your FHIR server, you can use a direct sign-in API to authenticate email and password.

Before you begin

Create a project in the iEHR App
Enable Email/Password

After that, you can use the startLogin() method:

const loginResult = await iehr.startLogin({ email, password, remember });
const profile = await iehr.processCode(loginResult.code);
console.log(profile);

Authenticating with OAuth

Authenticate with a FHIR server via OAuth2 redirect:

iehr.signInWithRedirect().then((user) => console.log(user));

Search

Search for any resource using a FHIR search string:

search<K extends ResourceType>(
  resourceType: K,
  query?: URLSearchParams | string,
  options: RequestInit = {}
): ReadablePromise<Bundle<ExtractResource<K>>>

Example:

const bundle = await iehr.search('Patient', 'given=eve');
bundle.entry.forEach((entry) => console.log(entry.resource));

Create

Create resource:

createResource<T extends Resource>(resource: T): Promise<T>

Example:

iehr.createResource({
  resourceType: 'Observation',
  subject: {
    reference: 'Patient/123',
  },
  valueQuantity: {
    // ...
  },
  // ...
});

Read a resource

Read a resource by ID:

readResource<T extends Resource>(resourceType: string, id: string): Promise<T>

Example:

const patient = await iehr.readResource('Patient', '123');

Read resource history

Read resource history:

readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>

Example:

const historyBundle = await iehr.readHistory('Patient', '123');

Read resource version

Read a specific version:

readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>

Example:

const version = await iehr.readVersion('Patient', '123', '456');

Update a resource

Update a resource:

updateResource<T extends Resource>(resource: T): Promise<T>

Example:

const result = await iehr.updateResource({
  resourceType: 'Patient',
  id: '123',
  name: [
    {
      family: 'Smith',
      given: ['John'],
    },
  ],
});
console.log(result.meta.versionId);

Delete a resource

Delete a resource:

deleteResource(resourceType: string, id: string): Promise<any>

Example:

await iehr.deleteResource('Patient', '123');

Patch a resource

Patch a resource:

patchResource<T extends Resource>(resourceType: string, id: string, operations: Operation[]): Promise<T>

Example:

const result = await iehr.patchResource('Patient', '123', [
  { op: 'replace', path: '/name/0/family', value: 'Smith' },
]);
console.log(result.meta.versionId);

GraphQL

Execute a GraphQL query:

graphql(query: string, options?: RequestInit): Promise<any>

Example:

const result = await graphql(`
  {
    PatientList(name: "Alice") {
      name {
        given
        family
      }
    }
  }
`);

About iEHR

iEHR is a healthcare platform that helps you quickly develop high-quality compliant applications. iEHR includes a FHIR server, React component library, and developer app.