SMART Base
0.3.0 - ci-build

SMART Base, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.3.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/ and changes regularly. See the Directory of published versions

Resource Profile: SMART Guidelines Library

Official URL: http://smart.who.int/base/StructureDefinition/SGLibrary Version: 0.3.0
Draft as of 2026-10-20 Computable Name: SGLibrary

Defines the minimum expectations for Library resources used in SMART Guidelines

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: doco
Library C 1..1 CRMIShareableLibrary Represents a library of quality improvement components
Constraints: lib-0, shr-1
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Library.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact
Library.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.version This element must be supported. This element is included in summaries. 1..1 string Business version of the library
Library.name This element must be supported. This element is included in summaries. C 1..1 string Name for this library (computer friendly)
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element must be supported. This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the library

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
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()
lib-0 warning Library Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
shr-1 error Library If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from CRMIShareableLibrary

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library 1..1 CRMIShareableLibrary Represents a library of quality improvement components
Library.name 1..1 string Name for this library (computer friendly)
Library.publisher 1..1 string Name of the publisher (organization or individual)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIShareableLibrary Represents a library of quality improvement components
Constraints: lib-0, shr-1
Library.id This element is included in summaries. 0..1 id Logical id of this artifact
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Library.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.contained 0..* Resource Contained, inline Resources
Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Library.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact
Library.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.identifier This element is included in summaries. 0..* Identifier Additional identifier for the library
Library.version This element must be supported. This element is included in summaries. 1..1 string Business version of the library
Library.name This element must be supported. This element is included in summaries. C 1..1 string Name for this library (computer friendly)
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.subtitle 0..1 string Subordinate title of the library
Library.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element must be supported. This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
Library.subject[x].subjectCodeableConcept CodeableConcept
Library.subject[x].subjectReference Reference(Group)
Library.date This element is included in summaries. 0..1 dateTime Date last changed
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Library.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the library
Library.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose 0..1 markdown Why this library is defined
Library.usage 0..1 string Describes the clinical usage of the library
Library.copyright 0..1 markdown Use and/or publishing restrictions
Library.approvalDate 0..1 date When the library was approved by publisher
Library.lastReviewDate 0..1 date When the library was last reviewed
Library.effectivePeriod This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author 0..* ContactDetail Who authored the content
Library.editor 0..* ContactDetail Who edited the content
Library.reviewer 0..* ContactDetail Who reviewed the content
Library.endorser 0..* ContactDetail Who endorsed the content
Library.relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library
Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
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()
lib-0 warning Library Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
shr-1 error Library If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from CRMIShareableLibrary

Summary

Mandatory: 2 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIShareableLibrary Represents a library of quality improvement components
Constraints: lib-0, shr-1
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.Slices for extension Content/Rules for all slices
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Library.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact
Library.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.version This element must be supported. This element is included in summaries. 1..1 string Business version of the library
Library.name This element must be supported. This element is included in summaries. C 1..1 string Name for this library (computer friendly)
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element must be supported. This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the library

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
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()
lib-0 warning Library Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
shr-1 error Library If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

Differential View

This structure is derived from CRMIShareableLibrary

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library 1..1 CRMIShareableLibrary Represents a library of quality improvement components
Library.name 1..1 string Name for this library (computer friendly)
Library.publisher 1..1 string Name of the publisher (organization or individual)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Library C 1..1 CRMIShareableLibrary Represents a library of quality improvement components
Constraints: lib-0, shr-1
Library.id This element is included in summaries. 0..1 id Logical id of this artifact
Library.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Library.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Library.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Library.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Library.contained 0..* Resource Contained, inline Resources
Library.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Library.Slices for extension.extension:knowledgeCapability This element must be supported. C 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
Library.Slices for extension.extension:versionAlgorithm This element must be supported. 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: VersionAlgorithm (extensible)
Library.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: ValueSet Artifact Version Policy (extensible): The versioning policy of the artifact
Library.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
Library.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Library.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this library, represented as a URI (globally unique)
Library.identifier This element is included in summaries. 0..* Identifier Additional identifier for the library
Library.version This element must be supported. This element is included in summaries. 1..1 string Business version of the library
Library.name This element must be supported. This element is included in summaries. C 1..1 string Name for this library (computer friendly)
Library.title This element must be supported. This element is included in summaries. 1..1 string Name for this library (human friendly)
Library.subtitle 0..1 string Subordinate title of the library
Library.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Library.experimental This element must be supported. This element is included in summaries. 0..1 boolean For testing purposes, not real usage
Library.type This element is included in summaries. 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: LibraryType (extensible): The type of knowledge asset this library contains.
Library.subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
Library.subject[x].subjectCodeableConcept CodeableConcept
Library.subject[x].subjectReference Reference(Group)
Library.date This element is included in summaries. 0..1 dateTime Date last changed
Library.publisher This element must be supported. This element is included in summaries. 1..1 string Name of the publisher (organization or individual)
Library.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
Library.description This element must be supported. This element is included in summaries. 1..1 markdown Natural language description of the library
Library.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
Library.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
Library.purpose 0..1 markdown Why this library is defined
Library.usage 0..1 string Describes the clinical usage of the library
Library.copyright 0..1 markdown Use and/or publishing restrictions
Library.approvalDate 0..1 date When the library was approved by publisher
Library.lastReviewDate 0..1 date When the library was last reviewed
Library.effectivePeriod This element is included in summaries. 0..1 Period When the library is expected to be used
Library.topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.
Library.author 0..* ContactDetail Who authored the content
Library.editor 0..* ContactDetail Who edited the content
Library.reviewer 0..* ContactDetail Who reviewed the content
Library.endorser 0..* ContactDetail Who endorsed the content
Library.relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
Library.parameter 0..* ParameterDefinition Parameters defined by the library
Library.dataRequirement 0..* DataRequirement What data is referenced by this library
Library.content This element is included in summaries. 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Library.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Library.status Base required PublicationStatus 📍4.0.1 FHIR Std.
Library.type Base extensible LibraryType 📍4.0.1 FHIR Std.
Library.subject[x] Base extensible Subject type 📍4.0.1 FHIR Std.
Library.jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
Library.topic Base example DefinitionTopic 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Library If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Library If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Library If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Library If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Library A resource should have narrative for robust management text.`div`.exists()
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()
lib-0 warning Library Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
shr-1 error Library If knowledge capabilities are stated, they SHALL include shareable extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').exists() implies extension('http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability').where(value = 'shareable').exists()

This structure is derived from CRMIShareableLibrary

Summary

Mandatory: 2 elements

 

Other representations of profile: CSV, Excel, Schematron