Antsa JS Client Library
The Antsa 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 @antsa/core
Basic Usage
Create a new AntsaClient
:
import { AntsaClient } from '@antsa/core';
const antsa = new AntsaClient();
Create a AntsaClient
with additional configuration options:
import { AntsaClient } from '@antsa/core';
const antsa = new AntsaClient({
baseUrl: 'https://www.example.com/fhir/R4/',
clientId: 'MY_CLIENT_ID',
});
Authenticate with client credenials
const antsa = new AntsaClient();
await antsa.startClientLogin(MY_CLIENT_ID, MY_CLIENT_SECRET);
Authenticating with Antsa
If you are using Antsa 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 Antsa App
- Enable Email/Password
After that, you can use the startLogin()
method:
const loginResult = await antsa.startLogin({ email, password, remember });
const profile = await antsa.processCode(loginResult.code);
console.log(profile);
Authenticating with OAuth
Authenticate with a FHIR server via OAuth2 redirect:
antsa.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 antsa.search('Patient', 'given=eve');
bundle.entry.forEach((entry) => console.log(entry.resource));
Create
createResource<T extends Resource>(resource: T): Promise<T>
Example:
antsa.createResource({
resourceType: 'Observation',
subject: {
reference: 'Patient/123',
},
valueQuantity: {
// ...
},
// ...
});
Read a resource
readResource<T extends Resource>(resourceType: string, id: string): Promise<T>
Example:
const patient = await antsa.readResource('Patient', '123');
Read resource history
readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>
Example:
const historyBundle = await antsa.readHistory('Patient', '123');
Read resource version
readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>
Example:
const version = await antsa.readVersion('Patient', '123', '456');
Update a resource
updateResource<T extends Resource>(resource: T): Promise<T>
Example:
const result = await antsa.updateResource({
resourceType: 'Patient',
id: '123',
name: [
{
family: 'Smith',
given: ['John'],
},
],
});
console.log(result.meta.versionId);
Delete a resource
deleteResource(resourceType: string, id: string): Promise<any>
Example:
await antsa.deleteResource('Patient', '123');
Patch a resource
patchResource<T extends Resource>(resourceType: string, id: string, operations: Operation[]): Promise<T>
Example:
const result = await antsa.patchResource('Patient', '123', [
{ op: 'replace', path: '/name/0/family', value: 'Smith' },
]);
console.log(result.meta.versionId);
GraphQL
graphql(query: string, options?: RequestInit): Promise<any>
Example:
const result = await graphql(`
{
PatientList(name: "Alice") {
name {
given
family
}
}
}
`);
About Antsa
Antsa is a healthcare platform that helps you quickly develop high-quality compliant applications. Antsa includes a FHIR server, React component library, and developer app.
License
Apache 2.0. Copyright © Antsa 2023