WHO SMART Trust
1.1.6 - CI Build International flag

WHO SMART Trust, published by WHO. This guide is not an authorized publication; it is the continuous build for version 1.1.6 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-trust/tree/main and changes regularly. See the Directory of published versions

Logical Model: Scheme Information ( Abstract )

Official URL: http://smart.who.int/trust/StructureDefinition/SchemeInformation Version: 1.1.6
Draft as of 2025-12-04 Computable Name: SchemeInformation

Logical Model for Information on the trusted list and its issuing scheme

Usages:

  • This Logical Model is not used by any profiles in this Implementation Guide

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
.. SchemeInformation 0..* Base This is an abstract type.
Scheme Information
... versionIdentifier 1..1 integer TSL version identifier (clause 5.3.1)
... sequenceNumber 1..1 integer TSL sequence number (clause 5.3.2)
... type 1..1 uri TSL type (clause 5.3.3)
... operatorName 1..1 string Scheme operator name (clause 5.3.4)
... operatorAddress 1..* BackboneElement Scheme operator address (clause 5.3.5)
.... @id 0..1 id 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
.... operatorPostalAddress 1..* Address Scheme Operator Postal Address
.... operatorElectronicAddress 0..* ContactPoint Scheme Operator Electronic Address
... name 1..1 string Scheme name (clause 5.3.6)
... informationURI 1..1 uri Scheme information URI (clause 5.3.7)
... statusDeterminiationApproach 1..1 uri Status determination approach (clause 5.3.8)
... schemeType 1..1 uri Scheme type/community/rules (clause 5.3.9)
... territory 1..1 string Scheme territory (clause 5.3.10)
... policy 1..1 uri TSL policy/legal notice (clause 5.3.11)
... historicalInformationPeriod 1..1 integer Historical information period (clause 5.3.12)
... otherTSL 0..* string Pointers to other TSLs (clause 5.3.13)
... issDateTime 1..1 dateTime List issue date and time (clause 5.3.14)
... nextUpdate 1..1 dateTime Next update (clause 5.3.15)
... distributionPoints 0..* uri Distribution points (clause 5.3.16)
... extensions 0..* string Scheme extensions (clause 5.3.17)

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

Scheme Information API

Logical Model for Information on the trusted list and its issuing scheme

Version: 1.0.0

Endpoints

GET /StructureDefinition-SchemeInformation.schema.json

JSON Schema definition for the Logical Model StructureDefinition-SchemeInformation

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

Schema Definition

StructureDefinition-SchemeInformation

Description: Logical Model for Information on the trusted list and its issuing scheme

Type: object

Schema ID: http://smart.who.int/base/StructureDefinition-SchemeInformation.schema.json

Properties

  • resourceType (string): Resource type identifier for SchemeInformation logical model
  • versionIdentifier (integer): TSL version identifier (clause 5.3.1)
  • sequenceNumber (integer): TSL sequence number (clause 5.3.2)
  • type (string): TSL type (clause 5.3.3)
  • operatorName (string): Scheme operator name (clause 5.3.4)
  • operatorAddress (array): Scheme operator address (clause 5.3.5)
  • 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 managable, 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).
  • operatorPostalAddress (array): Scheme Operator Postal Address
  • operatorElectronicAddress (array): Scheme Operator Electronic Address
  • name (string): Scheme name (clause 5.3.6) CC:EN_name_value
  • informationURI (string): Scheme information URI (clause 5.3.7)
  • statusDeterminiationApproach (string): Status determination approach (clause 5.3.8)
  • schemeType (string): Scheme type/community/rules (clause 5.3.9)
  • territory (string): Scheme territory (clause 5.3.10)
  • policy (string): TSL policy/legal notice (clause 5.3.11)
  • historicalInformationPeriod (integer): Historical information period (clause 5.3.12)
  • otherTSL (array): Pointers to other TSLs (clause 5.3.13)
  • issDateTime (string): List issue date and time (clause 5.3.14)
  • nextUpdate (string): Next update (clause 5.3.15)
  • distributionPoints (array): Distribution points (clause 5.3.16)

Required fields: resourceType, versionIdentifier, sequenceNumber, type, operatorName, operatorAddress, operatorPostalAddress, name, informationURI, statusDeterminiationApproach, schemeType, territory, policy, historicalInformationPeriod, issDateTime, nextUpdate

Full Schema (JSON) 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-SchemeInformation.schema.json",
  "title": "Scheme Information",
  "description": "Logical Model for Information on the trusted list and its issuing scheme",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "SchemeInformation",
      "description": "Resource type identifier for SchemeInformation logical model"
    },
    "versionIdentifier": {
      "type": "integer",
      "description": "TSL version identifier (clause 5.3.1)"
    },
    "sequenceNumber": {
      "type": "integer",
      "description": "TSL sequence number (clause 5.3.2)"
    },
    "type": {
      "type": "string",
      "format": "uri",
      "description": "TSL type (clause 5.3.3)"
    },
    "operatorName": {
      "type": "string",
      "description": "Scheme operator name (clause 5.3.4)"
    },
    "operatorAddress": {
      "type": "array",
      "items": {
        "type": "object",
        "description": "FHIR BackboneElement"
      },
      "minItems": 1,
      "description": "Scheme operator address (clause 5.3.5)"
    },
    "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 managable, 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)."
    },
    "operatorPostalAddress": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "minItems": 1,
      "description": "Scheme Operator Postal Address"
    },
    "operatorElectronicAddress": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Scheme Operator Electronic Address"
    },
    "name": {
      "type": "string",
      "description": "Scheme name (clause 5.3.6) CC:EN_name_value"
    },
    "informationURI": {
      "type": "string",
      "format": "uri",
      "description": "Scheme information URI (clause 5.3.7)"
    },
    "statusDeterminiationApproach": {
      "type": "string",
      "format": "uri",
      "description": "Status determination approach (clause 5.3.8)"
    },
    "schemeType": {
      "type": "string",
      "format": "uri",
      "description": "Scheme type/community/rules (clause 5.3.9)"
    },
    "territory": {
      "type": "string",
      "description": "Scheme territory (clause 5.3.10)"
    },
    "policy": {
      "type": "string",
      "format": "uri",
      "description": "TSL policy/legal notice (clause 5.3.11)"
    },
    "historicalInformationPeriod": {
      "type": "integer",
      "description": "Historical information period (clause 5.3.12)"
    },
    "otherTSL": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Pointers to other TSLs (clause 5.3.13)"
    },
    "issDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "List issue date and time (clause 5.3.14)"
    },
    "nextUpdate": {
      "type": "string",
      "format": "date-time",
      "description": "Next update (clause 5.3.15)"
    },
    "distributionPoints": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "Distribution points (clause 5.3.16)"
    }
  },
  "required": [
    "resourceType",
    "versionIdentifier",
    "sequenceNumber",
    "type",
    "operatorName",
    "operatorAddress",
    "operatorPostalAddress",
    "name",
    "informationURI",
    "statusDeterminiationApproach",
    "schemeType",
    "territory",
    "policy",
    "historicalInformationPeriod",
    "issDateTime",
    "nextUpdate"
  ],
  "resourceDefinition": "http://smart.who.int/trust/StructureDefinition/SchemeInformation",
  "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
