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: Requirements Source

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

Source reference for Requirements - exactly one of the following must be provided:

  • url (url data type): URL to retrieve Requirements definition from input/ or external source
  • canonical (canonical data type): Canonical URI pointing to the Requirements definition
  • instance: Inline Requirements instance data

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
.. RequirementsSource 0..* Base Requirements Source
... url 0..1 url URL
... canonical 0..1 canonical(Functional and Non-Functional Requirements (DAK)) Canonical
... instance 0..1 Requirements Instance

doco Documentation for this format

API Information

Requirements Source API

Source reference for Requirements - exactly one of the following must be provided: - url (url data type): URL to retrieve Requirements definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the Requirements definition - instance: Inline Requirements instance data

Version: 1.0.0

Endpoints

GET /StructureDefinition-RequirementsSource.schema.json

JSON Schema definition for the Logical Model StructureDefinition-RequirementsSource

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

Schema Definition

StructureDefinition-RequirementsSource

Description: Source reference for Requirements - exactly one of the following must be provided: - url (url data type): URL to retrieve Requirements definition from input/ or external source - canonical (canonical data type): Canonical URI pointing to the Requirements definition - instance: Inline Requirements instance data

Type: object

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

Properties

  • resourceType (string): Resource type identifier for RequirementsSource logical model
  • url (string): URL to retrieve Requirements definition from input/ or external source
  • canonical (string): Canonical URI pointing to the Requirements definition
  • instance (unknown): Inline Requirements 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-RequirementsSource.schema.json",
  "title": "Requirements Source",
  "description": "Source reference for Requirements - exactly one of the following must be provided:\n- url (url data type): URL to retrieve Requirements definition from input/ or external source\n- canonical (canonical data type): Canonical URI pointing to the Requirements definition\n- instance: Inline Requirements instance data",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "RequirementsSource",
      "description": "Resource type identifier for RequirementsSource logical model"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "URL to retrieve Requirements definition from input/ or external source"
    },
    "canonical": {
      "type": "string",
      "format": "uri",
      "description": "Canonical URI pointing to the Requirements definition"
    },
    "instance": {
      "$ref": "https://worldhealthorganization.github.io/smart-base/StructureDefinition-Requirements.schema.json",
      "description": "Inline Requirements instance data"
    }
  },
  "required": [
    "resourceType"
  ],
  "resourceDefinition": "http://smart.who.int/base/StructureDefinition/RequirementsSource",
  "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
.. RequirementsSource 0..* Base Requirements Source
... url 0..1 url URL
... canonical 0..1 canonical(Functional and Non-Functional Requirements (DAK)) Canonical
... instance 0..1 Requirements Instance

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequirementsSource 0..* Base Requirements Source
... url 0..1 url URL
... canonical 0..1 canonical(Functional and Non-Functional Requirements (DAK)) Canonical
... instance 0..1 Requirements Instance

doco Documentation for this format

This structure is derived from Base

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequirementsSource 0..* Base Requirements Source
... url 0..1 url URL
... canonical 0..1 canonical(Functional and Non-Functional Requirements (DAK)) Canonical
... instance 0..1 Requirements Instance

doco Documentation for this format

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequirementsSource 0..* Base Requirements Source
... url 0..1 url URL
... canonical 0..1 canonical(Functional and Non-Functional Requirements (DAK)) Canonical
... instance 0..1 Requirements Instance

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RequirementsSource 0..* Base Requirements Source
... url 0..1 url URL
... canonical 0..1 canonical(Functional and Non-Functional Requirements (DAK)) Canonical
... instance 0..1 Requirements Instance

doco Documentation for this format

This structure is derived from Base

 

Other representations of profile: CSV, Excel