Canonical Resource Management Infrastructure Implementation Guide
2.0.0-ballot - STU 2 - Ballot International flag

Canonical Resource 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 2.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: 2.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 of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:versionAlgorithm S 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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

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()
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: Filtersdoco
.. TerminologyCapabilities 1..1 TerminologyCapabilities A statement of system capabilities
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:versionAlgorithm S 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... 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
... 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
... 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:versionAlgorithm S 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... 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
... 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
Constraints: tcp-1
.... 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

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()
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: Filtersdoco
.. TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:versionAlgorithm S 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... 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
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... 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

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()
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: Filtersdoco
.. TerminologyCapabilities 1..1 TerminologyCapabilities A statement of system capabilities
... Slices for extension Content/Rules for all slices
.... extension:knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:versionAlgorithm S 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... 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
... 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
... 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

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities C 1..1 TerminologyCapabilities A statement of system capabilities
Constraints: tcp-0, tcp-2, tcp-3, tcp-4, tcp-5
... 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 BindingsPurpose
AllLanguages Max Binding
... 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
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:knowledgeCapability S 0..* code shareable | computable | publishable | executable
URL: http://hl7.org/fhir/StructureDefinition/cqf-knowledgeCapability
Binding: KnowledgeCapability (required)
.... extension:versionAlgorithm S 0..1 Coding How to compare versions
URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm
Binding: version-algorithm (??) (extensible)
.... 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
... 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
Constraints: tcp-1
.... 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

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

 

Other representations of profile: CSV, Excel, Schematron