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: Functional Requirement (DAK)

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

Logical Model for representing functional requirement from a DAK

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
.. FunctionalRequirement 0..* Base Functional Requirement (DAK)
... id 1..1 id Requirement ID
... activity 1..1 markdown Activity
... actor 0..* Reference(SGActor) Actor
.... capabilityMarkdown markdown
.... capabilityCoding Coding
... benefit[x] 0..1 Benefit
.... benefitMarkdown markdown
.... benefitCoding Coding
... classification 0..* Coding Classification

doco Documentation for this format

API Information

Functional Requirement (DAK) API

Logical Model for representing functional requirement from a DAK

Version: 1.0.0

Endpoints

GET /StructureDefinition-FunctionalRequirement.schema.json

JSON Schema definition for the Logical Model StructureDefinition-FunctionalRequirement

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

Schema Definition

StructureDefinition-FunctionalRequirement

Description: Logical Model for representing functional requirement from a DAK

Type: object

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

Properties

  • resourceType (string): Resource type identifier for FunctionalRequirement logical model
  • id (string): An identifier or code for the requirement
  • activity (string): Description of the activity being performed
  • actor (array): The actor(s) that should fulfill the requirement
  • capability[x] (unknown): Capability achieved by an actor fulfilling the requirement (I want)
  • benefit[x] (unknown): Benefit to an actor fulfilling the requirement (so that)
  • classification (array): Classification of the identifier

Required fields: resourceType, id, activity

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-FunctionalRequirement.schema.json",
  "title": "Functional Requirement (DAK)",
  "description": "Logical Model for representing functional requirement from a DAK",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "FunctionalRequirement",
      "description": "Resource type identifier for FunctionalRequirement logical model"
    },
    "id": {
      "type": "string",
      "description": "An identifier or code for the requirement"
    },
    "activity": {
      "type": "string",
      "description": "Description of the activity being performed"
    },
    "actor": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Reference"
      },
      "description": "The actor(s) that should fulfill the requirement"
    },
    "capability[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "object"
        }
      ],
      "description": "Capability achieved by an actor fulfilling the requirement (I want)"
    },
    "benefit[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "object"
        }
      ],
      "description": "Benefit to an actor fulfilling the requirement (so that)"
    },
    "classification": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Classification of the identifier"
    }
  },
  "required": [
    "resourceType",
    "id",
    "activity"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/FunctionalRequirement",
  "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
.. FunctionalRequirement 0..* Base Functional Requirement (DAK)
... id 1..1 id Requirement ID
... activity 1..1 markdown Activity
... actor 0..* Reference(SGActor) Actor
.... capabilityMarkdown markdown
.... capabilityCoding Coding
... benefit[x] 0..1 Benefit
.... benefitMarkdown markdown
.... benefitCoding Coding
... classification 0..* Coding Classification

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FunctionalRequirement 0..* Base Functional Requirement (DAK)
... id 1..1 id Requirement ID
... activity 1..1 markdown Activity
... actor 0..* Reference(SGActor) Actor
.... capabilityMarkdown markdown
.... capabilityCoding Coding
... benefit[x] 0..1 Benefit
.... benefitMarkdown markdown
.... benefitCoding Coding
... classification 0..* Coding Classification

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FunctionalRequirement 0..* Base Functional Requirement (DAK)
... id 1..1 id Requirement ID
... activity 1..1 markdown Activity
... actor 0..* Reference(SGActor) Actor
.... capabilityMarkdown markdown
.... capabilityCoding Coding
... benefit[x] 0..1 Benefit
.... benefitMarkdown markdown
.... benefitCoding Coding
... classification 0..* Coding Classification

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FunctionalRequirement 0..* Base Functional Requirement (DAK)
... id 1..1 id Requirement ID
... activity 1..1 markdown Activity
... actor 0..* Reference(SGActor) Actor
.... capabilityMarkdown markdown
.... capabilityCoding Coding
... benefit[x] 0..1 Benefit
.... benefitMarkdown markdown
.... benefitCoding Coding
... classification 0..* Coding Classification

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. FunctionalRequirement 0..* Base Functional Requirement (DAK)
... id 1..1 id Requirement ID
... activity 1..1 markdown Activity
... actor 0..* Reference(SGActor) Actor
.... capabilityMarkdown markdown
.... capabilityCoding Coding
... benefit[x] 0..1 Benefit
.... benefitMarkdown markdown
.... benefitCoding Coding
... classification 0..* Coding Classification

doco Documentation for this format

This structure is derived from Base

Summary

Mandatory: 0 element(2 nested mandatory elements)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel