https://github.com/yuhexiong/hospital-register-api-typescript
https://github.com/yuhexiong/hospital-register-api-typescript
api backend error-handling express mariadb nodejs restful-api typescript
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/yuhexiong/hospital-register-api-typescript
- Owner: yuhexiong
- Created: 2023-11-16T12:58:06.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-29T12:48:45.000Z (over 1 year ago)
- Last Synced: 2025-09-01T22:42:48.988Z (10 months ago)
- Topics: api, backend, error-handling, express, mariadb, nodejs, restful-api, typescript
- Language: TypeScript
- Homepage:
- Size: 244 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hospital Register Api
## Overview
- Language: TypeScript
- Web FrameWork: Express
- DataBase: MariaDB v10.9
## ENV
copy .env.example and rename as .env
```bash
DB_HOST=
DB_PORT=
DB_USER=
DB_PASS=
DB_NAME=
# port
PORT=
# swagger
SWAGGER_MOUNT_PATH=/api
```
## Run
### install dependencies
```bash
npm install
```
### run migration file
```bash
npm run migration:run
```
### run
```bash
npm run start
```
## ER Diagram
## API
### patient
- `POST /patient`：新增一位病人
- `GET /patient/name/{name}`：由姓名取得符合的病人, 支援正規表達式搜尋
- `GET /patient/{id}`：由id取得一位病人
- `GET /patients`：取得所有病人
- `PUT /patient/{id}`：修改一位病人
- `DELETE /patient/{id}`：刪除一位病人
### doctor
- `POST /doctor`：新增一位醫師
- `GET /doctor/{id}`：由id取得一位醫師
- `GET /doctors`：取得所有醫師
- `PATCH /doctor/{id}/{name}`：修改一位醫師名字
### reservation
- `POST /reservation/list`：新增一張預約班表, 預設可預約, 總看診號50, 不足的給號類別依是否可預約給預設
- `POST /reservation`：預約門診, 依給號類別和預約來源決定是否預約成功
- `GET /reservation/{year}/{month}`：取得指定月分所有預約班表
- `PATCH /reservation/{reservationDetailId}/{type}`：修改預約給號類別
### clinic
- `POST /clinic/register`：掛號
- `GET /clinic/{id}`：由id取得門診
- `POST /clinic/start/{id}`：開始看診或重新看診
- `PATCH /clinic/{id}`：更新主訴與觀察
- `POST /clinic/finish/{id}`：完診, 未開始看診則不能完診
- `POST /clinic/paid/{id}`：批價繳費, 未完診則不能完診
- `POST /clinic/unregister/{id}`：退掛, 已批價則不能退掛
- `GET /clinic/patient/{patientId}`：取得指定病人指定區間所有門診, 並顯示是否有欠款
## Custom Error Code
```
SUCCESSFUL = 0
INSUFFICIENT_DATA = '000107'
INVALID_PARAMETER = '000108'
COLUMN_MISMATCH = '000109'
INVALID_TYPE_RESERVATION = '000120'
INVALID_STATUS_CLINIC = '000121'
```