SMART Base
0.2.0 - ci-build

SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-base/tree/main and changes regularly. See the Directory of published versions

Logical Model: User Scenario (DAK)

Official URL: http://smart.who.int/base/StructureDefinition/UserScenario Version: 0.2.0
Active as of 2025-10-14 Computable Name: UserScenario

Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. UserScenario 0..* Base User Scenario (DAK)
... title 1..1 string Title
... id 1..1 id Scenario ID
... description[x] 1..1 Description
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

API Information

User Scenario (DAK) API

Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.

Version: 1.0.0

Endpoints

GET /StructureDefinition-UserScenario.schema.json

JSON Schema definition for the Logical Model StructureDefinition-UserScenario

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-UserScenario.

Schema Definition

StructureDefinition-UserScenario

Description: Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.

Type: object

Schema ID: https://worldhealthorganization.github.io/smart-base/StructureDefinition-UserScenario.schema.json

Properties

  • resourceType (string): Resource type identifier for UserScenario logical model
  • title (string): Title of the user scenario
  • id (string): An identifier for the user scenario
  • description[x] (unknown): Description of the scenario - either Markdown content or a URI to a Markdown file (absolute or relative to repository root, like input/pagecontent/scenario-XYZ.md)
  • personas (array): References to persona IDs that participate in this scenario

Required fields: resourceType, title, id, description[x]

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-UserScenario.schema.json",
  "title": "User Scenario (DAK)",
  "description": "Logical Model for representing User Scenarios from a DAK. Narratives that describe how the different personas may interact with each other.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "UserScenario",
      "description": "Resource type identifier for UserScenario logical model"
    },
    "title": {
      "type": "string",
      "description": "Title of the user scenario"
    },
    "id": {
      "type": "string",
      "description": "An identifier for the user scenario"
    },
    "description[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "format": "uri"
        }
      ],
      "description": "Description of the scenario - either Markdown content or a URI to a Markdown file (absolute or relative to repository root, like input/pagecontent/scenario-XYZ.md)"
    },
    "personas": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "References to persona IDs that participate in this scenario"
    }
  },
  "required": [
    "resourceType",
    "title",
    "id",
    "description[x]"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/UserScenario",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base"
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. UserScenario 0..* Base User Scenario (DAK)
... title 1..1 string Title
... id 1..1 id Scenario ID
... description[x] 1..1 Description
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. UserScenario 0..* Base User Scenario (DAK)
... title 1..1 string Title
... id 1..1 id Scenario ID
... description[x] 1..1 Description
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. UserScenario 0..* Base User Scenario (DAK)
... title 1..1 string Title
... id 1..1 id Scenario ID
... description[x] 1..1 Description
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. UserScenario 0..* Base User Scenario (DAK)
... title 1..1 string Title
... id 1..1 id Scenario ID
... description[x] 1..1 Description
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. UserScenario 0..* Base User Scenario (DAK)
... title 1..1 string Title
... id 1..1 id Scenario ID
... description[x] 1..1 Description
.... descriptionString string
.... descriptionUri uri

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)

 

Other representations of profile: CSV, Excel