Skip to content

rockphotog/nlk-test

Repository files navigation

DETTE ER EN TEST AV PROOF OF CONCEPT FOR STORE KODEVERK MED MANGE DETALJER - IKKE FOR BRUK OG IMPLEMENTASJON

Norsk Laboratoriekodeverk (NLK) - FHIR Implementation Guide

Validate FSH FilesBuild and Deploy FHIR IG to GitHub Pages

This repository contains a FHIR Implementation Guide for publishing an experimental version of the Norsk Laboratoriekodeverk (NLK) - the Norwegian Laboratory Codebook.

Purpose

The main purpose of this implementation guide is to publish an experimental FHIR CodeSystem for the Norsk Laboratoriekodeverk (NLK), making this comprehensive Norwegian laboratory terminology available in a standardized FHIR format.

What You'll Find Here

🧬 CodeSystem: Norsk Laboratoriekodeverk

  • Complete terminology: 11,391 laboratory codes covering all aspects of Norwegian laboratory medicine
  • Current active codes: 9,679 actively used codes
  • Version: 7280.77 (derived from the source Excel file)
  • Coverage: Six major medical domains:
    • Medisinsk biokjemi (Medical Biochemistry) - 2,881 codes
    • Immunologi og transfusjonsmedisin (Immunology and Transfusion Medicine) - 3,231 codes
    • Medisinsk mikrobiologi (Medical Microbiology) - 2,547 codes
    • Klinisk farmakologi (Clinical Pharmacology) - 2,642 codes
    • Medisinsk genetikk (Medical Genetics) - 67 codes
    • Patologi (Pathology) - 27 codes

📋 CodeSystem Features

  • FHIR R4 Compliant: Full compliance with FHIR CodeSystem specifications
  • Unique Codes: 11,391 deduplicated laboratory codes (4 duplicates removed from source)
  • Active Status Tracking: 9,679 currently active codes vs. 1,712 historical codes
  • Norwegian Terminology: Complete coverage of Norwegian laboratory medicine
  • Standardized Format: Clean FSH syntax for reliable compilation
  • Version Controlled: Traceable to source Excel version 7280.77

🔧 Technical Implementation

  • Source: Generated from Norsk Laboratoriekodeverk 7280.77.xlsx
  • Format: FHIR Shorthand (FSH) - R4 compliant syntax
  • Build tool: SUSHI + HL7 FHIR IG Publisher
  • FHIR Version: 4.0.1
  • Dependencies: hl7.fhir.no.basis 2.2.0
  • Validation: FSH syntax errors resolved, duplicates removed
  • Quality: Clean, validated codebase ready for compilation

📋 Available Versions

  • Published IG: Basic CodeSystem included in the published Implementation Guide
  • Detailed CodeSystem ⭐: Complete version with full metadata properties available at NLK-CodeSystem-Detailed.json (11MB)
    • Contains all 19,476+ concepts with comprehensive metadata
    • Includes detailed properties: validFrom/validTo dates, component names, system specifications, units, domains, groupings
    • Generated from the detailed FSH file but not included in published IG due to size
    • Ready for direct import into FHIR terminology servers

Repository Structure

📁 nlk-test/                    # Main IG directory
├── 📄 ig.ini                   # IG Publisher configuration
├── 📄 sushi-config.yaml        # SUSHI configuration
└── 📁 input/                   # IG input files
    ├── 📁 fsh/                  # FSH source files
    │   ├── � codesystems/     # CodeSystem definitions
    │   │   └── �📄 nlk-test.codesystem.fsh  # Main NLK CodeSystem (11.4k lines)
    │   ├── 📁 profiles/        # Profile definitions
    │   └── � aliases.fsh      # Common aliases
    ├── 📁 images/              # Documentation images
    └── 📁 pagecontent/         # Narrative content

📁 resources/                   # Source data
└── 📄 Norsk Laboratoriekodeverk 7280.77.xlsx  # Original Excel source

📁 documentation/               # Project documentation
└── Various .md files with setup and usage instructions

Getting Started

Prerequisites

  • Node.js and npm
  • SUSHI (FHIR Shorthand compiler)
  • HL7 FHIR IG Publisher

Building the Implementation Guide

  1. Install dependencies:

    npm install -g fsh-sushi
  2. Compile FSH to FHIR:

    cd nlk-test
    sushi .
  3. Build the Implementation Guide:

    _genonce.sh  # or equivalent for your platform

Usage

Once built, the Implementation Guide will provide:

  • Browsable CodeSystem: All NLK codes with search and filter capabilities
  • FHIR API endpoints: For programmatic access to the terminology
  • Documentation: Comprehensive guide for implementers
  • Examples: Sample usage in FHIR resources

Status

🚧 Experimental - This is an experimental implementation for evaluation and testing purposes.

Contributing

This project serves as a template for Norwegian FHIR Implementation Guides. See the documentation folder for detailed instructions on:

  • Using this repository as a template
  • Configuration and customization
  • Automated workflows and deployment

License

See LICENSE file for details.

Contact

Publisher: Espen
Jurisdiction: Norway (NO)


Source Data: Generated from Norsk Laboratoriekodeverk 7280.77.xlsx on 2025-09-24
Last Updated: Fixed FSH validation issues and removed duplicate codes

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •