https://github.com/navapbc/piqi-model
An Open Source Library of PIQI Models
https://github.com/navapbc/piqi-model
Last synced: about 2 months ago
JSON representation
An Open Source Library of PIQI Models
- Host: GitHub
- URL: https://github.com/navapbc/piqi-model
- Owner: navapbc
- License: apache-2.0
- Created: 2025-10-31T17:57:53.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-12-15T15:56:37.000Z (7 months ago)
- Last Synced: 2025-12-18T21:31:12.763Z (7 months ago)
- Language: Java
- Size: 82 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# piqi-model
The [Patient Information Quality Improvement (PIQI)](https://build.fhir.org/ig/HL7/piqi/index.html) Framework is an evolving standard that wants to serve as a vehicle for promoting trust in the quality and clinical relevance of the healthcare data that transits our systems.
This project exists in part to promote engagement and accelerate adoption and education by providing a quick and easy method for generating the domain model classes that represent the [PIQI data model](https://build.fhir.org/ig/HL7/piqi/piqi_framework.html#piqi-data-models).
While this project only builds a jar file library intended to be used with Java or Kotlin, the JSON schema could be utilized to build objects for any language that can generate code from a schema (C#, Python, etc.).
## Building It
This project uses [jsonschema2pojo](https://github.com/joelittlejohn/jsonschema2pojo) to generate Java classses from the JSON schema located in `src/main/resources/Patient.json`. The following command will create a jar file containing the generated class files and place it in the local Maven repository (located in `~/.m2`) where it can be used as a dependency for other projects.
```
./gradlew clean publishToMavenLocal
```
## Using It
The jar file may be included in a Gradle project as a dependency in this way in the `build.gradle.kts` file.:
```
...
dependencies {
implementation("com.navapbc.piqi:piqi-model:0.2.0")
...
```
For Maven in `pom.xml`:
```
...
com.navapbc.piqi
piqi-model
0.2.0
...
```
## Notes
* The schema was created as a best effort from the documentation on the HL7 site. It is an evolving standard so expect changes.
* *jsonschema2pojo* has many different flags that may be set. `build.gradle.kts` configures it to use mostly defaults. It may be necessary to modify the configuration to suit your needs.
* `SimpleAttribute` is the one class that was not able to be generated in a way that serialized properly according to the PIQI data model. An additional Gradle task was introduced in `build.gradle.kts` to substitute a hand-coded version that was better suited.