Move public docs under docs folder
Browse filesAdds schema, release notes, and release manifest under docs/.
- docs/release_manifest.md +47 -0
- docs/release_notes.md +51 -0
- docs/schema.md +73 -0
docs/release_manifest.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Hugging Face Release Manifest
|
| 2 |
+
|
| 3 |
+
This package is staged for upload to a Hugging Face dataset repository.
|
| 4 |
+
|
| 5 |
+
## Public Files
|
| 6 |
+
|
| 7 |
+
```text
|
| 8 |
+
huggingface_release/
|
| 9 |
+
+-- README.md
|
| 10 |
+
+-- data/
|
| 11 |
+
| +-- synthetic_bh_cases_v1_mdp_180.json
|
| 12 |
+
+-- docs/
|
| 13 |
+
| +-- schema.md
|
| 14 |
+
| +-- release_notes.md
|
| 15 |
+
| +-- release_manifest.md
|
| 16 |
+
| +-- huggingface_upload.md
|
| 17 |
+
```
|
| 18 |
+
|
| 19 |
+
## Source Data
|
| 20 |
+
|
| 21 |
+
The public data file is copied from:
|
| 22 |
+
|
| 23 |
+
```text
|
| 24 |
+
clin_auth_bench/data/release/synthetic_bh_cases_v1_mdp_180.json
|
| 25 |
+
```
|
| 26 |
+
|
| 27 |
+
## Exclusion Policy
|
| 28 |
+
|
| 29 |
+
The package must not include:
|
| 30 |
+
|
| 31 |
+
- `clin_auth_bench/data/review_batches/`
|
| 32 |
+
- `clin_auth_bench/data/archive/`
|
| 33 |
+
- `clin_auth_bench/data/pilot/`
|
| 34 |
+
- local audit result JSON files
|
| 35 |
+
- `__pycache__/`
|
| 36 |
+
- `.DS_Store`
|
| 37 |
+
- generated QA output directories
|
| 38 |
+
|
| 39 |
+
## Release Framing
|
| 40 |
+
|
| 41 |
+
Use the phrase "synthetic inpatient health authorization benchmark."
|
| 42 |
+
|
| 43 |
+
V1 should be described as focusing on adult inpatient psychiatric authorization.
|
| 44 |
+
|
| 45 |
+
Avoid implying that the benchmark is derived from real patient data, a real EHR, a real facility, a payer policy, or a provider workflow.
|
| 46 |
+
|
| 47 |
+
All chart dates should be described as synthetic timeline artifacts that do not correspond to real patient encounters or real facility operations.
|
docs/release_notes.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ClinAuthBench V1 Release Notes
|
| 2 |
+
|
| 3 |
+
ClinAuthBench v1 is a synthetic inpatient health authorization benchmark. V1 focuses on adult inpatient psychiatric authorization over dense 72-hour chart packets.
|
| 4 |
+
|
| 5 |
+
## Included
|
| 6 |
+
|
| 7 |
+
- `README.md`: Hugging Face dataset card.
|
| 8 |
+
- `data/synthetic_bh_cases_v1_mdp_180.json`: 180-case public release file.
|
| 9 |
+
- `docs/schema.md`: public schema summary.
|
| 10 |
+
- `docs/release_notes.md`: this release note.
|
| 11 |
+
- `docs/release_manifest.md`: packaging manifest and exclusions.
|
| 12 |
+
- `docs/huggingface_upload.md`: upload and loading notes.
|
| 13 |
+
|
| 14 |
+
## Not Included
|
| 15 |
+
|
| 16 |
+
The Hugging Face release package intentionally excludes:
|
| 17 |
+
|
| 18 |
+
- review batch files
|
| 19 |
+
- archived pilot files
|
| 20 |
+
- earlier pilot files
|
| 21 |
+
- local audit result JSON files
|
| 22 |
+
- `__pycache__`
|
| 23 |
+
- `.DS_Store`
|
| 24 |
+
- generated QA output directories
|
| 25 |
+
|
| 26 |
+
## Dataset Composition
|
| 27 |
+
|
| 28 |
+
- Total cases: 180.
|
| 29 |
+
- Continued-stay cases: 108.
|
| 30 |
+
- Safe/LLOC-ready cases: 72.
|
| 31 |
+
- Contradiction/conflicting-documentation cases: 22.
|
| 32 |
+
- Rule-based MDP cases: 120.
|
| 33 |
+
- Probabilistic MDP cases: 60.
|
| 34 |
+
- Probabilistic MDP trace range: cases 121-180.
|
| 35 |
+
|
| 36 |
+
## QA Summary
|
| 37 |
+
|
| 38 |
+
- Deterministic QA passed: PASS=180, REVIEW=0, FAIL=0.
|
| 39 |
+
- Claude PHI audit sampled 30 full-content cases: PASS=30, FAIL=0.
|
| 40 |
+
|
| 41 |
+
## Scope
|
| 42 |
+
|
| 43 |
+
V1 is evaluation-scale and should be used for benchmark evaluation, error analysis, prompt testing, and small calibration studies. It is not training-from-scratch scale.
|
| 44 |
+
|
| 45 |
+
The dataset uses generalized synthetic authorization criteria and does not represent any payer, provider, facility, EHR, contract, or proprietary utilization-management rule set.
|
| 46 |
+
|
| 47 |
+
All chart dates are synthetic timeline artifacts and do not correspond to real patient encounters or real facility operations.
|
| 48 |
+
|
| 49 |
+
## License
|
| 50 |
+
|
| 51 |
+
ClinAuthBench v1 is released under the Creative Commons Attribution 4.0 International license (`CC BY 4.0`).
|
docs/schema.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ClinAuthBench Schema
|
| 2 |
+
|
| 3 |
+
This document summarizes the public v1 schema for the Hugging Face release package.
|
| 4 |
+
|
| 5 |
+
## Top-Level Record
|
| 6 |
+
|
| 7 |
+
```text
|
| 8 |
+
{
|
| 9 |
+
"id": string,
|
| 10 |
+
"title": string,
|
| 11 |
+
"metadata": object,
|
| 12 |
+
"content": string
|
| 13 |
+
}
|
| 14 |
+
```
|
| 15 |
+
|
| 16 |
+
## Top-Level Fields
|
| 17 |
+
|
| 18 |
+
- `id`: stable synthetic case identifier, such as `clin_auth_bench_v1_0001`.
|
| 19 |
+
- `title`: short case title.
|
| 20 |
+
- `content`: model-facing synthetic chart packet containing repeated 72-hour inpatient documentation forms.
|
| 21 |
+
- `metadata`: structured benchmark metadata, generation metadata, quality checks, and gold labels.
|
| 22 |
+
|
| 23 |
+
## Metadata Fields
|
| 24 |
+
|
| 25 |
+
- `benchmark`: benchmark name.
|
| 26 |
+
- `version`: dataset version.
|
| 27 |
+
- `synthetic`: boolean synthetic-data marker.
|
| 28 |
+
- `privacy_design`: short privacy-design description.
|
| 29 |
+
- `level_of_care`: v1 level-of-care scope.
|
| 30 |
+
- `documentation_window_hours`: documentation window size.
|
| 31 |
+
- `diagnosis_category`: synthetic diagnosis family.
|
| 32 |
+
- `trajectory`: synthetic trajectory descriptor.
|
| 33 |
+
- `documentation_challenge`: primary documentation challenge.
|
| 34 |
+
- `documentation_challenge_tags`: more specific challenge tags.
|
| 35 |
+
- `mdp_model`: `rule_based_v1` or `probabilistic_v1`.
|
| 36 |
+
- `mdp_trajectory`: synthetic transition trajectory metadata.
|
| 37 |
+
- `gold`: structured labels for evaluation.
|
| 38 |
+
- `quality_checks`: deterministic generation quality checks.
|
| 39 |
+
- `content_gold_checks`: deterministic content/gold consistency checks.
|
| 40 |
+
|
| 41 |
+
## Gold Fields
|
| 42 |
+
|
| 43 |
+
- `current_suicide_risk`: text label for current risk reasoning.
|
| 44 |
+
- `historical_suicide_risk`: text label for historical risk reasoning.
|
| 45 |
+
- `primary_diagnosis`: synthetic primary diagnosis.
|
| 46 |
+
- `psychosis_present`: boolean.
|
| 47 |
+
- `substance_use`: list of synthetic substance-use categories.
|
| 48 |
+
- `safe_for_lloc`: boolean lower-level-of-care readiness label.
|
| 49 |
+
- `expected_los_recommendation`: expected length-of-stay recommendation label.
|
| 50 |
+
- `lower_level_of_care_barriers`: list of unresolved barriers.
|
| 51 |
+
- `documentation_challenge`: primary challenge category.
|
| 52 |
+
- `documentation_challenge_tags`: challenge tags.
|
| 53 |
+
- `key_evidence_forms`: forms expected to contain important evidence.
|
| 54 |
+
- `evidence_anchors`: structured hints linking gold fields to supporting forms.
|
| 55 |
+
- `do_not_claim`: explicit unsupported claims the model should avoid.
|
| 56 |
+
- `form_count`: number of rendered forms in the chart packet.
|
| 57 |
+
|
| 58 |
+
## Documentation Challenge Values
|
| 59 |
+
|
| 60 |
+
- `current_vs_historical_risk`
|
| 61 |
+
- `contradiction`
|
| 62 |
+
- `lower_level_of_care_barrier_reasoning`
|
| 63 |
+
- `missing_invalid_or_stale_evidence`
|
| 64 |
+
|
| 65 |
+
## MDP Trajectory
|
| 66 |
+
|
| 67 |
+
Cases 1-120 use `rule_based_v1`. Cases 121-180 use `probabilistic_v1`.
|
| 68 |
+
|
| 69 |
+
Rule-based trajectory entries include the day, action, and resulting synthetic patient state.
|
| 70 |
+
|
| 71 |
+
Probabilistic trajectory entries include transition metadata such as transition options, conditioned probability mass, sample roll, selected outcome, selected probability, and resulting synthetic state.
|
| 72 |
+
|
| 73 |
+
The MDP trajectory is synthetic generation metadata. It is not an observed clinical trajectory and should not be treated as real patient-course data.
|