Add spec-enriched model reference docs for Care 3.0 & 3.1#1
Merged
Conversation
Generate technical reference documentation for all ~50 Care EMR models, organized into 10 domains (foundation, clinical, medications, supply, scheduling, billing, facility, forms, access, platform). Each doc cross-references both layers of the backend: - the Django model (storage) in care/emr/models, and - the Pydantic resource specs in care/emr/resources — enums, the structured shape of JSON fields, Create/Update/List/Retrieve API schemas, validation, and server-maintained behaviour. - References sidebar switched to autogenerated via per-domain _category_.json (positioned, with generated-index landing pages) - version-3.0 and version-3.1 kept byte-identical - Validated with `npm run build` (onBrokenLinks: throw) — passes clean, no broken links or anchors Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…se templates questionnaire.py defines six models; split the three distinct resources that have their own Pydantic specs into dedicated reference docs: - forms/questionnaire-response — QuestionnaireResponse + FormSubmission (submit payload, status enums, structured responses, read/write specs) - forms/questionnaire-response-template — QuestionnaireResponseTemplate (TemplateData shape: pre-filled questionnaire answers, medication requests, activity definitions; create/update/read/retrieve specs) Cross-linked from the questionnaire doc; valueset repositioned to 4. Mirrored to 3.0 & 3.1; `npm run build` passes clean. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generate technical reference documentation for all ~50 Care EMR models, organized into 10 domains (foundation, clinical, medications, supply, scheduling, billing, facility, forms, access, platform).
Each doc cross-references both layers of the backend:
the Django model (storage) in care/emr/models, and
the Pydantic resource specs in care/emr/resources — enums, the structured shape of JSON fields, Create/Update/List/Retrieve API schemas, validation, and server-maintained behaviour.
References sidebar switched to autogenerated via per-domain category.json (positioned, with generated-index landing pages)
version-3.0 and version-3.1 kept byte-identical
Validated with
npm run build(onBrokenLinks: throw) — passes clean, no broken links or anchors