cdf2medmij-mapping-tool

Tool for transforming Cohort-study Data (CDF) into FHIR/MedMij compliant resource bundles

https://github.com/mydigitwinnl/cdf2medmij-mapping-tool

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.2%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Tool for transforming Cohort-study Data (CDF) into FHIR/MedMij compliant resource bundles

Basic Info
  • Host: GitHub
  • Owner: MyDigiTwinNL
  • License: apache-2.0
  • Language: TypeScript
  • Default Branch: main
  • Homepage:
  • Size: 2.26 MB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 0
  • Open Issues: 8
  • Releases: 0
Created over 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

FHIR Cohort Data Transformer

The FHIR Cohort Data Transformer is a TypeScript tool designed to transform cohort-study data into FHIR-compliant data. This tool allows you to specify and test the pairing rules between the cohort-study data and the properties of a given FHIR resource. Once you have defined these rules, you can link them to one or more FHIR-compliant templates.

Features

  • Transform cohort-study data into FHIR-compliant data
  • Allows the definition of pairing rules between cohort-study data and FHIR resource properties
  • Paring rules are specified in independent modules to make them testeable

Prerequisites

To use this tool, ensure you have the following installed:

  • Node.js (version 12 or higher)
  • npm (Node Package Manager)
  • TypeScript (installed globally)

Installation

  1. Clone the repository from GitHub:

bash git clone https://github.com/your-username/fhir-cohort-data-transformer.git

  1. Navigate to the project directory:

bash cd fhir-cohort-data-transformer

  1. Install the dependencies:

bash npm install

  1. Compile

bash tsc

Usage

  1. To create new pairing rules or JSON output-templates, refer to the developer manual.
  • To run the unit tests :

bash npm test

  • To run the linter :

bash npm run lint * To transform the available input samples (./fhirvalidation/sampleinputs), and check the validity of their corresponding transformations against a FHIR profile:

bash npm run validatesamples

  1. To preview a transformation of a given input
  1. Tp generate FHIR-compliant data based on the rules already defined, and the mapping configuration:

```bash

Transform a single file, print the ouput to STDOUT

npm run transform -- ./fhirvalidation/sampleinputs/input-p1234.json

Transform a single file, save the output on the given folder

npm run transform -- ./fhirvalidation/sampleinputs/input-p1234.json -o /tmp/out

Transform all the .json files in a given folder, save the output on the given folder

npm run transform -- ./fhirvalidation/sampleinputs -o /tmp/out ```

End-user and Developer documentation

The developer documentation with the description of the tool design, and further details for creating new templates/pairing rules can be found here (still under development).

Owner

  • Name: MyDigiTwinNL
  • Login: MyDigiTwinNL
  • Kind: organization

Citation (CITATION.cff)

cff-version: 1.2.0
title: CDF2FHIR
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Héctor
    family-names: Cadavid
    email: h.cadavid@esciencecenter.nl
    orcid: 'https://orcid.org/0000-0003-4965-4243'
url: "https://github.com/MyDigiTwinNL/CDF2Medmij-Mapping-tool"

GitHub Events

Total
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 1
Last Year
  • Watch event: 1
  • Issue comment event: 1
  • Push event: 1