Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Base Implementation #1

Merged
merged 33 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from 32 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
5fc76d1
init ihs class
mustofa-id Dec 21, 2023
f750ccf
add feature check list
mustofa-id Jan 5, 2024
30cf35f
tidy up
mustofa-id Jan 7, 2024
520b022
init kyc api
mustofa-id Jan 7, 2024
8140d9a
update env mode check
mustofa-id Jan 7, 2024
8203e68
define module index and test
mustofa-id Jan 7, 2024
4140956
init consent api
mustofa-id Jan 7, 2024
e1689fd
tidy up specs
mustofa-id Jan 7, 2024
a09c570
export IHS class directly
mustofa-id Jan 7, 2024
b863be5
fix IHS class import
mustofa-id Jan 7, 2024
db38af0
kyc encryption
mustofa-id Jan 7, 2024
221cdf6
separate key publickey file each mode
mustofa-id Jan 8, 2024
0c34d25
update kyc encryption
mustofa-id Jan 8, 2024
46c3d1b
config docs
mustofa-id Jan 8, 2024
c15fa82
update kyc
mustofa-id Jan 8, 2024
c4ee45c
using env var for test sample
mustofa-id Jan 8, 2024
a831e3d
finalize kyc implementation
mustofa-id Jan 9, 2024
e443b2b
fix ihs spec fail
mustofa-id Jan 9, 2024
5880f02
kyc verification code spec
mustofa-id Jan 9, 2024
31e3d61
handle auth token expiration
mustofa-id Jan 9, 2024
cb1cc2d
rename `defineConfig` to `applyUserConfig`
mustofa-id Jan 9, 2024
81b9873
add auth manager class
mustofa-id Jan 9, 2024
bdaa75c
tidy up ihs spec
mustofa-id Jan 9, 2024
3fe5c05
init build script
mustofa-id Jan 9, 2024
44cffdc
finalize consent api
mustofa-id Jan 9, 2024
cf33a8a
finalize ihs api
mustofa-id Jan 9, 2024
45a8df9
kyc docs
mustofa-id Jan 9, 2024
93bee42
update readme
mustofa-id Jan 9, 2024
da5dd30
bump deps
mustofa-id Jan 9, 2024
6beca7c
support async config
mustofa-id Jan 10, 2024
ab3e0f2
update docs
mustofa-id Jan 10, 2024
dd20e7d
setup and add changeset
mustofa-id Jan 10, 2024
0f7c054
add kyc public key link
mustofa-id Jan 10, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
5 changes: 5 additions & 0 deletions .changeset/brown-buses-cheat.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@ssecd/ihs": patch
---

Initial release
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
7 changes: 7 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
IHS_ORGANIZATION_ID=
IHS_CLIENT_SECRET=
IHS_SECRET_KEY=
IHS_KYC_PEM_FILE=

TEST_AGENT_NIK=
TEST_AGENT_NAME=
TEST_PATIENT_NIK=
TEST_PATEINT_NAME=
TEST_PATIENT_ID=
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ node_modules
.env
.env.*
!.env.example
*.pem
240 changes: 238 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,239 @@
# IHS
Indonesia Health Service API Helpers

Work in Progress Indonesia Health Service API Helpers
- ✅ FHIR API
- ✅ Patient Consent API
- ✅ KYC API
- ✅ Automatic authentication and token invalidation
- ✅ TypeSafe and Autocomplete-Enabled API

## Instalasi

Instalasi paket dapat dilakukan dengan perintah berikut:

```bash
npm install @ssecd/ihs
```

Untuk dukungan _type safe_ pada API FHIR, perlu menambahkan development dependensi `@types/fhir` dengan perintah:

```bash
npm install --save-dev @types/fhir
```

Instalasi juga dapat dilakukan menggunakan `PNPM` atau `YARN`

## Penggunaan

### Inisialisasi

Penggunaan paket ini sangatlah sederhana, cukup menginisialisasi global instansi pada sebuah modul atau file seperti berikut:

```ts
// file: ihs.ts atau ihs.js
import IHS from '@ssecd/ihs';

const ihs = new IHS();

export default ihs;
```

Secara default konfigurasi seperti **Client Secret** atau **Secret Key** akan dibaca melalui environment variable namun konfigurasi juga dapat diatur pada constructor class seperti berikut:

```ts
const ihs = new IHS({
clientSecret: '<client secret dari platform SatuSehat>',
kycPemFile: `/home/user/kyc-publickey.pem`
// dan seterusnya
});
```

Selain menggunakan objek, konfigurasi juga dapat diatur menggunakan fungsi, misalnya pada kasus membaca atau mendapatkan konfigurasi dari database:

```ts
const ihs = new IHS(async () => {
const config = await sql`select * from config`;
return {
clientSecret: config.clientSecret
// dan seterusnya ...
};
});
```

Perlu diperhatikan bahwa fungsi config pada constructor parameter tersebut hanya akan dipanggil satu kali. Bila terjadi perubahan konfigurasi harap memanggil fungsi `invalidateConfig()` pada instansi IHS untuk memperbaharui atau menerapkan perubahan konfigurasi.

```ts
await ihs.invalidateConfig();
```

Konfigurasi lengkapnya dapat dilihat di bagian [Konfigurasi](#konfigurasi).

### Autentikasi

Proses autentikasi dan re-autentikasi dilakukan secara otomatis pada saat melakukan request di masing-masing API. Autentikasi terjadi hanya ketika tidak terdapat token atau token sudah kedaluwarsa.

Meski demikian, autentikasi juga dapat dilakukan secara manual jika sewaktu-waktu memerlukan informasi dari response autentikasi melalui instansi `IHS` dengan memanggil method `auth()` dengan kembalian berupa type `AuthDetail` yang berisi informasi autentikasi termasuk nilai `access_token`, `expires_in`, `issued_at` dan lainnya sesuai dengan spesifikasi IHS.

```ts
import ihs from './path/to/ihs.js';

const detail: AuthDetail = await ihs.auth();
```

### Patient Consent API

Pada Patient Consent, terdapat dua buah method yang di-definisikan sesuai dengan spesifikasi IHS yakni method untuk mendapatkan informasi consent pasien:

```ts
const result = await ihs.consent.get('P02478375538');

if (result.resourceType === 'Consent') {
console.info(result); // Consent resource
} else {
console.error(result); // OperationOutcome resource
}
```

dan method untuk memperbarui informasi consent pasien:

```ts
const result = await ihs.consent.update({
patientId: 'P02478375538',
action: 'OPTIN',
agent: 'Nama Agen'
});

if (result.resourceType === 'Consent') {
console.info(result); // Consent resource
} else {
console.error(result); // OperationOutcome resource
}
```

Setiap method pada Patient Consent API ini memiliki nilai kembalian FHIR resource `Consent` jika request sukses dan `OperationOutcome` jika request gagal.

### FHIR API

Pada API ini, implementasi-nya sangat sederhana dan mengutamakan fleksibilitas yakni dengan hanya mengembalikan `Response` object sehingga response sepenuhnya di-_handle_ pengguna.

```ts
const response: Response = await ihs.fhir(`/Patient`, {
searchParams: [
['identifier', 'https://fhir.kemkes.go.id/id/nik|9271060312000001'],
['gender', 'male']
]
});

if (response.ok) {
const patientBundle = await response.json();
console.info(patientBundle); // Bundle<Patient>
}
```

### KYC API

Pada API ini, terdapat dua buah method yakni method untuk melakukan proses Generate URL Validasi di mana URL digunakan untuk melakukan verifikasi akun SatuSehat melalui SatuSehat Mobile:

```ts
const result = await ihs.kyc.generateValidationUrl({
name: 'Nama Agen',
nik: 'NIK Agen'
});

if ('error' in result.data) {
console.error(result.data.error); // Request error message
} else {
console.info(result.data);
/*
{
agent_name: string;
agent_nik: string;
token: string;
url: string;
}
*/
}
```

dan method untuk melakukan proses Generate Kode Verifikasi di mana nilai tersebut akan muncul di SatuSehat Mobile (SSM) dan digunakan oleh pasien untuk proses validasi:

```ts
const result = await ihs.kyc.generateVerificationCode({
nik: 'NIK Pasien',
name: 'Nama Pasien'
});

if ('error' in result.data) {
console.error(result.data.error); // Request error message
} else {
console.info(result.data);
/*
{
nik: string;
name: string;
ihs_number: string;
challenge_code: string;
created_timestamp: string;
expired_timestamp: string;
}
*/
}
```

Setiap method pada API ini memiliki parameter dan nilai kembalian yang di-definisikan sesuai dengan spesifikasi IHS pada Playbook.

Proses enkripsi dan dekripsi pesan dilakukan dengan menggunakan algoritma `aes-256-gcm` sedangkan untuk proses enkripsi dan dekripsi _symmetric key_ menggunakan metode RSA dengan `RSA_PKCS1_OAEP_PADDING` padding dan `sha256` hash. Semua proses tersebut sudah dilakukan secara internal sesuai dengan spesifikasi IHS pada Playbook.

Proses kriptografi pada API ini memerlukan file _server key_ atau _public key_ dengan format `.pem`. File _public key_ ini dapat disesuaikan lokasinya dengan mengatur `kycPemFile` pada config instance atau class `IHS` yang secara default bernama `publickey.dev.pem` pada mode `development` atau `publickey.pem` pada mode `production` dan berada di _working directory_ atau folder di mana API dijalankan.

## Konfigurasi

Konfigurasi mengikuti interface berikut:

```ts
interface IHSConfig {
/**
* Client secret dari Akses Kode API di Platform SatuSehat
*
* @default process.env.IHS_CLIENT_SECRET
*/
clientSecret: string;

/**
* Secret key dari Akses Kode API di Platform SatuSehat
*
* @default process.env.IHS_SECRET_KEY
*/
secretKey: string;

/**
* Mode environment API antara `development` ata `production`
*
* @default process.env.NODE_ENV || 'development'
*/
mode: Mode;

/**
* Path atau lokasi public key KYC dari SatuSehat. Dapat
* menggunakan absolute atau relative path. Secara default
* akan membaca nilai environment variable IHS_KYC_PEM_FILE
* atau `publickey.dev.pem` pada mode `development` dan
* `publickey.pem` pada mode `production`
*
* @default process.env.IHS_KYC_PEM_FILE
*/
kycPemFile: string;
}
```

## Kontribusi

Kontribusi sangat dipersilakan dan dapat dilakukan dengan berbagai cara seperti melaporkan masalah, membuat permintaan atau menambahkan fitur melalui PR, atau sekedar memperbaiki kesalahan ketikan.

## Lisensi

[MIT](./LICENSE)

## Lainnya

- [Pemecahan Masalah](https://github.com/ssecd/ihs/issues?q=is%3Aissue)
- [Laporkan Bug](https://github.com/ssecd/ihs/issues/new)
28 changes: 18 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@
"type": "module",
"scripts": {
"test": "vitest",
"build": "tsc",
"build": "rollup -c",
"lint": "prettier --check . && eslint .",
"format": "prettier --write .",
"release": "changeset publish"
"release": "changeset publish",
"prepublishOnly": "dts-buddy"
},
"keywords": [
"ihs",
Expand All @@ -33,26 +34,33 @@
"url": "https://github.com/mustofa-id"
},
"license": "MIT",
"module": "./dist/ihs.js",
"types": "./dist/ihs.d.ts",
"files": [
"src",
"dist"
],
"module": "./dist/index.js",
"types": "./dist/index.d.ts",
"exports": {
"types": "./dist/index.d.ts",
"import": "./dist/index.js"
".": {
"types": "./dist/ihs.d.ts",
"import": "./src/ihs.js"
}
},
"devDependencies": {
"@changesets/cli": "^2.27.1",
"@types/node": "^20.10.5",
"@typescript-eslint/eslint-plugin": "^6.15.0",
"@typescript-eslint/parser": "^6.15.0",
"@rollup/plugin-typescript": "^11.1.5",
"@types/node": "^20.10.8",
"@typescript-eslint/eslint-plugin": "^6.18.1",
"@typescript-eslint/parser": "^6.18.1",
"dotenv": "^16.3.1",
"dts-buddy": "^0.4.3",
"eslint": "^8.56.0",
"eslint-config-prettier": "^9.1.0",
"prettier": "^3.1.1",
"rollup": "^4.9.4",
"tslib": "^2.6.2",
"typescript": "^5.3.3",
"vitest": "^1.1.0"
"vitest": "^1.1.3"
},
"peerDependencies": {
"@types/fhir": "^0.0.40"
Expand Down
Loading