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 and Non-Functional Requirements (DAK)

Official URL: http://smart.who.int/base/StructureDefinition/Requirements Version: 0.2.0
Active as of 2025-10-14 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..* BackboneElement Functional Requirements
.... @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
.... canonical 0..1 canonical(Functional Requirement (DAK)) Canonical
.... instance 0..1 FunctionalRequirement Instance
... nonfunctional 0..* BackboneElement Non-Functional Requirements
.... @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
.... canonical 0..1 canonical(Non-Functional Requirement (DAK)) Canonical
.... instance 0..1 NonFunctionalRequirement Instance

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

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/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 - can be provided as canonical reference or inline instance data
  • id (object): Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
  • 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).
  • canonical (string): Canonical URI pointing to the NonFunctionalRequirement definition
  • instance (unknown): Inline NonFunctionalRequirement instance data
  • nonfunctional (array): Non-functional requirements for the system - can be provided as canonical reference or inline instance data

Required fields: resourceType

Full Schema (JSON)
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://worldhealthorganization.github.io/smart-base/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 BackboneElement"
      },
      "description": "Functional requirements for the system - can be provided as canonical reference or inline instance data"
    },
    "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."
    },
    "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)."
    },
    "canonical": {
      "type": "string",
      "format": "uri",
      "description": "Canonical URI pointing to the NonFunctionalRequirement definition"
    },
    "instance": {
      "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-NonFunctionalRequirement.schema.json",
      "description": "Inline NonFunctionalRequirement instance data"
    },
    "nonfunctional": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "description": "Non-functional requirements for the system - can be provided as canonical reference or inline instance data"
    }
  },
  "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..* BackboneElement Functional Requirements
.... canonical 0..1 canonical(Functional Requirement (DAK)) Canonical
.... instance 0..1 FunctionalRequirement Instance
... nonfunctional 0..* BackboneElement Non-Functional Requirements
.... canonical 0..1 canonical(Non-Functional Requirement (DAK)) Canonical
.... instance 0..1 NonFunctionalRequirement Instance

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..* BackboneElement Functional Requirements
.... @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
.... canonical 0..1 canonical(Functional Requirement (DAK)) Canonical
.... instance 0..1 FunctionalRequirement Instance
... nonfunctional 0..* BackboneElement Non-Functional Requirements
.... @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
.... canonical 0..1 canonical(Non-Functional Requirement (DAK)) Canonical
.... instance 0..1 NonFunctionalRequirement Instance

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()

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..* BackboneElement Functional Requirements
.... @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
.... canonical 0..1 canonical(Functional Requirement (DAK)) Canonical
.... instance 0..1 FunctionalRequirement Instance
... nonfunctional 0..* BackboneElement Non-Functional Requirements
.... @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
.... canonical 0..1 canonical(Non-Functional Requirement (DAK)) Canonical
.... instance 0..1 NonFunctionalRequirement Instance

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

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..* BackboneElement Functional Requirements
.... @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
.... canonical 0..1 canonical(Functional Requirement (DAK)) Canonical
.... instance 0..1 FunctionalRequirement Instance
... nonfunctional 0..* BackboneElement Non-Functional Requirements
.... @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
.... canonical 0..1 canonical(Non-Functional Requirement (DAK)) Canonical
.... instance 0..1 NonFunctionalRequirement Instance

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()

 

Other representations of profile: CSV, Excel