.. SchemeInformation 0..* Base This is an abstract type.
Scheme Information
... versionIdentifier 1..1 integer TSL version identifier (clause 5.3.1)
... sequenceNumber 1..1 integer TSL sequence number (clause 5.3.2)
... type 1..1 uri TSL type (clause 5.3.3)
... operatorName 1..1 string Scheme operator name (clause 5.3.4)
... operatorAddress 1..* BackboneElement Scheme operator address (clause 5.3.5)
.... operatorPostalAddress 1..* Address Scheme Operator Postal Address
.... operatorElectronicAddress 0..* ContactPoint Scheme Operator Electronic Address
... name 1..1 string Scheme name (clause 5.3.6)
... informationURI 1..1 uri Scheme information URI (clause 5.3.7)
... statusDeterminiationApproach 1..1 uri Status determination approach (clause 5.3.8)
... schemeType 1..1 uri Scheme type/community/rules (clause 5.3.9)
... territory 1..1 string Scheme territory (clause 5.3.10)
... policy 1..1 uri TSL policy/legal notice (clause 5.3.11)
... historicalInformationPeriod 1..1 integer Historical information period (clause 5.3.12)
... otherTSL 0..* string Pointers to other TSLs (clause 5.3.13)
... issDateTime 1..1 dateTime List issue date and time (clause 5.3.14)
... nextUpdate 1..1 dateTime Next update (clause 5.3.15)
... distributionPoints 0..* uri Distribution points (clause 5.3.16)
... extensions 0..* string Scheme extensions (clause 5.3.17)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SchemeInformation 0..* Base This is an abstract type.
Scheme Information
... versionIdentifier 1..1 integer TSL version identifier (clause 5.3.1)
... sequenceNumber 1..1 integer TSL sequence number (clause 5.3.2)
... type 1..1 uri TSL type (clause 5.3.3)
... operatorName 1..1 string Scheme operator name (clause 5.3.4)
... operatorAddress 1..* BackboneElement Scheme operator address (clause 5.3.5)
.... @id 0..1 id 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
.... operatorPostalAddress 1..* Address Scheme Operator Postal Address
.... operatorElectronicAddress 0..* ContactPoint Scheme Operator Electronic Address
... name 1..1 string Scheme name (clause 5.3.6)
... informationURI 1..1 uri Scheme information URI (clause 5.3.7)
... statusDeterminiationApproach 1..1 uri Status determination approach (clause 5.3.8)
... schemeType 1..1 uri Scheme type/community/rules (clause 5.3.9)
... territory 1..1 string Scheme territory (clause 5.3.10)
... policy 1..1 uri TSL policy/legal notice (clause 5.3.11)
... historicalInformationPeriod 1..1 integer Historical information period (clause 5.3.12)
... otherTSL 0..* string Pointers to other TSLs (clause 5.3.13)
... issDateTime 1..1 dateTime List issue date and time (clause 5.3.14)
... nextUpdate 1..1 dateTime Next update (clause 5.3.15)
... distributionPoints 0..* uri Distribution points (clause 5.3.16)
... extensions 0..* string Scheme extensions (clause 5.3.17)

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(15 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SchemeInformation 0..* Base This is an abstract type.
Scheme Information
... versionIdentifier 1..1 integer TSL version identifier (clause 5.3.1)
... sequenceNumber 1..1 integer TSL sequence number (clause 5.3.2)
... type 1..1 uri TSL type (clause 5.3.3)
... operatorName 1..1 string Scheme operator name (clause 5.3.4)
... operatorAddress 1..* BackboneElement Scheme operator address (clause 5.3.5)
.... @id 0..1 id 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
.... operatorPostalAddress 1..* Address Scheme Operator Postal Address
.... operatorElectronicAddress 0..* ContactPoint Scheme Operator Electronic Address
... name 1..1 string Scheme name (clause 5.3.6)
... informationURI 1..1 uri Scheme information URI (clause 5.3.7)
... statusDeterminiationApproach 1..1 uri Status determination approach (clause 5.3.8)
... schemeType 1..1 uri Scheme type/community/rules (clause 5.3.9)
... territory 1..1 string Scheme territory (clause 5.3.10)
... policy 1..1 uri TSL policy/legal notice (clause 5.3.11)
... historicalInformationPeriod 1..1 integer Historical information period (clause 5.3.12)
... otherTSL 0..* string Pointers to other TSLs (clause 5.3.13)
... issDateTime 1..1 dateTime List issue date and time (clause 5.3.14)
... nextUpdate 1..1 dateTime Next update (clause 5.3.15)
... distributionPoints 0..* uri Distribution points (clause 5.3.16)
... extensions 0..* string Scheme extensions (clause 5.3.17)

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
.. SchemeInformation 0..* Base This is an abstract type.
Scheme Information
... versionIdentifier 1..1 integer TSL version identifier (clause 5.3.1)
... sequenceNumber 1..1 integer TSL sequence number (clause 5.3.2)
... type 1..1 uri TSL type (clause 5.3.3)
... operatorName 1..1 string Scheme operator name (clause 5.3.4)
... operatorAddress 1..* BackboneElement Scheme operator address (clause 5.3.5)
.... operatorPostalAddress 1..* Address Scheme Operator Postal Address
.... operatorElectronicAddress 0..* ContactPoint Scheme Operator Electronic Address
... name 1..1 string Scheme name (clause 5.3.6)
... informationURI 1..1 uri Scheme information URI (clause 5.3.7)
... statusDeterminiationApproach 1..1 uri Status determination approach (clause 5.3.8)
... schemeType 1..1 uri Scheme type/community/rules (clause 5.3.9)
... territory 1..1 string Scheme territory (clause 5.3.10)
... policy 1..1 uri TSL policy/legal notice (clause 5.3.11)
... historicalInformationPeriod 1..1 integer Historical information period (clause 5.3.12)
... otherTSL 0..* string Pointers to other TSLs (clause 5.3.13)
... issDateTime 1..1 dateTime List issue date and time (clause 5.3.14)
... nextUpdate 1..1 dateTime Next update (clause 5.3.15)
... distributionPoints 0..* uri Distribution points (clause 5.3.16)
... extensions 0..* string Scheme extensions (clause 5.3.17)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SchemeInformation 0..* Base This is an abstract type.
Scheme Information
... versionIdentifier 1..1 integer TSL version identifier (clause 5.3.1)
... sequenceNumber 1..1 integer TSL sequence number (clause 5.3.2)
... type 1..1 uri TSL type (clause 5.3.3)
... operatorName 1..1 string Scheme operator name (clause 5.3.4)
... operatorAddress 1..* BackboneElement Scheme operator address (clause 5.3.5)
.... @id 0..1 id 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
.... operatorPostalAddress 1..* Address Scheme Operator Postal Address
.... operatorElectronicAddress 0..* ContactPoint Scheme Operator Electronic Address
... name 1..1 string Scheme name (clause 5.3.6)
... informationURI 1..1 uri Scheme information URI (clause 5.3.7)
... statusDeterminiationApproach 1..1 uri Status determination approach (clause 5.3.8)
... schemeType 1..1 uri Scheme type/community/rules (clause 5.3.9)
... territory 1..1 string Scheme territory (clause 5.3.10)
... policy 1..1 uri TSL policy/legal notice (clause 5.3.11)
... historicalInformationPeriod 1..1 integer Historical information period (clause 5.3.12)
... otherTSL 0..* string Pointers to other TSLs (clause 5.3.13)
... issDateTime 1..1 dateTime List issue date and time (clause 5.3.14)
... nextUpdate 1..1 dateTime Next update (clause 5.3.15)
... distributionPoints 0..* uri Distribution points (clause 5.3.16)
... extensions 0..* string Scheme extensions (clause 5.3.17)

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(15 nested mandatory elements)

 

Other representations of profile: CSV, Excel