Skip to content

[DISCUSSION] Add version release workflow docs and changes page (#340) - #341

Draft
niccoreyes wants to merge 2 commits into
UPM-NTHC:mainfrom
niccoreyes:feat-version-release-workflow
Draft

[DISCUSSION] Add version release workflow docs and changes page (#340)#341
niccoreyes wants to merge 2 commits into
UPM-NTHC:mainfrom
niccoreyes:feat-version-release-workflow

Conversation

@niccoreyes

@niccoreyes niccoreyes commented Jun 9, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Summary

This PR adds formal documentation for the PH Core version release workflow, establishing a repeatable, documented process for tagging and publishing releases so downstream IGs can resolve fhir.ph.core from the FHIR Package Registry.

Key discovery: PH Core is not yet registered in the FHIR IG Registry. A separate PR to FHIR/ig-registry editing fhir-ig-list.json will be needed after the first release is published.

CI/CD model: The release workflow is based on Jörn Guy Süß's (CSIRO) PH eReferral IG Release Workflow, which triggers on v* tags, patches sushi-config.yaml at build time, runs the full IG Publisher, and publishes versioned releases to gh-pages with auto-generated history.html, index.html, and package-list.json.

Related Issue

Closes #340

Type of Work

  • Narrative Page
  • Documentation
  • CI/Build Infrastructure

Changes Made

  1. input/pagecontent/changes.md — Version history page (AU Core style) documenting:

    • v0.1.0 (2025-10-06) — Foundation release
    • v0.2.0 (2026-04-29) — Profile expansion
    • v0.3.0 (2026-05-20) — Stabilization release

  2. input/pagecontent/version-release-workflow.md — BPMN-style release workflow with:

    • Mermaid flowchart of the full release pipeline (Pre-Release → Tagging → Build → GitHub Pages → FHIR Registries → Verification)
    • Step-by-step procedure for maintainers
    • Semantic versioning rules adapted for FHIR IGs
    • Pre-release checklist
    • CI/CD build & publish details (modeled on Jörn's workflow)
    • FHIR IG Registry registration instructions (with JSON entry template)
    • Post-release actions
    • Anti-overwrite protection note

  3. sushi-config.yaml — Updated menu to include:

    • "Changes" → changes.html
    • "Release Workflow" → version-release-workflow.html

Validation / Testing

  • IG builds successfully (sushi . with 0 errors)
  • Examples validate
  • Terminology checked
  • Links verified
  • Other:

Reviewer Notes

  • Please verify the version dates and commit hashes match the team's consensus.
  • The Mermaid diagram in version-release-workflow.md will render in the IG if the publisher supports it; otherwise it displays as code block.
  • The menu additions follow the AU Core pattern (e.g., https://hl7.org.au/fhir/core/2.0.0/changes.html).
  • Follow-up needed: A separate PR to FHIR/ig-registry editing fhir-ig-list.json to register PH Core. This is documented in the workflow page.
  • Follow-up needed: An ig-release.yml CI/CD workflow (can be added in a separate PR). This PR only documents the workflow; implementation is future work.

Preview / Screenshots

https://build.fhir.org/ig/UP-Manila-SILab/ph-core/branches/feat-version-release-workflow/

@niccoreyes niccoreyes self-assigned this Jun 9, 2026
@niccoreyes
niccoreyes force-pushed the feat-version-release-workflow branch from 6c44b4f to 9a578a5 Compare June 9, 2026 05:36
@niccoreyes niccoreyes changed the title Add version release workflow docs and changes page (#340) [DISCUSSION] Add version release workflow docs and changes page (#340) Jun 10, 2026
niccoreyes added a commit to niccoreyes/ph-core that referenced this pull request Jun 12, 2026
@niccoreyes
feat(examples): Add comprehensive ACS clinical case examples (UPM-NTH…
4e2946c 
…C#305)

Add 17 new FSH example files for a unified Acute Coronary Syndrome
clinical case at Philippine General Hospital, addressing issue UPM-NTHC#305.

Clinical Scenario:
- Patient: Juan Dela Cruz, 45M, Filipino, with T2DM history
- Presenting complaint: Crushing substernal chest pain (8/10)
- Diagnosis: Anterior STEMI (ST-elevation V1-V4, troponin 2.5 ng/mL)
- Treatment: Emergency PCI with drug-eluting stent to LAD
- Disposition: Transferred to CCU

New Resources Created:
- Patient: patient-acs-example (Juan Dela Cruz)
- Organization: organization-pgh-example (Philippine General Hospital)
- Location: location-ed-example (PGH ED Bay 3)
- Practitioner: practitioner-ed-example (Dr. Maria Clara Santos)
- PractitionerRole: practitionerrole-ed-example (ED Attending)
- Conditions: condition-acs-example, condition-t2dm-example
- Encounter: encounter-ed-example (ED visit, 08:30-10:30)
- Observations: 13 total (7 vital signs + 6 labs/diagnostics)
  - Vitals: BP, HR, RR, SpO2, Temp, Pain
  - Labs: Troponin, Glucose, HbA1c, Total Cholesterol, LDL, ECG
- Procedure: procedure-pci-example (PCI with stent)
- ServiceRequest: servicerequest-pci-example (Cardiology consult)
- MedicationRequests: 3 (Aspirin 325mg, Clopidogrel 600mg, Metoprolol 25mg)
- AllergyIntolerance: allergy-penicillin-example (high criticality)
- RelatedPerson: relatedperson-mother-example (Maria Cruz Santos)
- Composition: composition-ed-note-example (ED clinical note)
- Bundle: bundle-acs-case-example (Transaction bundle, 30 entries)

Also updated aliases.fsh to add missing terminology aliases:
- allergyintolerance-verification
- v3-ParticipationType
- immunization-funding-source
- admit-source
- discharge-disposition
- diagnosis-role

Alignment Rules Followed (per UPM-NTHC#305):
- Single patient identity across all resources (Juan Dela Cruz)
- Single practitioner (Dr. Maria Clara Santos) and organization (PGH)
- Consistent PSGC-coded addresses for all Philippine locations
- No hardcoded text.div narratives (publisher-generated)
- All resources use PH Core profiles
- All examples compile with SUSHI (0 errors)

Closes UPM-NTHC#305
Refs UPM-NTHC#306, UPM-NTHC#307, UPM-NTHC#308, UPM-NTHC#309, UPM-NTHC#310, UPM-NTHC#311, UPM-NTHC#312, UPM-NTHC#313, UPM-NTHC#314, UPM-NTHC#315, UPM-NTHC#316, UPM-NTHC#317, UPM-NTHC#318, UPM-NTHC#319, UPM-NTHC#320, UPM-NTHC#321, UPM-NTHC#322, UPM-NTHC#323, UPM-NTHC#324, UPM-NTHC#325, UPM-NTHC#326, UPM-NTHC#327, UPM-NTHC#328, UPM-NTHC#329, UPM-NTHC#330, UPM-NTHC#331, UPM-NTHC#332, UPM-NTHC#333, UPM-NTHC#334, UPM-NTHC#335, UPM-NTHC#336, UPM-NTHC#337, UPM-NTHC#338, UPM-NTHC#339, UPM-NTHC#340, UPM-NTHC#341, UPM-NTHC#342, UPM-NTHC#343, UPM-NTHC#344
gpfvillanueva pushed a commit that referenced this pull request Jun 17, 2026
@niccoreyes
feat(examples): Add comprehensive ACS clinical case examples (#305) (#…
44c81b3 
…347)

* feat(examples): Add comprehensive ACS clinical case examples (#305)

Add 17 new FSH example files for a unified Acute Coronary Syndrome
clinical case at Philippine General Hospital, addressing issue #305.

Clinical Scenario:
- Patient: Juan Dela Cruz, 45M, Filipino, with T2DM history
- Presenting complaint: Crushing substernal chest pain (8/10)
- Diagnosis: Anterior STEMI (ST-elevation V1-V4, troponin 2.5 ng/mL)
- Treatment: Emergency PCI with drug-eluting stent to LAD
- Disposition: Transferred to CCU

New Resources Created:
- Patient: patient-acs-example (Juan Dela Cruz)
- Organization: organization-pgh-example (Philippine General Hospital)
- Location: location-ed-example (PGH ED Bay 3)
- Practitioner: practitioner-ed-example (Dr. Maria Clara Santos)
- PractitionerRole: practitionerrole-ed-example (ED Attending)
- Conditions: condition-acs-example, condition-t2dm-example
- Encounter: encounter-ed-example (ED visit, 08:30-10:30)
- Observations: 13 total (7 vital signs + 6 labs/diagnostics)
  - Vitals: BP, HR, RR, SpO2, Temp, Pain
  - Labs: Troponin, Glucose, HbA1c, Total Cholesterol, LDL, ECG
- Procedure: procedure-pci-example (PCI with stent)
- ServiceRequest: servicerequest-pci-example (Cardiology consult)
- MedicationRequests: 3 (Aspirin 325mg, Clopidogrel 600mg, Metoprolol 25mg)
- AllergyIntolerance: allergy-penicillin-example (high criticality)
- RelatedPerson: relatedperson-mother-example (Maria Cruz Santos)
- Composition: composition-ed-note-example (ED clinical note)
- Bundle: bundle-acs-case-example (Transaction bundle, 30 entries)

Also updated aliases.fsh to add missing terminology aliases:
- allergyintolerance-verification
- v3-ParticipationType
- immunization-funding-source
- admit-source
- discharge-disposition
- diagnosis-role

Alignment Rules Followed (per #305):
- Single patient identity across all resources (Juan Dela Cruz)
- Single practitioner (Dr. Maria Clara Santos) and organization (PGH)
- Consistent PSGC-coded addresses for all Philippine locations
- No hardcoded text.div narratives (publisher-generated)
- All resources use PH Core profiles
- All examples compile with SUSHI (0 errors)

Closes #305
Refs #306, #307, #308, #309, #310, #311, #312, #313, #314, #315, #316, #317, #318, #319, #320, #321, #322, #323, #324, #325, #326, #327, #328, #329, #330, #331, #332, #333, #334, #335, #336, #337, #338, #339, #340, #341, #342, #343, #344

* feat(examples): Simplify ACS clinical case to core PH Core resources (#305)

Remove 6 non-core resources to keep the case lean and focused:
- Location, Procedure, ServiceRequest, MedicationRequest
- AllergyIntolerance, RelatedPerson

Keep 9 core resources that exercise PH Core uniqueness:
- Patient, Encounter, Organization, Condition, Observation
- Practitioner, PractitionerRole, Composition, Bundle

Also updated:
- Composition: removed sections for medications, allergies, procedures
- Bundle: reduced from 30 to 21 entries (core resources only)
- Encounter: removed location references, simplified hospitalization
- Aliases: removed unused terminology aliases

Closes #305

* feat: Add ACS ED Triage sample case with REST API tutorial (#305)

- Create comprehensive sample-case.md tutorial page with FHIR REST API
  basics (GET, POST, PUT, PATCH, DELETE, Bundle transactions)
- Fix FSH example files for clean IG Publisher validation:
  - Patient: religion display, address, remove contact
  - Observation: combine BP components, fix LOINC codes
  - Condition: SNOMED display
  - Encounter: remove dischargeDisposition
  - PractitionerRole: remove dangling location reference
  - Composition: LOINC displays
  - Labs: glucose/LDL codes
  - Bundle: updated for combined BP
- Add 'Sample Case' menu item in sushi-config.yaml
- Style tables with CSS (borders, alternating rows, hover)
- All examples validated against tx.fhir.org
- Tested against https://cdr.fhirlab.net/fhir

Fixes #305
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@niccoreyes niccoreyes

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[T] Establish Version Release Workflow (BPMN) and CI/CD Guide

1 participant

@niccoreyes