hospitalrun/hospitalrun-core

All elements shared between Frontend and Backend, including CouchDB design-documents and schemas.

HospitalRun Core

This repository will host all elements shared between Frontend and Backend, including CouchDB design-documents and schemas.

CouchDB design and example documents

The repository also hosts design documents and examples from version 1.0.0-beta, to be used as a reference for development purpose.

src/design-documents
└── v1
    ├── appointments_by_date.ts
    ├── appointments_by_patient.ts
    ├── auth.ts
    ├── closed_incidents_by_user.ts
    ├── custom_form_by_type.ts
    ├── imaging_by_status.ts
    ├── incident_by_date.ts
    ├── incident_by_friendly_id.ts
    ├── inventory_by_friendly_id.ts
    ├── inventory_by_name.ts
    ├── inventory_by_type.ts
    ├── inventory_purchase_by_date_received.ts
    ├── inventory_purchase_by_expiration_date.ts
    ├── inventory_request_by_item.ts
    ├── inventory_request_by_status.ts
    ├── invoice_by_patient.ts
    ├── invoice_by_status.ts
    ├── lab_by_status.ts
    ├── medication_by_status.ts
    ├── open_incidents_by_user.ts
    ├── patient_by_admission.ts
    ├── patient_by_display_id.ts
    ├── patient_by_status.ts
    ├── photo_by_patient.ts
    ├── photo_by_procedure.ts
    ├── photo_by_visit.ts
    ├── pricing_by_category.ts
    ├── procedure_by_date.ts
    ├── report_by_visit.ts
    ├── sequence_by_prefix.ts
    ├── surgical_appointments_by_date.ts
    ├── visit_by_date.ts
    ├── visit_by_discharge_date.ts
    └── visit_by_patient.ts

src/examples-documents
└── v1
    ├── appointments_by_date.json
    ├── appointments_by_patient.json
    ├── closed_incidents_by_user.json
    ├── custom_form_by_type.json
    ├── imaging_by_status.json
    ├── incident_by_date.json
    ├── incident_by_friendly_id.json
    ├── inventory_by_friendly_id.json
    ├── inventory_by_name.json
    ├── inventory_by_type.json
    ├── inventory_by_type2.json
    ├── inventory_purchase_by_date_received.json
    ├── inventory_purchase_by_expiration_date.json
    ├── inventory_request_by_item.json
    ├── inventory_request_by_status.json
    ├── invoice_by_patient.json
    ├── invoice_by_status.json
    ├── invoice_by_status2.json
    ├── lab_by_status.json
    ├── medication_by_status.json
    ├── open_incidents_by_user.json
    ├── patient_by_admission.json
    ├── patient_by_display_id.json
    ├── patient_by_status.json
    ├── photo_by_patient.json
    ├── photo_by_procedure.json
    ├── photo_by_visit.json
    ├── pricing_by_category.json
    ├── procedure_by_date.json
    ├── report_by_visit.json
    ├── sequence_by_prefix.json
    ├── surgical_appointments_by_date.json
    ├── visit_by_date.json
    ├── visit_by_discharge_date.json
    └── visit_by_patient.json

License

Released under the MIT license.

hospitalrun-core's Issues

Add TypeScript interfaces to this repository

We need to share interfaces between FE and BE. This is the right place to put them. We can transform model JSONs in folders and put interface.ts alongside schemas.

https://github.com/HospitalRun/hospitalrun-core/tree/master/src/model

OpenAPI/Swagger

🚀 Feature Proposal

OpenAPI/Swagger

Motivation

Work hard at being lazy ~ Mike Feher

Single Source of truth. SOLID interface between all projects

Backlog:

• Generate Core Models (finalize OpenAPI->TS Model Interface)
• Generate Core Services (Configure Services CodeGen Template)

Related Issues:

HospitalRun/hospitalrun#12
HospitalRun/hospitalrun#15

Migrate type generation to json-schema

🚀 Feature Proposal

HospitalRun core types should be generated from a json schema. This issue is to migrate all known types to json-schema using @hospitalrun/frontend as reference.

Add same project structure as the one in server

🚀 Feature Proposal

We need to use the same project structure that we are using on server repository.

https://github.com/HospitalRun/hospitalrun-server

Motivation

Helps hopping between repositories.

Add husky precommit commands

Add semantic release

Add prettier and eslint

🚀 Feature Proposal

Add prettier and eslint to core repo. We need to have same rules across all projects.

Add TypeScript interfaces

🚀 Feature Proposal

We need TS interfaces, alongside JSONSchemas, for better developer experience. The interfaces will be derived directly from Schemas.

Motivation

Please outline the motivation for the proposal.

TODO:

• rename model to models
• add one folder per model
• add a proper TS interface for every model
• export default the interface
• export JSONSchema as schema

Add entities schemas to documentation

🚀 Feature Proposal

• extract all of the schema of the old entities

Add TAP test runner

🚀 Feature Proposal

We need to test all TS interfaces. Add TAP, that is already used by the server package, to this repository. Reference: https://node-tap.org/

• add TAP as devDependency
• add all needed scripts to package.json
• add working pre-commit hook
• make a trivial test as example

Remove gitmoji to improve CI pipeline

💥 Regression Report

Restore the semantic-release without the assistance of Gitmoji.
Repository to use as a reference: https://github.com/tehKapa/testone

New devDependencies will be:

• @commitlint/cli
• @commitlint/config-conventional
• @commitlint/prompt
• @semantic-release/changelog
• @semantic-release/commit-analyzer
• @semantic-release/git
• @semantic-release/github
• @semantic-release/release-notes-generator
• commitizen
• commitlint-config-cz
• cz-conventional-changelog
• husky
• semantic-release

Other configurations in package.json file

 "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }

Only necessary script in package.json

"semantic-release": "semantic-release"

Other configuration files:

commitlint.config.js

module.exports = { extends: ["@commitlint/config-conventional"] };

.releaserc

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/changelog",
    "@semantic-release/npm",
    ["@semantic-release/git", {
      "assets": ["package.json", "CHANGELOG.md"],
      "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
    }],
    "@semantic-release/github"
  ]
}