cqframework / cqframework/clinical-reasoning

4.0.0 Migration Guide

Open
#820 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Java
Stars
49
Forks
43
Avg merge
2d 19h
Merged PRs (30d)
13

Description

This page outlines the changes to this repository that are included with the v4 release.

Upstream, the #1462 pull request converted the CQL (cql-to-elm) Java project and its dependencies to Kotlin Multiplatform (KMP) targeting the JVM and JavaScript. This removed the two serialization modules (jaxb and jackson) in favor of a single, cross-platform module. Corresponding changes have made to this project (see below).

See the CQL migration guide, which may also apply to projects using Clinical Reasoning that have referenced the CQL artifacts directly.

Dependency management

  • Previously, you needed to add one of the cqf-fhir-(jackson|jaxb)modules as an extra dependency to your project. This is no longer required because the default multiplatform serialization functionality is now included. Any references to either cqf-fhir-jackson or cqf-fhir-jaxb should be removed.
  • See this PR for the internal changes to this project to update the CQL 4.0.0.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the issue text, the linked CQL v3-to-v4 migration guide, and clinical-reasoning PR #716. Confirm which v4 dependency changes apply here, especially removal of cqf-fhir-jackson and cqf-fhir-jaxb; done means the repository has accurate, usable migration guidance for those changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kotlin
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.