Skip to content

SMRT IG v0.0.2: improved diagrams, fix broken links, clean up numbering - #2

Open
meetsandeepan wants to merge 12 commits into
IHE:masterfrom
meetsandeepan:pr/smrt-v0.0.2
Open

SMRT IG v0.0.2: improved diagrams, fix broken links, clean up numbering#2
meetsandeepan wants to merge 12 commits into
IHE:masterfrom
meetsandeepan:pr/smrt-v0.0.2

Conversation

@meetsandeepan

@meetsandeepan meetsandeepan commented Jun 19, 2026

Copy link
Copy Markdown

📑 Description

Maintenance pass on the SMRT IG bringing it to v0.0.2-current:

  • Redesigned all PlantUML diagrams — consistent color scheme throughout: SMRT actors in blue, external/context actors in gray, SMRT FHIR transactions in solid dark blue, DICOM retrievals in orange, reused/external (HL7v2/ITI) transactions in dashed gray. All sequence diagrams now include full actor names, acknowledgement return arrows, and a contextual note.
  • Fixed 8 broken links — removed unavailable definition/example zip download links from the Download page (not generated until profiles exist); fixed two broken anchor fragments in testplan.md pointing to non-existent artifact sections.
  • Cleaned up Volume 3 menu label — removed the [Domain-ZZ] template artifact from the page title and menu entry.
  • Fixed inconsistent placeholder numbering1:XX1:X in Home and Volume 1 page titles; 3:?.ZZ3:Z.ZZ for the content modules page; aligned table element IDs (tXX.tX.) with their caption numbers in volume-1.md.
  • Bumped version to 0.0.2-current.
  • Updated publisher helper scripts to latest upstream versions.

✅ Checks

  • My pull request adheres to the code style of this project
  • I have updated the documentation as required
  • All the tests have passed (IG Publisher build: 0 errors, 0 warnings, 0 broken links)
  • I have selected a committee co-chair to review the PR

ℹ Additional Information

All changes are editorial/presentational — no new transactions, actors, or normative content were added. The IG Publisher CI build passes cleanly on this branch.

meetsandeepan and others added 12 commits June 18, 2026 22:10
Keep Claude Code context file local-only so it doesn't pollute the upstream IHE repository.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Rework the implementation guide to match the authoritative SMRT supplement
(Rev 0.1), transaction assignment worksheet, and sequence diagram from the
project Box folder. Replaces the leftover IHE-template REST-query model
(ServiceRequest search, REPO actor) with the SMRT workflow + content design.

- sushi-config: fix profile title, rewrite description, update page/menu
  titles to the real transactions
- index: correct profile name and TMS terminology (was "TPMS")
- volume-1: author profile overview, ROIS/TMS actors, the nine provisional
  RO-SMRT transactions, Support Prescription Option, baseline required
  groupings, Use Case #1 (Shared Management of Treatment) with process flow,
  and security/cross-profile considerations
- RO-SMRT-01: repurpose Volume 2 page to Sync Patient Demographics
- diagrams: redraw actor diagram, use-case process flow, and RO-SMRT-01
  sequence diagram to match the ROIS/TMS workflow
- issues: record significant changes and open issues (provisional IDs, OST
  retrieval actor, messaging choices, FHIR content profiles, USCDI, security)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01933N9VdW9FuKWvHp9fBPXi
Refactor SMRT profile: clarify scope, define transactions, and update use cases
…atements

Build out the SMRT IG beyond Volume 1, continuing to follow the supplement,
transaction worksheet, sequence diagram, and USCDI investigation from Box.

Volume 2:
- Add transaction detail pages RO-SMRT-02 through RO-SMRT-09 (scope, actor
  roles, referenced standards, interaction diagrams, semantics placeholders),
  each marked provisional pending IHE-RO Technical Committee assignment
- Add an interaction sequence diagram for each new transaction
- Register the new pages and menu entries; expand the index Volume 2 list

