WHO SMART Trust
1.1.4 - CI Build International flag

This page is part of the Trust (v1.1.4: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Logical Model: SchemeInformation - Detailed Descriptions

Draft as of 2024-11-04

Definitions for the SchemeInformation logical model.

Guidance on how to interpret the contents of this table can be found here

0. SchemeInformation
Definition

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

ShortScheme Information
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SchemeInformation.versionIdentifier
Definition

TSL version identifier (clause 5.3.1)

ShortTSL version identifier (clause 5.3.1)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. SchemeInformation.sequenceNumber
Definition

TSL sequence number (clause 5.3.2)

ShortTSL sequence number (clause 5.3.2)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SchemeInformation.type
Definition

TSL type (clause 5.3.3)

ShortTSL type (clause 5.3.3)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SchemeInformation.operatorName
Definition

Scheme operator name (clause 5.3.4)

ShortScheme operator name (clause 5.3.4)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SchemeInformation.operatorAddress
Definition

Scheme operator address (clause 5.3.5)

ShortScheme operator address (clause 5.3.5)
Control1..*
TypeBackboneElement
12. SchemeInformation.operatorAddress.operatorPostalAddress
Definition

Scheme Operator Postal Address

ShortScheme Operator Postal Address
Control1..*
TypeAddress
14. SchemeInformation.operatorAddress.operatorElectronicAddress
Definition

Scheme Operator Electronic Address

ShortScheme Operator Electronic Address
Control0..*
TypeContactPoint
16. SchemeInformation.name
Definition

Scheme name (clause 5.3.6) CC:EN_name_value

ShortScheme name (clause 5.3.6)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SchemeInformation.informationURI
Definition

Scheme information URI (clause 5.3.7)

ShortScheme information URI (clause 5.3.7)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SchemeInformation.statusDeterminiationApproach
Definition

Status determination approach (clause 5.3.8)

ShortStatus determination approach (clause 5.3.8)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SchemeInformation.schemeType
Definition

Scheme type/community/rules (clause 5.3.9)

ShortScheme type/community/rules (clause 5.3.9)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SchemeInformation.territory
Definition

Scheme territory (clause 5.3.10)

ShortScheme territory (clause 5.3.10)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. SchemeInformation.policy
Definition

TSL policy/legal notice (clause 5.3.11)

ShortTSL policy/legal notice (clause 5.3.11)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. SchemeInformation.historicalInformationPeriod
Definition

Historical information period (clause 5.3.12)

ShortHistorical information period (clause 5.3.12)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. SchemeInformation.otherTSL
Definition

Pointers to other TSLs (clause 5.3.13)

ShortPointers to other TSLs (clause 5.3.13)
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. SchemeInformation.issDateTime
Definition

List issue date and time (clause 5.3.14)

ShortList issue date and time (clause 5.3.14)
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. SchemeInformation.nextUpdate
Definition

Next update (clause 5.3.15)

ShortNext update (clause 5.3.15)
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. SchemeInformation.distributionPoints
Definition

Distribution points (clause 5.3.16)

ShortDistribution points (clause 5.3.16)
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. SchemeInformation.extensions
Definition

Scheme extensions (clause 5.3.17)

ShortScheme extensions (clause 5.3.17)
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SchemeInformation
Definition

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

ShortScheme Information
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SchemeInformation.versionIdentifier
Definition

TSL version identifier (clause 5.3.1)

ShortTSL version identifier (clause 5.3.1)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. SchemeInformation.sequenceNumber
Definition

TSL sequence number (clause 5.3.2)

ShortTSL sequence number (clause 5.3.2)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SchemeInformation.type
Definition

TSL type (clause 5.3.3)

ShortTSL type (clause 5.3.3)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SchemeInformation.operatorName
Definition

Scheme operator name (clause 5.3.4)

ShortScheme operator name (clause 5.3.4)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SchemeInformation.operatorAddress
Definition

Scheme operator address (clause 5.3.5)

ShortScheme operator address (clause 5.3.5)
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. SchemeInformation.operatorAddress.modifierExtension
Definition

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

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
14. SchemeInformation.operatorAddress.operatorPostalAddress
Definition

Scheme Operator Postal Address

ShortScheme Operator Postal Address
Control1..*
TypeAddress
16. SchemeInformation.operatorAddress.operatorElectronicAddress
Definition

Scheme Operator Electronic Address

ShortScheme Operator Electronic Address
Control0..*
TypeContactPoint
18. SchemeInformation.name
Definition

Scheme name (clause 5.3.6) CC:EN_name_value

ShortScheme name (clause 5.3.6)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SchemeInformation.informationURI
Definition

Scheme information URI (clause 5.3.7)

ShortScheme information URI (clause 5.3.7)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SchemeInformation.statusDeterminiationApproach
Definition

Status determination approach (clause 5.3.8)

ShortStatus determination approach (clause 5.3.8)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SchemeInformation.schemeType
Definition

Scheme type/community/rules (clause 5.3.9)

ShortScheme type/community/rules (clause 5.3.9)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. SchemeInformation.territory
Definition

Scheme territory (clause 5.3.10)

ShortScheme territory (clause 5.3.10)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. SchemeInformation.policy
Definition

TSL policy/legal notice (clause 5.3.11)

ShortTSL policy/legal notice (clause 5.3.11)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. SchemeInformation.historicalInformationPeriod
Definition

Historical information period (clause 5.3.12)

ShortHistorical information period (clause 5.3.12)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
32. SchemeInformation.otherTSL
Definition

Pointers to other TSLs (clause 5.3.13)

ShortPointers to other TSLs (clause 5.3.13)
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. SchemeInformation.issDateTime
Definition

List issue date and time (clause 5.3.14)

ShortList issue date and time (clause 5.3.14)
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
36. SchemeInformation.nextUpdate
Definition

Next update (clause 5.3.15)

ShortNext update (clause 5.3.15)
Control1..1
TypedateTime
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
38. SchemeInformation.distributionPoints
Definition

Distribution points (clause 5.3.16)

ShortDistribution points (clause 5.3.16)
Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
40. SchemeInformation.extensions
Definition

Scheme extensions (clause 5.3.17)

ShortScheme extensions (clause 5.3.17)
Control0..*
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SchemeInformation
Definition

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

ShortScheme Information
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SchemeInformation.versionIdentifier
Definition

TSL version identifier (clause 5.3.1)

ShortTSL version identifier (clause 5.3.1)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. SchemeInformation.sequenceNumber
Definition

TSL sequence number (clause 5.3.2)

ShortTSL sequence number (clause 5.3.2)
Control1..1
Typeinteger
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SchemeInformation.type
Definition

TSL type (clause 5.3.3)

ShortTSL type (clause 5.3.3)
Control1..1
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SchemeInformation.operatorName
Definition

Scheme operator name (clause 5.3.4)

ShortScheme operator name (clause 5.3.4)
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SchemeInformation.operatorAddress
Definition

Scheme operator address (clause 5.3.5)

ShortScheme operator address (clause 5.3.5)
Control1..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. SchemeInformation.operatorAddress.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
14. SchemeInformation.operatorAddress.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SchemeInformation.operatorAddress.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. SchemeInformation.operatorAddress.modifierExtension
    Definition

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

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    18. SchemeInformation.operatorAddress.operatorPostalAddress
    Definition

    Scheme Operator Postal Address

    ShortScheme Operator Postal Address
    Control1..*
    TypeAddress
    20. SchemeInformation.operatorAddress.operatorElectronicAddress
    Definition

    Scheme Operator Electronic Address

    ShortScheme Operator Electronic Address
    Control0..*
    TypeContactPoint
    22. SchemeInformation.name
    Definition

    Scheme name (clause 5.3.6) CC:EN_name_value

    ShortScheme name (clause 5.3.6)
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. SchemeInformation.informationURI
    Definition

    Scheme information URI (clause 5.3.7)

    ShortScheme information URI (clause 5.3.7)
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    26. SchemeInformation.statusDeterminiationApproach
    Definition

    Status determination approach (clause 5.3.8)

    ShortStatus determination approach (clause 5.3.8)
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    28. SchemeInformation.schemeType
    Definition

    Scheme type/community/rules (clause 5.3.9)

    ShortScheme type/community/rules (clause 5.3.9)
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    30. SchemeInformation.territory
    Definition

    Scheme territory (clause 5.3.10)

    ShortScheme territory (clause 5.3.10)
    Control1..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    32. SchemeInformation.policy
    Definition

    TSL policy/legal notice (clause 5.3.11)

    ShortTSL policy/legal notice (clause 5.3.11)
    Control1..1
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    34. SchemeInformation.historicalInformationPeriod
    Definition

    Historical information period (clause 5.3.12)

    ShortHistorical information period (clause 5.3.12)
    Control1..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    36. SchemeInformation.otherTSL
    Definition

    Pointers to other TSLs (clause 5.3.13)

    ShortPointers to other TSLs (clause 5.3.13)
    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    38. SchemeInformation.issDateTime
    Definition

    List issue date and time (clause 5.3.14)

    ShortList issue date and time (clause 5.3.14)
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    40. SchemeInformation.nextUpdate
    Definition

    Next update (clause 5.3.15)

    ShortNext update (clause 5.3.15)
    Control1..1
    TypedateTime
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    42. SchemeInformation.distributionPoints
    Definition

    Distribution points (clause 5.3.16)

    ShortDistribution points (clause 5.3.16)
    Control0..*
    Typeuri
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    44. SchemeInformation.extensions
    Definition

    Scheme extensions (clause 5.3.17)

    ShortScheme extensions (clause 5.3.17)
    Control0..*
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension