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: Business Process Workflow (DAK)

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

Logical Model for representing Generic Business Processes and Workflows from a DAK. A business process is a set of related activities or tasks performed together to achieve the objectives of the health programme area.

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
.. BusinessProcessWorkflow 0..* Base Business Process Workflow (DAK)
... id 1..1 id Business Process ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... source 1..1 uri Source
... objectives 1..1 markdown Objectives
... task 0..* BackboneElement Task
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 1..1 id Task ID
.... name 1..1 string Task Name
.... description 1..1 markdown Task Description

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

API Information

Business Process Workflow (DAK) API

Logical Model for representing Generic Business Processes and Workflows from a DAK. A business process is a set of related activities or tasks performed together to achieve the objectives of the health programme area.

Version: 1.0.0

Endpoints

GET /StructureDefinition-BusinessProcessWorkflow.schema.json

JSON Schema definition for the Logical Model StructureDefinition-BusinessProcessWorkflow

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

Schema Definition

StructureDefinition-BusinessProcessWorkflow

Description: Logical Model for representing Generic Business Processes and Workflows from a DAK. A business process is a set of related activities or tasks performed together to achieve the objectives of the health programme area.

Type: object

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

Properties

  • resourceType (string): Resource type identifier for BusinessProcessWorkflow logical model
  • id (object): Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • description[x] (unknown): Description of the business process - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)
  • source (string): Link to a BPMN file containing the workflow definition. Source URI could be absolute or relative to the root of the DAK
  • scenario (array): References to user scenario IDs related to this workflow
  • objectives (string): Description of the objectives of the workflow
  • task (array): Tasks within the business process workflow
  • modifierExtension (array): May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
  • identifier (string): Identifier for the task
  • name (string): Name of the task
  • description (string): Description of what the task involves

Required fields: resourceType, id, source, objectives, identifier, name, description

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-BusinessProcessWorkflow.schema.json",
  "title": "Business Process Workflow (DAK)",
  "description": "Logical Model for representing Generic Business Processes and Workflows from a DAK. A business process is a set of related activities or tasks performed together to achieve the objectives of the health programme area.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "BusinessProcessWorkflow",
      "description": "Resource type identifier for BusinessProcessWorkflow logical model"
    },
    "id": {
      "type": "object",
      "description": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces."
    },
    "description[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "format": "uri"
        }
      ],
      "description": "Description of the business process - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)"
    },
    "source": {
      "type": "string",
      "format": "uri",
      "description": "Link to a BPMN file containing the workflow definition. Source URI could be absolute or relative to the root of the DAK"
    },
    "scenario": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "References to user scenario IDs related to this workflow"
    },
    "objectives": {
      "type": "string",
      "description": "Description of the objectives of the workflow"
    },
    "task": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Tasks within the business process workflow"
    },
    "modifierExtension": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Extension"
      },
      "description": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)."
    },
    "identifier": {
      "type": "string",
      "description": "Identifier for the task"
    },
    "name": {
      "type": "string",
      "description": "Name of the task"
    },
    "description": {
      "type": "string",
      "description": "Description of what the task involves"
    }
  },
  "required": [
    "resourceType",
    "id",
    "source",
    "objectives",
    "identifier",
    "name",
    "description"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/BusinessProcessWorkflow",
  "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
.. BusinessProcessWorkflow 0..* Base Business Process Workflow (DAK)
... id 1..1 id Business Process ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... source 1..1 uri Source
... objectives 1..1 markdown Objectives
... task 0..* BackboneElement Task
.... identifier 1..1 id Task ID
.... name 1..1 string Task Name
.... description 1..1 markdown Task Description

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BusinessProcessWorkflow 0..* Base Business Process Workflow (DAK)
... id 1..1 id Business Process ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... source 1..1 uri Source
... objectives 1..1 markdown Objectives
... task 0..* BackboneElement Task
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 1..1 id Task ID
.... name 1..1 string Task Name
.... description 1..1 markdown Task Description

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BusinessProcessWorkflow 0..* Base Business Process Workflow (DAK)
... id 1..1 id Business Process ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... source 1..1 uri Source
... objectives 1..1 markdown Objectives
... task 0..* BackboneElement Task
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 1..1 id Task ID
.... name 1..1 string Task Name
.... description 1..1 markdown Task Description

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BusinessProcessWorkflow 0..* Base Business Process Workflow (DAK)
... id 1..1 id Business Process ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... source 1..1 uri Source
... objectives 1..1 markdown Objectives
... task 0..* BackboneElement Task
.... identifier 1..1 id Task ID
.... name 1..1 string Task Name
.... description 1..1 markdown Task Description

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. BusinessProcessWorkflow 0..* Base Business Process Workflow (DAK)
... id 1..1 id Business Process ID
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... source 1..1 uri Source
... objectives 1..1 markdown Objectives
... task 0..* BackboneElement Task
.... @id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... identifier 1..1 id Task ID
.... name 1..1 string Task Name
.... description 1..1 markdown Task Description

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(6 nested mandatory elements)

 

Other representations of profile: CSV, Excel