DRAFT SMART Guidelines L3 SOP
0.2.1 - CI Build International flag

DRAFT SMART Guidelines L3 SOP, published by TBD. This is not an authorized publication; it is the continuous build for version 0.2.1). This version is based on the current content of https://github.com/DigitalSQR/smart-ig-starter-kit and changes regularly. See the Directory of published versions

Personas

ActorDefinitions are the ways that the Personas are structured; A common repository of Personas allows reuse, exchange, change tracking, etc.

Each Persona is defined by the following data:

Personaidentifier[SG] 1..*status 1..1name 1..1title 1..1description 1..1

The L3 author must ensure there is an ActorDefinition for each Persona mentioned in the L2. If the Persona doesn’t exist in the Personas Glossary yet, this process can propose the creation of another different persona. This creation of a new persona is a provisional measure; there SHALL be a governance process for Personas. In that governance, there SHALL be a requirement that all personas in the final publication of a specification SHALL be approved.

Inputs:

  • L2 Generic personas (Narrative)
  • Personas Glossary (in ValueSet SGPersonas)
  • Personas repository (in Common artifacts / central repository?)

Outputs:

  • L3 ActorDefinition compatible with the SGPersona profile
  • Updated Personas ValueSet, if a new persona is defined. This should be submitted for validation
  • Narrative page listing the Personas
* TO DO: What to do with this? How is it published in L3? Table? Will add dependencies from tooling.

Activities:


Reusing an existing Persona

If an ActorDefinition already exists in the Commons repository, and its definitions is adequate to the case submitted, the author shall reuse an existing persona

TO DO: how? See IG Publisher issue https://github.com/HL7/fhir-ig-publisher/issues/311 - Create a dummy / void profile

If an ActorDefinition already exists in the Commons repository, but its definitions is not adequate to the case submitted,

  • If the existing persona is broader, no action.
  • If the existing persona is inadequate (e.g. too strict), it is best to suggest an updated definition.

Creating a new Persona definition

If no ActorDefinition exists in the Commons repository, create a draft & propose a new persona.

.identifier - don’t add an identifier. A final identifier will be assigned in the persona approval / onboarding process.

TO DO: NamingSystem for Actor Identifiers?
TO DO: SGPersona is a profile of Shareable? Publishable?

.status = fixed value draft .name - add a meaningful computer-readable name (no spaces, PascalCase) .title - add a meaningful title we.g. Healthcare Worker .description - add a summary description .type - fixed value person .description - add a summary description

Adding the Personas to the narrative page

The personas should be listed in the personas.md page. To enable this, the L3 author can simply add any supporting narrative and make sure the personas.md page contains this:

{% include fragment-actors.liquid %}

Personas will be associated with actions(processes). The tracking of that association is managed in another process. See Common artifacts governance.

Criteria / Definition of Done

  • All Personas SHALL use the SGPersona ActorDefinition profile
  • Each Persona source follow the guidelines for file content and names
  • All the personas SHOULD be from the Personas glossary; any exceptions will have to be resolved before final publication

Change tracking

Tooling

Tool Usage Doc
Sushi New persona instances can be created in FSH syntax HL7 Spec
Sushi Documentation

Informative examples

Known issues and dependencies

* TO DO: How to use R5 resourcesin an R4 IG ? Sushi issue on the way
  • (links to issues, or zulip, or open questions)