SGHI FHIR🔥 Profile Implementation Guide

SGHI FHIR Profile Implementation Guide repository. This project is part of the Lifesciences team and aims to provide a robust framework for implementing FHIR profiles tailored to support healthcare data interoperability, specifically aligned with the needs of Savannah Informatics.

Overview

The SGHI FHIR Profile Implementation Guide provides a comprehensive set of tools, resources, and documentation to aid developers, implementers, and healthcare organizations in adopting and utilizing FHIR standards. It includes customized FHIR profiles, value sets, and implementation details to streamline healthcare data exchange and improve interoperability.

Key Features

• Custom FHIR Profiles: Tailored to SGHI use cases and requirements.
• Implementation Guidance: Detailed instructions for adoption.
• Validation Tools: Resources to validate compliance with SGHI FHIR profiles.
• Example Resources: Sample FHIR resources for quick reference and testing.

Table of Contents

1. Getting Started
2. Project Structure
3. Installation
4. Usage
5. Contributors
6. License
7. Contact

Getting Started

To get started with the SGHI FHIR Profile Implementation Guide:

1. Clone the repository:

   [email protected]:savannahghi/sil_fhir_profile_ig.git

2. Navigate to the project directory:

   cd sil_fhir_profile_ig

3. Follow the Installation instructions to set up the project.

Project Structure

.
├── LICENSE
├── README.md
└── SGHIFHIRProfileIG
    ├── fsh-generated
    ├── _gencontinuous.bat
    ├── _gencontinuous.sh
    ├── _genonce.bat
    ├── _genonce.sh
    ├── ig.ini
    ├── input
    ├── input-cache
    ├── output
    ├── sushi-config.yaml
    ├── temp
    ├── template
    ├── _updatePublisher.bat
    └── _updatePublisher.sh

Installation

This project requires the following dependencies:

• SUSHI (FHIR Shorthand): For authoring and compiling FHIR profiles.
• FHIR Validator CLI
• Node.js (for validation tools)
• Java 11 or later

Steps

1. Install Node.js from https://nodejs.org/.
2. Install SUSHI globally by running:

   npm install -g fsh-sushi

Usage

Compiling FHIR Profiles

Use SUSHI to compile the FSH definitions into FHIR artifacts:

1. Download the latest version of the HL7 FHIR IG Publisher tool

./_updatePublisher.sh                  

2. Build the FHIR artifacts by running:

sushi build .

3. Generate the FHIR IG(s)

./_genonce.sh                     

This will generate output in the following directory:

./fsh-generated

as well as the necessary FHIR artifacts in the output directory.

Contributing

This project is invite only. Anyone wishes to contribute please see Contact

Please ensure all code adheres to the project's coding standards and includes necessary documentation.

License

This project is licensed under the MIT License. You are free to use, modify, and distribute this project in accordance with the license terms.

Maintainers

• Kimutai Kelvin
• Kathurima Kimathi
• Nairoua Salaton
• Kennedy Omondi
• Oscar Otieno
• Gichui Victor

Contact Information

[Email Address] ([email protected])

Thank you for contributing to the SGHI FHIR Profile Implementation Guide!