Skip to content

README.md

Latest commit

 

History

History
64 lines (43 loc) · 5.59 KB

README.md

File metadata and controls

64 lines (43 loc) · 5.59 KB

NHSDigital-FHIR-Genomics-ImplementationGuide FHIR Assets Repository

This repository is maintained by Interoperability Team. Any queries contact us via interoperabilityteam@nhs.net.

Information

This repository contains FHIR Assets and examples for the NHS England Genomic Medicine Service

FHIR Project on Simplifier.net

Synchronization with Simplifier.net FHIR projects

FHIR asset repositories can be connected to a Simplifier.net project for easy visualization, documentation and publishing. For the current project, the main branch automatically synchronizes with this Simplifier.net FHIR project on every commit. Learn how to set up Simplifier.net GitHub synchronization.

Main Branch Status

FHIR Validation with Terminology Checks: NHSDigital IOPS Validation

Firely Quality Control Checks: Firely Validation)

Contributing

Any ammendments to this repo can be done via Pull Requests. To create a Pull Request, first fork this repo, make the changes as necessary and create a Pull Request with the base being this repository.

All PRs will be validated, and approved by the Interoperability team before merging.

  • Changes to ValueSets and CodeSystems and examples will be approved by a member of the Interoperability team.
  • Changes to any other asset will be taken to the Interoperability Standards team Design Authority meeting to be discussed before approving.

Signed Commits

The repo has signed commits enabled. This means that only commits that are verified can be merged into the main branch. More information about signed commits can be found here.

Branching Strategy (Gitflow)

We follow the Gitflow workflow. Please ensure your work is branched correctly:

  • main: The main integration branch for features. All PRs for new features should target this branch. No direct commits.

  • feature/: Used for new features. Branch off from main and merge back into main.

  • hotfix/: Used for urgent production fixes. Branch off from main and merge into main

  • parent subtree sync/: Action notify_programmes_repo.yml dispatches new changes to parent repo on push or pull request events but only for the main branch (To be implemented for the Genomics Programme).

Branch Naming Convention

  • feature/IOPS-[JIRA-ID]-short-description
  • hotfix/IOPS-[JIRA-ID]-short-description

Creating a New Package

Guidance for creating a new package is available on the central repo. The Genomics programme currently manages its own releases, but these will be integrated into the NHS England Programme release process in the future.

FHIR Validation

CapabilityStatement

The CapabilityStatement is used by the validation tool to check which profile to validate against. If no Profile is stated then the base FHIR resource will be used.

FHIR Validation with the IOPS Validator

This repo uses the customised HAPI FHIR Validation to ensure all assets and examples are valid FHIR, including any codes held within the ontoology server.

More information on FHIR validation can be found on the Interoperability Standards team Confluence page
More information on the FHIR validation service can be found within the Interoperability Standards team IOPS-Test-Scripts repository.

To set up the validation service within a fork add the following secrets:

  • ONTO_CLIENT_ID
  • ONTO_CLIENT_SECRET

FHIR Validation with the Firely Terminal GitHub Action

This repository also uses the Firely GitHub Action to validate your resources against the FHIR specification and custom validation rules with Firely Terminal. Any push or pull request to the main branch will automatically run the Firely Validation pipeline, containing bulk validation and custom business rule validation with Firely Terminal.