Content Repository Management Infrastructure Implementation Guide
3.0.0-ballot - STU 3 Ballot International flag

Content Repository Management Infrastructure Implementation Guide, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/crmi-ig/ and changes regularly. See the Directory of published versions

Resource Profile: CRMI Shareable TerminologyCapabilities

Official URL: http://hl7.org/fhir/uv/crmi/StructureDefinition/crmi-shareableterminologycapabilities Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 2 Responsible: HL7 International / Terminology Infrastructure Computable Name: CRMIShareableTerminologyCapabilities
Other Identifiers: OID:2.16.840.1.113883.4.642.40.38.42.59

Enforces the minimum information set for the terminology capabilities metadata required by HL7 and other organizations that share and publish terminology capabilities

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5, shr-1
TerminologyCapabilities.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
TerminologyCapabilities.Slices for extension Content/Rules for all slices
TerminologyCapabilities.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)
TerminologyCapabilities.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)
TerminologyCapabilities.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
TerminologyCapabilities.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
TerminologyCapabilities.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
TerminologyCapabilities.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
TerminologyCapabilities.version This element must be supported. This element is included in summaries. 1..1 string Business version of the terminology capabilities
TerminologyCapabilities.name This element must be supported. This element is included in summaries. C 0..1 string Name for this terminology capabilities (computer friendly)
TerminologyCapabilities.title This element must be supported. This element is included in summaries. 1..1 string Name for this terminology capabilities (human friendly)
TerminologyCapabilities.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.
TerminologyCapabilities.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
TerminologyCapabilities.date This element is included in summaries. 1..1 dateTime Date last changed
TerminologyCapabilities.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
TerminologyCapabilities.description This element must be supported. 1..1 markdown Natural language description of the terminology capabilities
TerminologyCapabilities.kind This element is included in summaries. C 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
TerminologyCapabilities.implementation This element is included in summaries. C 0..1 BackboneElement If this describes a specific instance
TerminologyCapabilities.implementation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.implementation.description This element is included in summaries. 1..1 string Describes this specific instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
TerminologyCapabilities.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
TerminologyCapabilities.​kind Base required CapabilityStatementKind 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error TerminologyCapabilities If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error TerminologyCapabilities 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 TerminologyCapabilities 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 TerminologyCapabilities If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice TerminologyCapabilities 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()
shr-1 error TerminologyCapabilities 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()
tcp-0 warning TerminologyCapabilities 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}')
tcp-2 error TerminologyCapabilities A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
tcp-3 error TerminologyCapabilities If kind = instance, implementation must be present and software may be present (kind != 'instance') or implementation.exists()
tcp-4 error TerminologyCapabilities If kind = capability, implementation must be absent, software must be present (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5 error TerminologyCapabilities If kind = requirements, implementation and software must be absent (kind!='requirements') or (implementation.exists().not() and software.exists().not())

This structure is derived from TerminologyCapabilities

NameFlagsCard.TypeDescription & Constraints    Filter: doco
TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: shr-1
TerminologyCapabilities.Slices for extension Content/Rules for all slices
TerminologyCapabilities.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)
TerminologyCapabilities.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)
TerminologyCapabilities.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
TerminologyCapabilities.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
TerminologyCapabilities.url This element must be supported. 1..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
TerminologyCapabilities.version This element must be supported. 1..1 string Business version of the terminology capabilities
TerminologyCapabilities.title This element must be supported. 1..1 string Name for this terminology capabilities (human friendly)
TerminologyCapabilities.status This element must be supported. 1..1 code draft | active | retired | unknown
TerminologyCapabilities.experimental This element must be supported. 1..1 boolean For testing purposes, not real usage
TerminologyCapabilities.publisher This element must be supported. 0..1 string Name of the publisher (organization or individual)
TerminologyCapabilities.description This element must be supported. 1..1 markdown Natural language description of the terminology capabilities

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error TerminologyCapabilities 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()
NameFlagsCard.TypeDescription & Constraints    Filter: doco
TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5, shr-1
TerminologyCapabilities.id This element is included in summaries. 0..1 id Logical id of this artifact
TerminologyCapabilities.meta This element is included in summaries. 0..1 Meta Metadata about the resource
TerminologyCapabilities.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
TerminologyCapabilities.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
TerminologyCapabilities.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
TerminologyCapabilities.contained 0..* Resource Contained, inline Resources
TerminologyCapabilities.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
TerminologyCapabilities.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)
TerminologyCapabilities.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)
TerminologyCapabilities.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
TerminologyCapabilities.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
TerminologyCapabilities.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
TerminologyCapabilities.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
TerminologyCapabilities.version This element must be supported. This element is included in summaries. 1..1 string Business version of the terminology capabilities
TerminologyCapabilities.name This element must be supported. This element is included in summaries. C 0..1 string Name for this terminology capabilities (computer friendly)
TerminologyCapabilities.title This element must be supported. This element is included in summaries. 1..1 string Name for this terminology capabilities (human friendly)
TerminologyCapabilities.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.
TerminologyCapabilities.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
TerminologyCapabilities.date This element is included in summaries. 1..1 dateTime Date last changed
TerminologyCapabilities.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
TerminologyCapabilities.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
TerminologyCapabilities.description This element must be supported. 1..1 markdown Natural language description of the terminology capabilities
TerminologyCapabilities.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
TerminologyCapabilities.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
TerminologyCapabilities.purpose 0..1 markdown Why this terminology capabilities is defined
TerminologyCapabilities.copyright This element is included in summaries. 0..1 markdown Use and/or publishing restrictions
TerminologyCapabilities.kind This element is included in summaries. C 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
TerminologyCapabilities.software This element is included in summaries. C 0..1 BackboneElement Software that is covered by this terminology capability statement
TerminologyCapabilities.software.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.software.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.software.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.software.name This element is included in summaries. 1..1 string A name the software is known by
TerminologyCapabilities.software.version This element is included in summaries. 0..1 string Version covered by this statement
TerminologyCapabilities.implementation This element is included in summaries. C 0..1 BackboneElement If this describes a specific instance
TerminologyCapabilities.implementation.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.implementation.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.implementation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.implementation.description This element is included in summaries. 1..1 string Describes this specific instance
TerminologyCapabilities.implementation.url This element is included in summaries. 0..1 url Base URL for the implementation
TerminologyCapabilities.lockedDate This element is included in summaries. 0..1 boolean Whether lockedDate is supported
TerminologyCapabilities.codeSystem C 0..* BackboneElement A code system supported by the server
Constraints: tcp-1
TerminologyCapabilities.codeSystem.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.codeSystem.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.codeSystem.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.codeSystem.uri 0..1 canonical(CodeSystem) URI for the Code System
TerminologyCapabilities.codeSystem.version 0..* BackboneElement Version of Code System supported
TerminologyCapabilities.codeSystem.version.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.codeSystem.version.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.codeSystem.version.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.codeSystem.version.code This element is included in summaries. C 0..1 string Version identifier for this version
TerminologyCapabilities.codeSystem.version.isDefault This element is included in summaries. 0..1 boolean If this is the default version for this code system
TerminologyCapabilities.codeSystem.version.compositional 0..1 boolean If compositional grammar is supported
TerminologyCapabilities.codeSystem.version.language 0..* code Language Displays supported
TerminologyCapabilities.codeSystem.version.filter 0..* BackboneElement Filter Properties supported
TerminologyCapabilities.codeSystem.version.filter.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.codeSystem.version.filter.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.codeSystem.version.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.codeSystem.version.filter.code 1..1 code Code of the property supported
TerminologyCapabilities.codeSystem.version.filter.op 1..* code Operations supported for the property
TerminologyCapabilities.codeSystem.version.property 0..* code Properties supported for $lookup
TerminologyCapabilities.codeSystem.subsumption 0..1 boolean Whether subsumption is supported
TerminologyCapabilities.expansion 0..1 BackboneElement Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
TerminologyCapabilities.expansion.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.expansion.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.expansion.hierarchical 0..1 boolean Whether the server can return nested value sets
TerminologyCapabilities.expansion.paging 0..1 boolean Whether the server supports paging on expansion
TerminologyCapabilities.expansion.incomplete 0..1 boolean Allow request for incomplete expansions?
TerminologyCapabilities.expansion.parameter 0..* BackboneElement Supported expansion parameter
TerminologyCapabilities.expansion.parameter.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.expansion.parameter.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.expansion.parameter.name 1..1 code Expansion Parameter name
TerminologyCapabilities.expansion.parameter.documentation 0..1 string Description of support for parameter
TerminologyCapabilities.expansion.textFilter 0..1 markdown Documentation about text searching works
TerminologyCapabilities.codeSearch 0..1 code explicit | all
Binding: CodeSearchSupport (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported.
TerminologyCapabilities.validateCode 0..1 BackboneElement Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
TerminologyCapabilities.validateCode.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.validateCode.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.validateCode.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.validateCode.translations 1..1 boolean Whether translations are validated
TerminologyCapabilities.translation 0..1 BackboneElement Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
TerminologyCapabilities.translation.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.translation.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.translation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.translation.needsMap 1..1 boolean Whether the client must identify the map
TerminologyCapabilities.closure 0..1 BackboneElement Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
TerminologyCapabilities.closure.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.closure.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.closure.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.closure.translation 0..1 boolean If cross-system closure is supported

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
TerminologyCapabilities.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
TerminologyCapabilities.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
TerminologyCapabilities.​jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
TerminologyCapabilities.​kind Base required CapabilityStatementKind 📍4.0.1 FHIR Std.
TerminologyCapabilities.​codeSearch Base required CodeSearchSupport 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error TerminologyCapabilities If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error TerminologyCapabilities 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 TerminologyCapabilities 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 TerminologyCapabilities If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice TerminologyCapabilities 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()
shr-1 error TerminologyCapabilities 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()
tcp-0 warning TerminologyCapabilities 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}')
tcp-1 error TerminologyCapabilities.codeSystem If there is more than one version, a version code must be defined version.count() > 1 implies version.all(code.exists())
tcp-2 error TerminologyCapabilities A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
tcp-3 error TerminologyCapabilities If kind = instance, implementation must be present and software may be present (kind != 'instance') or implementation.exists()
tcp-4 error TerminologyCapabilities If kind = capability, implementation must be absent, software must be present (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5 error TerminologyCapabilities If kind = requirements, implementation and software must be absent (kind!='requirements') or (implementation.exists().not() and software.exists().not())

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5, shr-1
TerminologyCapabilities.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
TerminologyCapabilities.Slices for extension Content/Rules for all slices
TerminologyCapabilities.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)
TerminologyCapabilities.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)
TerminologyCapabilities.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
TerminologyCapabilities.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
TerminologyCapabilities.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
TerminologyCapabilities.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
TerminologyCapabilities.version This element must be supported. This element is included in summaries. 1..1 string Business version of the terminology capabilities
TerminologyCapabilities.name This element must be supported. This element is included in summaries. C 0..1 string Name for this terminology capabilities (computer friendly)
TerminologyCapabilities.title This element must be supported. This element is included in summaries. 1..1 string Name for this terminology capabilities (human friendly)
TerminologyCapabilities.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.
TerminologyCapabilities.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
TerminologyCapabilities.date This element is included in summaries. 1..1 dateTime Date last changed
TerminologyCapabilities.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
TerminologyCapabilities.description This element must be supported. 1..1 markdown Natural language description of the terminology capabilities
TerminologyCapabilities.kind This element is included in summaries. C 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
TerminologyCapabilities.implementation This element is included in summaries. C 0..1 BackboneElement If this describes a specific instance
TerminologyCapabilities.implementation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.implementation.description This element is included in summaries. 1..1 string Describes this specific instance

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
TerminologyCapabilities.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
TerminologyCapabilities.​kind Base required CapabilityStatementKind 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error TerminologyCapabilities If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error TerminologyCapabilities 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 TerminologyCapabilities 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 TerminologyCapabilities If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice TerminologyCapabilities 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()
shr-1 error TerminologyCapabilities 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()
tcp-0 warning TerminologyCapabilities 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}')
tcp-2 error TerminologyCapabilities A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
tcp-3 error TerminologyCapabilities If kind = instance, implementation must be present and software may be present (kind != 'instance') or implementation.exists()
tcp-4 error TerminologyCapabilities If kind = capability, implementation must be absent, software must be present (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5 error TerminologyCapabilities If kind = requirements, implementation and software must be absent (kind!='requirements') or (implementation.exists().not() and software.exists().not())

Differential View

This structure is derived from TerminologyCapabilities

NameFlagsCard.TypeDescription & Constraints    Filter: doco
TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: shr-1
TerminologyCapabilities.Slices for extension Content/Rules for all slices
TerminologyCapabilities.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)
TerminologyCapabilities.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)
TerminologyCapabilities.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
TerminologyCapabilities.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
TerminologyCapabilities.url This element must be supported. 1..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
TerminologyCapabilities.version This element must be supported. 1..1 string Business version of the terminology capabilities
TerminologyCapabilities.name This element must be supported. 0..1 string Name for this terminology capabilities (computer friendly)
TerminologyCapabilities.title This element must be supported. 1..1 string Name for this terminology capabilities (human friendly)
TerminologyCapabilities.status This element must be supported. 1..1 code draft | active | retired | unknown
TerminologyCapabilities.experimental This element must be supported. 1..1 boolean For testing purposes, not real usage
TerminologyCapabilities.publisher This element must be supported. 0..1 string Name of the publisher (organization or individual)
TerminologyCapabilities.description This element must be supported. 1..1 markdown Natural language description of the terminology capabilities

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
shr-1 error TerminologyCapabilities 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()

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5, shr-1
TerminologyCapabilities.id This element is included in summaries. 0..1 id Logical id of this artifact
TerminologyCapabilities.meta This element is included in summaries. 0..1 Meta Metadata about the resource
TerminologyCapabilities.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
TerminologyCapabilities.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
TerminologyCapabilities.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
TerminologyCapabilities.contained 0..* Resource Contained, inline Resources
TerminologyCapabilities.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
TerminologyCapabilities.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)
TerminologyCapabilities.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)
TerminologyCapabilities.Slices for extension.extension:versionPolicy 0..1 CodeableConcept metadata | strict
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy
Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
TerminologyCapabilities.Slices for extension.extension:webSource This element must be supported. 0..1 url web-source
URL: http://hl7.org/fhir/StructureDefinition/web-source
TerminologyCapabilities.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
TerminologyCapabilities.url This element must be supported. This element is included in summaries. 1..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
TerminologyCapabilities.version This element must be supported. This element is included in summaries. 1..1 string Business version of the terminology capabilities
TerminologyCapabilities.name This element must be supported. This element is included in summaries. C 0..1 string Name for this terminology capabilities (computer friendly)
TerminologyCapabilities.title This element must be supported. This element is included in summaries. 1..1 string Name for this terminology capabilities (human friendly)
TerminologyCapabilities.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.
TerminologyCapabilities.experimental This element must be supported. This element is included in summaries. 1..1 boolean For testing purposes, not real usage
TerminologyCapabilities.date This element is included in summaries. 1..1 dateTime Date last changed
TerminologyCapabilities.publisher This element must be supported. This element is included in summaries. 0..1 string Name of the publisher (organization or individual)
TerminologyCapabilities.contact This element is included in summaries. 0..* ContactDetail Contact details for the publisher
TerminologyCapabilities.description This element must be supported. 1..1 markdown Natural language description of the terminology capabilities
TerminologyCapabilities.useContext This element is included in summaries. 0..* UsageContext The context that the content is intended to support
TerminologyCapabilities.jurisdiction This element is included in summaries. 0..* CodeableConcept Intended jurisdiction for terminology capabilities (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
TerminologyCapabilities.purpose 0..1 markdown Why this terminology capabilities is defined
TerminologyCapabilities.copyright This element is included in summaries. 0..1 markdown Use and/or publishing restrictions
TerminologyCapabilities.kind This element is included in summaries. C 1..1 code instance | capability | requirements
Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
TerminologyCapabilities.software This element is included in summaries. C 0..1 BackboneElement Software that is covered by this terminology capability statement
TerminologyCapabilities.software.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.software.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.software.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.software.name This element is included in summaries. 1..1 string A name the software is known by
TerminologyCapabilities.software.version This element is included in summaries. 0..1 string Version covered by this statement
TerminologyCapabilities.implementation This element is included in summaries. C 0..1 BackboneElement If this describes a specific instance
TerminologyCapabilities.implementation.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.implementation.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.implementation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.implementation.description This element is included in summaries. 1..1 string Describes this specific instance
TerminologyCapabilities.implementation.url This element is included in summaries. 0..1 url Base URL for the implementation
TerminologyCapabilities.lockedDate This element is included in summaries. 0..1 boolean Whether lockedDate is supported
TerminologyCapabilities.codeSystem C 0..* BackboneElement A code system supported by the server
Constraints: tcp-1
TerminologyCapabilities.codeSystem.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.codeSystem.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.codeSystem.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.codeSystem.uri 0..1 canonical(CodeSystem) URI for the Code System
TerminologyCapabilities.codeSystem.version 0..* BackboneElement Version of Code System supported
TerminologyCapabilities.codeSystem.version.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.codeSystem.version.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.codeSystem.version.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.codeSystem.version.code This element is included in summaries. C 0..1 string Version identifier for this version
TerminologyCapabilities.codeSystem.version.isDefault This element is included in summaries. 0..1 boolean If this is the default version for this code system
TerminologyCapabilities.codeSystem.version.compositional 0..1 boolean If compositional grammar is supported
TerminologyCapabilities.codeSystem.version.language 0..* code Language Displays supported
TerminologyCapabilities.codeSystem.version.filter 0..* BackboneElement Filter Properties supported
TerminologyCapabilities.codeSystem.version.filter.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.codeSystem.version.filter.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.codeSystem.version.filter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.codeSystem.version.filter.code 1..1 code Code of the property supported
TerminologyCapabilities.codeSystem.version.filter.op 1..* code Operations supported for the property
TerminologyCapabilities.codeSystem.version.property 0..* code Properties supported for $lookup
TerminologyCapabilities.codeSystem.subsumption 0..1 boolean Whether subsumption is supported
TerminologyCapabilities.expansion 0..1 BackboneElement Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
TerminologyCapabilities.expansion.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.expansion.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.expansion.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.expansion.hierarchical 0..1 boolean Whether the server can return nested value sets
TerminologyCapabilities.expansion.paging 0..1 boolean Whether the server supports paging on expansion
TerminologyCapabilities.expansion.incomplete 0..1 boolean Allow request for incomplete expansions?
TerminologyCapabilities.expansion.parameter 0..* BackboneElement Supported expansion parameter
TerminologyCapabilities.expansion.parameter.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.expansion.parameter.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.expansion.parameter.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.expansion.parameter.name 1..1 code Expansion Parameter name
TerminologyCapabilities.expansion.parameter.documentation 0..1 string Description of support for parameter
TerminologyCapabilities.expansion.textFilter 0..1 markdown Documentation about text searching works
TerminologyCapabilities.codeSearch 0..1 code explicit | all
Binding: CodeSearchSupport (required): The degree to which the server supports the code search parameter on ValueSet, if it is supported.
TerminologyCapabilities.validateCode 0..1 BackboneElement Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
TerminologyCapabilities.validateCode.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.validateCode.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.validateCode.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.validateCode.translations 1..1 boolean Whether translations are validated
TerminologyCapabilities.translation 0..1 BackboneElement Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
TerminologyCapabilities.translation.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.translation.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.translation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.translation.needsMap 1..1 boolean Whether the client must identify the map
TerminologyCapabilities.closure 0..1 BackboneElement Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
TerminologyCapabilities.closure.id 0..1 string Unique id for inter-element referencing
TerminologyCapabilities.closure.extension 0..* Extension Additional content defined by implementations
TerminologyCapabilities.closure.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
TerminologyCapabilities.closure.translation 0..1 boolean If cross-system closure is supported

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
TerminologyCapabilities.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
TerminologyCapabilities.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
TerminologyCapabilities.​jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
TerminologyCapabilities.​kind Base required CapabilityStatementKind 📍4.0.1 FHIR Std.
TerminologyCapabilities.​codeSearch Base required CodeSearchSupport 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error TerminologyCapabilities If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error TerminologyCapabilities 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 TerminologyCapabilities 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 TerminologyCapabilities If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice TerminologyCapabilities 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()
shr-1 error TerminologyCapabilities 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()
tcp-0 warning TerminologyCapabilities 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}')
tcp-1 error TerminologyCapabilities.codeSystem If there is more than one version, a version code must be defined version.count() > 1 implies version.all(code.exists())
tcp-2 error TerminologyCapabilities A Capability Statement SHALL have at least one of description, software, or implementation element. (description.count() + software.count() + implementation.count()) > 0
tcp-3 error TerminologyCapabilities If kind = instance, implementation must be present and software may be present (kind != 'instance') or implementation.exists()
tcp-4 error TerminologyCapabilities If kind = capability, implementation must be absent, software must be present (kind != 'capability') or (implementation.exists().not() and software.exists())
tcp-5 error TerminologyCapabilities If kind = requirements, implementation and software must be absent (kind!='requirements') or (implementation.exists().not() and software.exists().not())

 

Other representations of profile: CSV, Excel, Schematron