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/copilot/fix-lm-and-valuest-issue and changes regularly. See the Directory of published versions

Logical Model: Functional and Non-Functional Requirements (DAK)

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

Logical Model for representing Functional and Non-Functional Requirements from a DAK. A high-level list of core functions and capabilities that the system must have to meet the end users' needs.

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
.. Requirements 0..* Base Functional and Non-Functional Requirements (DAK)
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... functional 0..* Reference(Functional Requirement (DAK)) Functional Requirements
... nonfunctional 0..* Reference(Non-Functional Requirement (DAK)) Non-Functional Requirements

doco Documentation for this format

API Information

Functional and Non-Functional Requirements (DAK) API

Logical Model for representing Functional and Non-Functional Requirements from a DAK. A high-level list of core functions and capabilities that the system must have to meet the end users' needs.

Version: 1.0.0

Endpoints

GET /StructureDefinition-Requirements.schema.json

JSON Schema definition for the Logical Model StructureDefinition-Requirements

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

Schema Definition

StructureDefinition-Requirements

Description: Logical Model for representing Functional and Non-Functional Requirements from a DAK. A high-level list of core functions and capabilities that the system must have to meet the end users' needs.

Type: object

Schema ID: https://worldhealthorganization.github.io/smart-base/branches/copilot/fix-lm-and-valuest-issue/StructureDefinition-Requirements.schema.json

Properties

  • resourceType (string): Resource type identifier for Requirements logical model
  • description[x] (unknown): Description of the requirements - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)
  • functional (array): Functional requirements for the system that reference https://worldhealthorganization.github.io/smart-base/branches/fix-152/StructureDefinition-FunctionalRequirement.html
  • nonfunctional (array): Non-functional requirements for the system that reference https://worldhealthorganization.github.io/smart-base/branches/fix-152/StructureDefinition-NonFunctionalRequirement.html

Required fields: resourceType

Full Schema (JSON)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/branches/copilot/fix-lm-and-valuest-issue/StructureDefinition-Requirements.schema.json",
  "title": "Functional and Non-Functional Requirements (DAK)",
  "description": "Logical Model for representing Functional and Non-Functional Requirements from a DAK. A high-level list of core functions and capabilities that the system must have to meet the end users' needs.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "Requirements",
      "description": "Resource type identifier for Requirements logical model"
    },
    "description[x]": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "type": "string",
          "format": "uri"
        }
      ],
      "description": "Description of the requirements - either Markdown content or a URI to a Markdown file (absolute or relative to repository root)"
    },
    "functional": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Reference"
      },
      "description": "Functional requirements for the system that reference https://worldhealthorganization.github.io/smart-base/branches/fix-152/StructureDefinition-FunctionalRequirement.html"
    },
    "nonfunctional": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR Reference"
      },
      "description": "Non-functional requirements for the system that reference https://worldhealthorganization.github.io/smart-base/branches/fix-152/StructureDefinition-NonFunctionalRequirement.html"
    }
  },
  "required": [
    "resourceType"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/Requirements",
  "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
.. Requirements 0..* Base Functional and Non-Functional Requirements (DAK)
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... functional 0..* Reference(Functional Requirement (DAK)) Functional Requirements
... nonfunctional 0..* Reference(Non-Functional Requirement (DAK)) Non-Functional Requirements

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements 0..* Base Functional and Non-Functional Requirements (DAK)
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... functional 0..* Reference(Functional Requirement (DAK)) Functional Requirements
... nonfunctional 0..* Reference(Non-Functional Requirement (DAK)) Non-Functional Requirements

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements 0..* Base Functional and Non-Functional Requirements (DAK)
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... functional 0..* Reference(Functional Requirement (DAK)) Functional Requirements
... nonfunctional 0..* Reference(Non-Functional Requirement (DAK)) Non-Functional Requirements

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements 0..* Base Functional and Non-Functional Requirements (DAK)
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... functional 0..* Reference(Functional Requirement (DAK)) Functional Requirements
... nonfunctional 0..* Reference(Non-Functional Requirement (DAK)) Non-Functional Requirements

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Requirements 0..* Base Functional and Non-Functional Requirements (DAK)
... description[x] 0..1 Description
.... descriptionString string
.... descriptionUri uri
... functional 0..* Reference(Functional Requirement (DAK)) Functional Requirements
... nonfunctional 0..* Reference(Non-Functional Requirement (DAK)) Non-Functional Requirements

doco Documentation for this format

 

Other representations of profile: CSV, Excel