https://github.com/minvws/gfmodules-national-referral-index

Repo gfmodules-national-referral-index for minvws
https://github.com/minvws/gfmodules-national-referral-index

Last synced: about 1 month ago
JSON representation

Repo gfmodules-national-referral-index for minvws

• Host: GitHub
• URL: https://github.com/minvws/gfmodules-national-referral-index
• Owner: minvws
• License: eupl-1.2
• Created: 2024-10-07T08:39:18.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-10-24T09:06:14.000Z (2 months ago)
• Last Synced: 2024-10-25T09:08:59.499Z (2 months ago)
• Language: Python
• Homepage: https://irealisatie.nl
• Size: 418 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# GFModules National Referral Index (NRI) or Nationale Verwijs Index (NVI)

The National Referral Index (NRI) is responsible for the referral of the Health Data. The NRI contains a referral

to the register that associates a Health Provider with pseudonym and data domain.

## Usage

The application is a FastAPI application, so you can use the FastAPI documentation to see how to use the application.

## Getting started

You can either run the application natively or in a docker container. If you want to run the application natively you

can take a look at the initialisation steps in `docker/init.sh`.

The preferred way to run the application is through docker.

Before you start this docker compose project, make sure you have the gfmodules-coordination docker compose

project running. For more information about setting up the whole project stack, read the gfmodules development

[readme](https://github.com/minvws/gfmodules-coordination?tab=readme-ov-file#development)

If you run Linux, make sure you export your user ID and group ID to synchronize permissions with the Docker user.

```bash

export NEW_UID=$(id -u)

export NEW_GID=$(id -g)

```

After this you can simply run `docker compose up`.

The application will be available at `https://localhost:8501` when the startup is completed.

## Interface Definitions

See [interface definitions](docs/interface-definitions/README.md)

## Models

```mermaid

---

title: Localization Register

---

classDiagram

    class ReferralEntry {

        + String pseudonym

        + UUID ura_number

        + String domain_name

    }

```

## Contribution

When starting to introduce changes, it is important to leave user specific files such as IDE or text-editor settings

outside the repository. For this, create an local `.gitignore` file and configure git like below.

```bash

git config --global core.excludesfile ~/.gitignore

```