Volume 3:
- Author the SMRT content-modules page: FHIR message content referencing
  DICOM RT objects (RT Plan, RT Record, Image), prescription summary content,
  and the candidate USCDI data classes for radiation oncology

FSH:
- Replace the ToDo client/server CapabilityStatements with requirements
  CapabilityStatements for the ROIS and TMS actors and link them from the
  Volume 1 actor descriptions
- Remove leftover template example resources (laugh observation, example
  patient/encounter/practitioners)

Verified with SUSHI: 0 errors, 0 warnings.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01933N9VdW9FuKWvHp9fBPXi
Rework the transaction model to match the updated SMRT Phase 1 / MVP
sequence diagram (SMRT Sequence Diagram MVP_20260615). The profile now
defines only the new FHIR-message exchanges as RO-SMRT transactions and
reuses established IHE transactions/standards by grouping for the rest.

Transactions defined by this profile (FHIR messages, RO-SMRT-01..05):
- RO-SMRT-01 Sync Patient Photo (by value or by reference to a DICOM SC image)
- RO-SMRT-02 Report Planning Artifacts (refs DICOM RT objects)
- RO-SMRT-03 Report Treatment Approval
- RO-SMRT-04 Report Treatment Artifacts (refs DICOM RT objects)
- RO-SMRT-05 Report Image Review Results

Reused by grouping (documented, not newly defined): patient demographics &
encounter via IHE-ITI PAM [ITI-30]/[ITI-31] (HL7 V2 ADT), appointment &
check-in via HL7 V2 SIU, prescription summary via IHE-RO XRTS [XRTS-08]
(Support Prescription Option), and DICOM retrieval from the object store.

- volume-1: two transaction tables (defined vs reused), updated actor
  descriptions, options, required groupings, and Use Case #1 process flow
- Volume 2: rewrite RO-SMRT-01..05; remove obsolete RO-SMRT-06..09
- diagrams: redraw actor diagram, process flow, and all interaction diagrams
- FSH: update ROIS/TMS CapabilityStatement transaction lists
- Volume 3: drop USCDI content module (out of MVP scope); add patient photo
  and approval content; note HIS summary/billing as external
- issues: refresh significant changes and open issues; USCDI moved to future
  work

Drops the USCDI transaction (absent from the June 15 MVP flow). Verified with
SUSHI: 0 errors, 0 warnings.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01933N9VdW9FuKWvHp9fBPXi
Replace the supplement-template boilerplate README with project-specific
content: profile overview, actors, the defined/reused transaction tables,
repository layout, and build instructions.

Add a GitHub-renderable Mermaid sequence diagram of the Use Case #1 (MVP)
workflow that mirrors the PlantUML process-flow swimlane, so the flow is
visible directly in Markdown without building the IG.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01933N9VdW9FuKWvHp9fBPXi
Use "Shanghai F2F" terminology for the agreed Phase 1 (MVP) sequence diagram
in the README and Volume 1 editor's note.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01933N9VdW9FuKWvHp9fBPXi
SMRT: Volume 2/3 detail + realign to Shanghai F2F MVP sequence diagram
- Remove definition/example zip download links that aren't generated yet
- Fix testplan.md anchor links to artifacts.html sections that don't exist
- Rename "SMRT Content Modules [Domain-ZZ]" to "SMRT Content Modules" in page title and menu
- Update publisher helper scripts to latest upstream versions

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- sushi-config.yaml: 1:XX → 1:X in Home and Volume 1 page titles
- sushi-config.yaml: 3:?.ZZ → 3:Z.ZZ for content modules page
- volume-1.md: align table element IDs from tXX. to tX. to match table caption numbers

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Color scheme: SMRT actors in blue, external actors in gray, SMRT FHIR
transactions in solid dark blue, DICOM retrievals in orange, reused/external
transactions in dashed gray. Sequence diagrams now include full actor names,
acknowledgement return arrows, and contextual notes.
@meetsandeepan

Copy link
Copy Markdown
Author

@tschwere could you please review this PR?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants