This page is part of the Canonical Resource Management Infrastructure Implementation Guide (v1.0.0: STU1) 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

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON

Resource Profile: CRMI Shareable TerminologyCapabilities

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

Usage:

• Examples for this Resource Profile: ExampleShareableTerminologyCapabilities

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from TerminologyCapabilities

Name	Flags	Card.	Type	Description & Constraints
TerminologyCapabilities		1..1	TerminologyCapabilities	A statement of system capabilities
Slices for extension				Content/Rules for all slices
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
url	S	1..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
version	S	1..1	string	Business version of the terminology capabilities
name	S	0..1	string	Name for this terminology capabilities (computer friendly)
title	S	1..1	string	Name for this terminology capabilities (human friendly)
status	S	1..1	code	draft | active | retired | unknown
experimental	S	1..1	boolean	For testing purposes, not real usage
publisher	S	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the terminology capabilities
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
TerminologyCapabilities	C	1..1	TerminologyCapabilities	A statement of system capabilities tcp-0: Name should be usable as an identifier for the module by machine processing applications such as code generation tcp-2: A Capability Statement SHALL have at least one of description, software, or implementation element. tcp-3: If kind = instance, implementation must be present and software may be present tcp-4: If kind = capability, implementation must be absent, software must be present tcp-5: If kind = requirements, implementation and software must be absent
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the terminology capabilities
name	SΣC	0..1	string	Name for this terminology capabilities (computer friendly)
title	SΣ	1..1	string	Name for this terminology capabilities (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	SΣ	1..1	boolean	For testing purposes, not real usage
date	Σ	1..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the terminology capabilities
kind	ΣC	1..1	code	instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
implementation	ΣC	0..1	BackboneElement	If this describes a specific instance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	Σ	1..1	string	Describes this specific instance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
TerminologyCapabilities.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
TerminologyCapabilities.kind	required	CapabilityStatementKind http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
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())

Name	Flags	Card.	Type	Description & Constraints
TerminologyCapabilities	C	1..1	TerminologyCapabilities	A statement of system capabilities tcp-0: Name should be usable as an identifier for the module by machine processing applications such as code generation tcp-2: A Capability Statement SHALL have at least one of description, software, or implementation element. tcp-3: If kind = instance, implementation must be present and software may be present tcp-4: If kind = capability, implementation must be absent, software must be present tcp-5: If kind = requirements, implementation and software must be absent
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the terminology capabilities
name	SΣC	0..1	string	Name for this terminology capabilities (computer friendly)
title	SΣ	1..1	string	Name for this terminology capabilities (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	SΣ	1..1	boolean	For testing purposes, not real usage
date	Σ	1..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	S	1..1	markdown	Natural language description of the terminology capabilities
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this terminology capabilities is defined
copyright	Σ	0..1	markdown	Use and/or publishing restrictions
kind	ΣC	1..1	code	instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
software	ΣC	0..1	BackboneElement	Software that is covered by this terminology capability statement
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	A name the software is known by
version	Σ	0..1	string	Version covered by this statement
implementation	ΣC	0..1	BackboneElement	If this describes a specific instance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	Σ	1..1	string	Describes this specific instance
url	Σ	0..1	url	Base URL for the implementation
lockedDate	Σ	0..1	boolean	Whether lockedDate is supported
codeSystem	C	0..*	BackboneElement	A code system supported by the server tcp-1: If there is more than one version, a version code must be defined
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
uri		0..1	canonical(CodeSystem)	URI for the Code System
version		0..*	BackboneElement	Version of Code System supported
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	ΣC	0..1	string	Version identifier for this version
isDefault	Σ	0..1	boolean	If this is the default version for this code system
compositional		0..1	boolean	If compositional grammar is supported
language		0..*	code	Language Displays supported
filter		0..*	BackboneElement	Filter Properties supported
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	code	Code of the property supported
op		1..*	code	Operations supported for the property
property		0..*	code	Properties supported for $lookup
subsumption		0..1	boolean	Whether subsumption is supported
expansion		0..1	BackboneElement	Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hierarchical		0..1	boolean	Whether the server can return nested value sets
paging		0..1	boolean	Whether the server supports paging on expansion
incomplete		0..1	boolean	Allow request for incomplete expansions?
parameter		0..*	BackboneElement	Supported expansion parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	code	Expansion Parameter name
documentation		0..1	string	Description of support for parameter
textFilter		0..1	markdown	Documentation about text searching works
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.
validateCode		0..1	BackboneElement	Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
translations		1..1	boolean	Whether translations are validated
translation		0..1	BackboneElement	Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
needsMap		1..1	boolean	Whether the client must identify the map
closure		0..1	BackboneElement	Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
translation		0..1	boolean	If cross-system closure is supported
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
TerminologyCapabilities.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
TerminologyCapabilities.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
TerminologyCapabilities.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
TerminologyCapabilities.kind	required	CapabilityStatementKind http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 from the FHIR Standard
TerminologyCapabilities.codeSearch	required	CodeSearchSupport http://hl7.org/fhir/ValueSet/code-search-support|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
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())

This structure is derived from TerminologyCapabilities

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
• http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
• http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
• http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy

Maturity: 1

Differential View

This structure is derived from TerminologyCapabilities

Name	Flags	Card.	Type	Description & Constraints
TerminologyCapabilities		1..1	TerminologyCapabilities	A statement of system capabilities
Slices for extension				Content/Rules for all slices
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
url	S	1..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
version	S	1..1	string	Business version of the terminology capabilities
name	S	0..1	string	Name for this terminology capabilities (computer friendly)
title	S	1..1	string	Name for this terminology capabilities (human friendly)
status	S	1..1	code	draft | active | retired | unknown
experimental	S	1..1	boolean	For testing purposes, not real usage
publisher	S	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the terminology capabilities
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
TerminologyCapabilities	C	1..1	TerminologyCapabilities	A statement of system capabilities tcp-0: Name should be usable as an identifier for the module by machine processing applications such as code generation tcp-2: A Capability Statement SHALL have at least one of description, software, or implementation element. tcp-3: If kind = instance, implementation must be present and software may be present tcp-4: If kind = capability, implementation must be absent, software must be present tcp-5: If kind = requirements, implementation and software must be absent
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension				Content/Rules for all slices
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the terminology capabilities
name	SΣC	0..1	string	Name for this terminology capabilities (computer friendly)
title	SΣ	1..1	string	Name for this terminology capabilities (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	SΣ	1..1	boolean	For testing purposes, not real usage
date	Σ	1..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
description	S	1..1	markdown	Natural language description of the terminology capabilities
kind	ΣC	1..1	code	instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
implementation	ΣC	0..1	BackboneElement	If this describes a specific instance
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	Σ	1..1	string	Describes this specific instance
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
TerminologyCapabilities.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
TerminologyCapabilities.kind	required	CapabilityStatementKind http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
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())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
TerminologyCapabilities	C	1..1	TerminologyCapabilities	A statement of system capabilities tcp-0: Name should be usable as an identifier for the module by machine processing applications such as code generation tcp-2: A Capability Statement SHALL have at least one of description, software, or implementation element. tcp-3: If kind = instance, implementation must be present and software may be present tcp-4: If kind = capability, implementation must be absent, software must be present tcp-5: If kind = requirements, implementation and software must be absent
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
knowledgeCapability	S	0..*	code	shareable | computable | publishable | executable URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability Binding: KnowledgeCapability (required)
artifactComment	S	0..*	(Complex)	Additional documentation, review, or usage guidance URL: http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
versionAlgorithm	S	0..1	string, Coding	How to compare versions URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: VersionAlgorithm (extensible)
versionPolicy	S	0..1	CodeableConcept	metadata | strict URL: http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy Binding: Artifact Version Policy (extensible): The versioning policy of the artifact
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
url	SΣ	1..1	uri	Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
version	SΣ	1..1	string	Business version of the terminology capabilities
name	SΣC	0..1	string	Name for this terminology capabilities (computer friendly)
title	SΣ	1..1	string	Name for this terminology capabilities (human friendly)
status	?!SΣ	1..1	code	draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact.
experimental	SΣ	1..1	boolean	For testing purposes, not real usage
date	Σ	1..1	dateTime	Date last changed
publisher	SΣ	0..1	string	Name of the publisher (organization or individual)
contact	Σ	0..*	ContactDetail	Contact details for the publisher
description	S	1..1	markdown	Natural language description of the terminology capabilities
useContext	Σ	0..*	UsageContext	The context that the content is intended to support
jurisdiction	Σ	0..*	CodeableConcept	Intended jurisdiction for terminology capabilities (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
purpose		0..1	markdown	Why this terminology capabilities is defined
copyright	Σ	0..1	markdown	Use and/or publishing restrictions
kind	ΣC	1..1	code	instance | capability | requirements Binding: CapabilityStatementKind (required): How a capability statement is intended to be used.
software	ΣC	0..1	BackboneElement	Software that is covered by this terminology capability statement
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	A name the software is known by
version	Σ	0..1	string	Version covered by this statement
implementation	ΣC	0..1	BackboneElement	If this describes a specific instance
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
description	Σ	1..1	string	Describes this specific instance
url	Σ	0..1	url	Base URL for the implementation
lockedDate	Σ	0..1	boolean	Whether lockedDate is supported
codeSystem	C	0..*	BackboneElement	A code system supported by the server tcp-1: If there is more than one version, a version code must be defined
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
uri		0..1	canonical(CodeSystem)	URI for the Code System
version		0..*	BackboneElement	Version of Code System supported
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	ΣC	0..1	string	Version identifier for this version
isDefault	Σ	0..1	boolean	If this is the default version for this code system
compositional		0..1	boolean	If compositional grammar is supported
language		0..*	code	Language Displays supported
filter		0..*	BackboneElement	Filter Properties supported
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code		1..1	code	Code of the property supported
op		1..*	code	Operations supported for the property
property		0..*	code	Properties supported for $lookup
subsumption		0..1	boolean	Whether subsumption is supported
expansion		0..1	BackboneElement	Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
hierarchical		0..1	boolean	Whether the server can return nested value sets
paging		0..1	boolean	Whether the server supports paging on expansion
incomplete		0..1	boolean	Allow request for incomplete expansions?
parameter		0..*	BackboneElement	Supported expansion parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name		1..1	code	Expansion Parameter name
documentation		0..1	string	Description of support for parameter
textFilter		0..1	markdown	Documentation about text searching works
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.
validateCode		0..1	BackboneElement	Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
translations		1..1	boolean	Whether translations are validated
translation		0..1	BackboneElement	Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
needsMap		1..1	boolean	Whether the client must identify the map
closure		0..1	BackboneElement	Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
translation		0..1	boolean	If cross-system closure is supported
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
TerminologyCapabilities.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
TerminologyCapabilities.status	required	PublicationStatus http://hl7.org/fhir/ValueSet/publication-status|4.0.1 from the FHIR Standard
TerminologyCapabilities.jurisdiction	extensible	Jurisdiction ValueSet http://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard
TerminologyCapabilities.kind	required	CapabilityStatementKind http://hl7.org/fhir/ValueSet/capability-statement-kind|4.0.1 from the FHIR Standard
TerminologyCapabilities.codeSearch	required	CodeSearchSupport http://hl7.org/fhir/ValueSet/code-search-support|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
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())

This structure is derived from TerminologyCapabilities

Summary

Mandatory: 5 elements
Must-Support: 12 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
• http://hl7.org/fhir/StructureDefinition/cqf-artifactComment
• http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
• http://hl7.org/fhir/StructureDefinition/artifact-versionPolicy

Maturity: 1

Other representations of profile: CSV, Excel, Schematron