Skip to content

Commit 79e29ad

Browse files
sheydinsheydin
committed
Polish public README
1 parent a65b4c2 commit 79e29ad

2 files changed

Lines changed: 98 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
# Records for Claude Code
1010

11+
[![Plugin CI](https://github.com/medvertical/claude-records/actions/workflows/plugin-ci.yml/badge.svg)](https://github.com/medvertical/claude-records/actions/workflows/plugin-ci.yml)
12+
![Version](https://img.shields.io/badge/version-0.3.0-blue)
13+
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
14+
1115
FHIR validation and data-quality workflow skills for Claude Code.
1216

1317
Records helps FHIR developers, IG authors, and AI agents validate FHIR JSON, explain validation issues, add CI checks, and run validate-patch-revalidate workflows without sending patient data to an external service by default.
@@ -27,6 +31,17 @@ Invoke the FHIR validation skill:
2731
/records:fhir-validation validate ./examples
2832
```
2933

34+
## Quickstart
35+
36+
After installation, try the bundled non-PHI fixtures:
37+
38+
```text
39+
/records:doctor plugins/records/fixtures/mini-ig
40+
/records:explain-outcome plugins/records/fixtures/operationoutcome-required.json
41+
```
42+
43+
The first command detects a mini SUSHI/FSH IG project. The second explains a sample `OperationOutcome` without claiming that a new validation run happened.
44+
3045
## Skills
3146

3247
### `/records:fhir-validation`
@@ -54,6 +69,17 @@ The plugin includes focused commands that route into the `fhir-validation` workf
5469

5570
It also includes the read-only `fhir-validation-reviewer` agent for diagnosis without edits.
5671

72+
## Feature Matrix
73+
74+
| Feature | What it does |
75+
| --- | --- |
76+
| Project detection | Detects FHIR resources, SUSHI/FSH, IG Publisher files, CI workflows, runtimes, and privacy warnings. |
77+
| OperationOutcome explanation | Maps issue codes such as `required`, `code-invalid`, `profile-unknown`, and `slicing` to fixability and setup guidance. |
78+
| FSH source mapping | Traces `fsh-generated/resources/*.json` issues back to likely `input/fsh` declarations. |
79+
| CI generation | Drafts Records validation GitHub Actions workflows for local or API-backed validation. |
80+
| Privacy redaction | Summarizes Patient-like resources, Bundles, identifiers, and references without printing full PHI. |
81+
| Quality rules | Derives reviewable project data-quality rules from local evidence. |
82+
5783
## What It Does
5884

5985
The FHIR validation skill guides Claude through five validation paths:
@@ -74,6 +100,13 @@ This repository is plugin/skill-only. It contains the Claude Code marketplace en
74100

75101
The Records Engine, CLI, API, and MCP server live in the Records main repository. This plugin can use those runtimes when they are already installed or configured, but this repository does not contain their implementation.
76102

103+
## Requirements
104+
105+
- Claude Code is required to install and run the plugin.
106+
- Node.js is required for local helper scripts and repository tests.
107+
- Records CLI, Records MCP, Records API, SUSHI, IG Publisher, Firely Terminal, Java validator, and HAPI are optional. The plugin detects and uses them only when available or explicitly configured.
108+
- Full profile, terminology, invariant, and reference validation requires a configured profile-aware runtime and the relevant FHIR/IG packages.
109+
77110
## Why Records
78111

79112
- **Local-first** Node/TypeScript workflow, with no JVM required for local structural checks.
@@ -90,6 +123,22 @@ See [PRIVACY.md](./PRIVACY.md) for the data-handling policy.
90123

91124
See [plugins/records/docs/compatibility.md](./plugins/records/docs/compatibility.md) for how Records CLI/API/MCP, SUSHI, IG Publisher, Firely Terminal, HAPI, and fallback validation are detected and bounded.
92125

126+
## Troubleshooting
127+
128+
- Installed plugin but commands are missing: restart Claude Code and check `/plugin`.
129+
- `records` not found: the Records CLI is optional; the skill will use another configured runtime or structural fallback.
130+
- `claude` not found during `npm run release:check`: only the live plugin update check is skipped.
131+
- Generated JSON has validation errors: edit `input/fsh` when FSH sources exist, then rebuild with SUSHI.
132+
- Full profile validation is not running: confirm the validator has access to the required profiles, packages, terminology, and FHIR version.
133+
134+
## Registry
135+
136+
Canonical installation is via `medvertical/claude-records`. The ClaudeRegistry submission is for discovery and review.
137+
138+
## Release Notes
139+
140+
See [plugins/records/eval-results/v0.3.0.md](./plugins/records/eval-results/v0.3.0.md) for the current release checks and scope.
141+
93142
## Development
94143

95144
Run plugin checks from this `claude-records` repository:

‎plugins/records/README.md‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88

99
# Records for Claude Code
1010

11+
[![Plugin CI](https://github.com/medvertical/claude-records/actions/workflows/plugin-ci.yml/badge.svg)](https://github.com/medvertical/claude-records/actions/workflows/plugin-ci.yml)
12+
![Version](https://img.shields.io/badge/version-0.3.0-blue)
13+
[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](./LICENSE)
14+
1115
FHIR validation and data-quality workflow skills for Claude Code.
1216

1317
Records helps FHIR developers, IG authors, and AI agents validate FHIR JSON, explain validation issues, add CI checks, and run validate-patch-revalidate workflows without sending patient data to an external service by default.
@@ -27,6 +31,17 @@ Invoke the FHIR validation skill:
2731
/records:fhir-validation validate ./examples
2832
```
2933

34+
## Quickstart
35+
36+
After installation, try the bundled non-PHI fixtures:
37+
38+
```text
39+
/records:doctor fixtures/mini-ig
40+
/records:explain-outcome fixtures/operationoutcome-required.json
41+
```
42+
43+
The first command detects a mini SUSHI/FSH IG project. The second explains a sample `OperationOutcome` without claiming that a new validation run happened.
44+
3045
## Skills
3146

3247
### `/records:fhir-validation`
@@ -54,6 +69,17 @@ The plugin includes focused commands that route into the `fhir-validation` workf
5469

5570
It also includes the read-only `fhir-validation-reviewer` agent for diagnosis without edits.
5671

72+
## Feature Matrix
73+
74+
| Feature | What it does |
75+
| --- | --- |
76+
| Project detection | Detects FHIR resources, SUSHI/FSH, IG Publisher files, CI workflows, runtimes, and privacy warnings. |
77+
| OperationOutcome explanation | Maps issue codes such as `required`, `code-invalid`, `profile-unknown`, and `slicing` to fixability and setup guidance. |
78+
| FSH source mapping | Traces `fsh-generated/resources/*.json` issues back to likely `input/fsh` declarations. |
79+
| CI generation | Drafts Records validation GitHub Actions workflows for local or API-backed validation. |
80+
| Privacy redaction | Summarizes Patient-like resources, Bundles, identifiers, and references without printing full PHI. |
81+
| Quality rules | Derives reviewable project data-quality rules from local evidence. |
82+
5783
## What It Does
5884

5985
The FHIR validation skill guides Claude through five validation paths:
@@ -74,6 +100,13 @@ This repository is plugin/skill-only. It contains the Claude Code marketplace en
74100

75101
The Records Engine, CLI, API, and MCP server live in the Records main repository. This plugin can use those runtimes when they are already installed or configured, but this repository does not contain their implementation.
76102

103+
## Requirements
104+
105+
- Claude Code is required to install and run the plugin.
106+
- Node.js is required for local helper scripts and repository tests.
107+
- Records CLI, Records MCP, Records API, SUSHI, IG Publisher, Firely Terminal, Java validator, and HAPI are optional. The plugin detects and uses them only when available or explicitly configured.
108+
- Full profile, terminology, invariant, and reference validation requires a configured profile-aware runtime and the relevant FHIR/IG packages.
109+
77110
## Why Records
78111

79112
- **Local-first** Node/TypeScript workflow, with no JVM required for local structural checks.
@@ -90,6 +123,22 @@ See [PRIVACY.md](./PRIVACY.md) for the data-handling policy.
90123

91124
See [docs/compatibility.md](./docs/compatibility.md) for how Records CLI/API/MCP, SUSHI, IG Publisher, Firely Terminal, HAPI, and fallback validation are detected and bounded.
92125

126+
## Troubleshooting
127+
128+
- Installed plugin but commands are missing: restart Claude Code and check `/plugin`.
129+
- `records` not found: the Records CLI is optional; the skill will use another configured runtime or structural fallback.
130+
- `claude` not found during `npm run release:check`: only the live plugin update check is skipped.
131+
- Generated JSON has validation errors: edit `input/fsh` when FSH sources exist, then rebuild with SUSHI.
132+
- Full profile validation is not running: confirm the validator has access to the required profiles, packages, terminology, and FHIR version.
133+
134+
## Registry
135+
136+
Canonical installation is via `medvertical/claude-records`. The ClaudeRegistry submission is for discovery and review.
137+
138+
## Release Notes
139+
140+
See [eval-results/v0.3.0.md](./eval-results/v0.3.0.md) for the current release checks and scope.
141+
93142
## Development
94143

95144
Run plugin checks from this `claude-records` repository root:

0 commit comments

Comments
 (0)