Add Allergy, Condition and medication record docs for 3.1 - #82
Conversation
Publish the Allergy Intolerance and Condition modules under Clinical, and the Medication Administration, Medication Dispense and Medication Statement modules under Medications, from the care_docs sources. Refreshes the five concepts and adds nineteen flows.
Deploying coredocs with
|
| Latest commit: |
4a9799f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://529b77f0.coredocs.pages.dev |
| Branch Preview URL: | https://docs-clinical-modules.coredocs.pages.dev |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Warning
Threat Detection Engine Failure — The analysis engine could not complete. This is a tooling failure, not a security finding.
What happened
The threat detection results could not be parsed.
Review the workflow run logs for details.
Generated by Docs Reviewer for #82 · opus50 · 192.1 AIC · ⊞ 11K
| ## FHIR R5 alignment | ||
|
|
||
| - Reference: [Allergy Intolerance (technical)](../../references/clinical/allergy-intolerance.mdx) | ||
| - Concept: [Patient](../clinical/patient) | ||
| - Concept: [Encounter](../clinical/encounter.mdx) | ||
| - Concept: [Condition](../clinical/condition.mdx) | ||
| - Concept: [Observation](../clinical/observation.mdx) | ||
| Care follows FHIR R5 for allergies. The substance, the category, the criticality, the verification status, the clinical status, the last occurrence, and the note map to the FHIR AllergyIntolerance resource. |
There was a problem hiding this comment.
Checklist item 7 (and the concept template) forbid narrating the FHIR mapping: "Link the FHIR page, but never narrate the mapping. Do not write 'as per FHIR' or 'this maps to the FHIR X resource'. The link is enough." The ## FHIR R5 alignment section is also not a template section — the concept template's sections are Definition, Key Attributes, optional conceptual sections, Permissions, Related. Please delete this whole section; the FHIR link already in the Definition covers it.
| ## FHIR R5 alignment | ||
|
|
||
| Roles are granted to users through facility, organization, or patient memberships, and they cascade down the organization tree — a role held high in the hierarchy applies to the facilities and patients beneath it. | ||
| Care follows FHIR R5 for conditions. The clinical term, the status, the verification, the severity, the category, the onset date, and the note map to the FHIR Condition resource. |
There was a problem hiding this comment.
Same FHIR narration problem as allergy-intolerance.mdx: checklist item 7 says the link is enough and "this maps to the FHIR X resource" must go. ## FHIR R5 alignment is also not one of the concept template's sections. Delete the section — the FHIR link in the Definition already carries the alignment.
| | Can Read Supply Delivery | View a Dispense Order. Facility Admin, Administrator, Admin, Staff, Doctor, Nurse, Volunteer, and Pharmacist hold this permission. | | ||
| | Can Create Supply Delivery on Facility | Create or change a Dispense Order. Only Facility Admin and Admin hold this permission. | |
There was a problem hiding this comment.
These two rows conflate a medication dispense with Supply Delivery permissions, and the role lists here ("Only Facility Admin and Admin") need tracing to the real SupplyDeliveryPermissions definitions in care/security/permissions/ before publishing. Per checklist item 16, please cite the source or drop the claim — I could not locate a medication_dispense.py permissions module to verify "Medication Dispense Read" / "Write Medication Dispense" display names either.
| → stopped | ||
| → not_done | ||
| ``` | ||
| ## Status |
There was a problem hiding this comment.
Template conformance (checklist item 8): in the concept template Status is a ### sub-section of Key Attributes, not a top-level ##. The same page keeps ### Changes after you save at H3, so this H2 also breaks the section order. Change to ### Status and move it under Key Attributes. medication-dispense.mdx and medication-statement.mdx have the same ## Status issue.
| ## Definition | ||
|
|
||
| ## What it represents | ||
| A **[medicine administration](https://build.fhir.org/medicationadministration.html)** in Care |
There was a problem hiding this comment.
Terminology (checklist item 14): the page H1 is "Medication Administration" but the body, the Related links and the flows call it "Medicine Administration" (see administer-dose.mdx line 92, and "Medicine Dispense" in dispense-medication.mdx line 91 against the "Medication Dispense" page title). Pick one term — the PR description says titles follow the existing page names, so use "medication administration" / "medication dispense" throughout.
|
|
||
| | Permission | Access | | ||
| | --- | --- | | ||
| | Write Medication Dispense | Lets you dispense a medicine or supply item. Held by Facility Admin, Admin, Staff, Doctor, Nurse, and Pharmacist. | |
There was a problem hiding this comment.
The flow template's Permissions table is Permission | Access — what the permission lets the reader do. Appending the role list ("Held by Facility Admin, Admin, Staff, Doctor, Nurse, and Pharmacist") duplicates the concept page and is unverified here. Suggest: | Write Medication Dispense | Lets you dispense a medicine or supply item. |
| Care follows FHIR R5 for allergies. The substance, the category, the criticality, the verification status, the clinical status, the last occurrence, and the note map to the FHIR AllergyIntolerance resource. | ||
|
|
||
| ## FHIR reference | ||
| ## Related |
There was a problem hiding this comment.
The Related section drops the reference link that the previous version carried, and the concept template lists a Reference: line. versioned_docs/version-3.1/references/clinical/allergy-intolerance.mdx exists — please re-add - Reference: [Allergy Intolerance](../../references/clinical/allergy-intolerance.mdx). The same link was dropped in condition.mdx, medication-administration.mdx, medication-dispense.mdx and medication-statement.mdx, and all four reference pages exist.
| --- | ||
|
|
||
| # Allergy & Intolerance | ||
| # Allergy Intolerance |
There was a problem hiding this comment.
Naming (checklist item 9): H1 is sentence case, so this should be # Allergy intolerance. The same applies to the new headings on the medication concept pages (# Medication Administration, etc.) where the diff touches them.
1 participant
What
Publishes five clinical modules from
care_docsinto the docs site (version 3.1). 19 flows and 5 refreshed concepts.Under
Flows > ClinicalUnder
Flows > MedicationsAll five concepts are replaced with the authored versions.
Module naming
The
care_docsfolders are all underClinical/, but four of these modules were retargeted so they land on the pages the site already has rather than creating near-duplicates:Clinical/Allergyconcepts/clinical/allergy-intoleranceClinical/Medication Statementconcepts/medications/medication-statementClinical/Medicine Administrationconcepts/medications/medication-administrationClinical/Medicine Dispenseconcepts/medications/medication-dispenseThis matches Medication Request, which already sits under the
medicationsdomain. Concept titles follow the existing page names, so "Medicine Administration" becomes "Medication Administration".Flow titles were converted from "How to Record an Allergy" to "Record an allergy", matching the other modules.
Note for reviewers
All five concepts are replaced, not extended. Worth confirming nothing needed is lost from the previous versions.
Verification
Docusaurus build passes for both
enandmllocales.