/medplum

Medplum is a healthcare platform that helps you quickly develop high-quality compliant applications.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Medplum

Medplum is a comprehensive developer platform dedicated to simplifying and enhancing healthcare application development. With a strong focus on security, compliance, and interoperability, Medplum offers a range of interconnected components and tools designed to streamline the creation of healthcare applications and systems.

Below are the key components of the Medplum ecosystem, each playing a vital role in achieving our vision of accessible and efficient healthcare application development:

  • Medplum Auth - End-to-end identity solution for easy user authentication, sign-in, and permissions using OAuth, OpenID, and SMART-on-FHIR.
  • Medplum Clinical Data Repository (CDR) - Backend server that hosts your healthcare data in a secure, compliant, and standards-based repository.
  • Medplum API - FHIR-based API for sending, receiving, and manipulating data.
  • Medplum SDK - Client libraries that simplify the process of interacting with the Medplum API.
  • Medplum App - Web application where you can view your data and perform basic editing tasks. You can also use the Medplum App to manage basic workflows.
  • Medplum Bots - Write and run application logic server-side without needing to set up your own server.
  • UI Component Library - React components designed to help you quickly develop custom healthcare applications.

Docs

Contributing

We heartily welcome any and all contributions that match our engineering standards!

That being said, this codebase isn't your typical open-source project because it's not a library or package with a limited scope -- it's our entire product. Our Contributing documentation has all the information you need to get started.

Ground Rules

Contributions and discussion guidelines

By making a contribution to this project, you are deemed to have accepted the Developer Certificate of Origin (DCO).

All conversations and communities on Medplum are expected to follow GitHub's Community Guidelines and Acceptable Use Policies. We expect discussions on issues and pull requests to stay positive, productive, and respectful. Remember: there are real people on the other side of the screen!

Reporting a bug or proposing a new feature

If you found a technical bug on Medplum or have ideas for features we should implement, the issue tracker is the best place to share with us. (click here to open a new issue)

Writing documentation or blog content

Did you learn how to do something using Medplum that wasn't obvious on your first try? By contributing your new knowledge to our documentation, you can help others who might have a similar use case!

Our documentation is hosted on medplum.com/docs, but it is built from Markdown files in our docs package.

For relatively small changes, you can edit files directly from your web browser on Github.dev without needing to clone the repository.

Fixing a bug or implementing a new feature

If you find a bug and open a Pull Request that fixes it, we'll review it as soon as possible to ensure it meets our engineering standards.

If you want to implement a new feature, open an issue first to discuss with us how the feature might work, and to ensure it fits into our roadmap and plans for the app.

If you want to contribute but are unsure how to start, we have a "good first issue" label which is applied to newcomer-friendly issues. Take a look at the full list of good first issues and pick something you like!

Ready to get started writing code? Follow the local setup instructions and jump in!

Codebase

Technologies

Let's discuss the key technologies that power this monorepo, providing a foundation for our healthcare application development:

  • Full-stack TypeScript: Our codebase is primarily built using TypeScript, enabling type-safe development across both the server and frontend components. Node.js is used for server-side code, while React powers the frontend applications.

Here is a list of the major technologies in use:

  • PostgreSQL: Our choice for data storage, ensuring a robust and reliable foundation for healthcare data.
  • Redis: Used for background jobs and caching, enhancing the performance and responsiveness of our applications.
  • Express: Serving as our API server, Express simplifies routing and handling requests, facilitating efficient data exchange.
  • TypeScript: A type-safe extension of JavaScript, TypeScript enhances code quality and maintainability, crucial for healthcare application development.
  • React: As the driving force behind our frontend applications, React offers a versatile and component-based approach to creating intuitive user interfaces.

Folder structure

medplum/
├── packages
│   ├── agent        # On-premise agent
│   ├── app          # Frontend web app
│   ├── bot-layer    # AWS Lambda Layer for Bots
│   ├── cdk          # AWS CDK infra as code
│   ├── cli          # Command line interface
│   ├── core         # Core shared library
│   ├── definitions  # Data definitions
│   ├── docs         # Documentation
│   ├── examples     # Example code used in documentation
│   ├── fhir-router  # FHIR URL router
│   ├── fhirtypes    # FHIR TypeScript definitions
│   ├── generator    # Code generator utilities
│   ├── graphiql     # Preconfigured GraphiQL
│   ├── hl7          # HL7 client and server
│   ├── mock         # Mock FHIR data for testing
│   ├── react        # React component library
│   └── server       # Backend API server
└── scripts          # Helper bash scripts

License

Apache 2.0

Copyright © Medplum 2023

FHIR® is a registered trademark of HL7.

SNOMED® is a registered trademark of the International Health Terminology Standards Development Organisation.

LOINC® is a registered trademark of Regenstrief Institute, Inc.

DICOM® is the registered trademark of the National Electrical Manufacturers Association (NEMA).