Skip to content

Add SOP documentation for SMART Guidelines testing with ITB concept mapping#17

Draft
Copilot wants to merge 6 commits into
mainfrom
copilot/add-sop-documentation
Draft

Add SOP documentation for SMART Guidelines testing with ITB concept mapping#17
Copilot wants to merge 6 commits into
mainfrom
copilot/add-sop-documentation

Conversation

Copilot AI commented Dec 9, 2025

Copy link
Copy Markdown
Contributor

Adds comprehensive Standard Operating Procedure documentation for developing tests and conformance statements for SMART Guidelines using the Interoperability Test Bed (ITB).

Key Additions

SOP_DOCUMENTATION.md (653 lines)

Glossary - Maps ITB terminology to SMART Guidelines concepts:

  • Community → SMART Guideline Implementors
  • Domain → Implementation Guide (one per IG: smart-immunizations, smart-hiv, etc.)
  • Specification → FHIR Requirements (profiles, value sets, StructureMaps)
  • Organisation → Software implementor/member state
  • Actor → System role in guideline workflow
  • Links to ITB glossary

Architecture - Systems declare actors for conformance testing; requirements tie to actors; test plans group by actors.

Best Practices - 10 for test writing (structure by actor, validate against profiles, test transformations); 5 for conformance statements (scope, coverage, limitations).

Workflow - 6-phase development process from planning through maintenance.

Examples - Working XML test cases for FHIR resource validation, conformance statement templates, multi-actor test suite structures.

Example Test Structure

<testcase id="validate-immunization" xmlns="http://www.gitb.com/tdl/v1/">
  <actors>
    <gitb:actor id="ImmunizationRegistry" role="SUT"/>
    <gitb:actor id="FHIRValidator" role="SIMULATED"/>
  </actors>
  <steps>
    <!-- Validate against smart-immunizations IG profile -->
    <send desc="Validate against Immunization profile" to="FHIRValidator">
      <input name="profile">
        http://smart.who.int/immunizations/StructureDefinition/Immunization
      </input>
    </send>
  </steps>
</testcase>

Updates

  • README.md - Added SOP documentation link
  • USER_GUIDE.md - Added SOP reference, cleaned up outdated links
Original prompt

This section details on the original issue you should resolve

<issue_title>Add a SOP Documentation</issue_title>
<issue_description>Add a SOP Documentation for best practices on how tests and conformance statements can be written for SMART Guidelines. Start with a glossary linking https://www.itb.ec.europa.eu/docs/itb-ta/latest/introduction/index.html#glossary with SMART Guidelines concepts. Here is a starting thought:

ITB Community = SMART Guideline Implementors

Domains will be one per each IG - for example smart-immunizations, smart-hiv

specifications will be Requirements (FHIR REquirement artifacts in the IG)

Organisations will be Software implementors/member states

Requirements are tied to Actors and test plans are grouped by Actors

Systems (softwares) can declare the actors they want to test against for conformance

@COP</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 5 commits December 9, 2025 08:58
Co-authored-by: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com>
Co-authored-by: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com>
Co-authored-by: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com>
…ples

Co-authored-by: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com>
Co-authored-by: ritikarawlani <38657562+ritikarawlani@users.noreply.github.com>
Copilot AI changed the title [WIP] Add SOP documentation for SMART Guidelines best practices Add SOP documentation for SMART Guidelines testing with ITB concept mapping Dec 9, 2025
Copilot AI requested a review from ritikarawlani December 9, 2025 09:08
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.

Add a SOP Documentation

2 participants