Extensions for Using Data Elements from FHIR R4B in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_TerminologyCapabilities_R5

Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-TerminologyCapabilities Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4B_TerminologyCapabilities_R5

This cross-version profile allows R4B TerminologyCapabilities content to be represented via FHIR R5 TerminologyCapabilities resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

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 0..* TerminologyCapabilities(5.0.0) A statement of system capabilities
Constraints: cnl-0, tcp-2, tcp-3, tcp-4, tcp-5, tcp-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... date Σ 1..1 dateTime Date last changed
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 1..1 string A name the software is known by
... implementation ΣC 0..1 BackboneElement If this describes a specific instance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 📍5.0.0 FHIR Std.
TerminologyCapabilities.​kind Base required Capability Statement Kind 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning TerminologyCapabilities Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1 error TerminologyCapabilities.implicitRules, TerminologyCapabilities.modifierExtension, TerminologyCapabilities.status, TerminologyCapabilities.date, TerminologyCapabilities.kind, TerminologyCapabilities.software, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.software.name, TerminologyCapabilities.implementation, TerminologyCapabilities.implementation.modifierExtension, TerminologyCapabilities.implementation.description All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error TerminologyCapabilities.modifierExtension, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.implementation.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
tcp-2 error TerminologyCapabilities A Terminology 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())
tcp-6 error TerminologyCapabilities Each instance of the codeSystem element must represent a distinct code system. codeSystem.uri.isDistinct()

This structure is derived from TerminologyCapabilities

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities 0..* TerminologyCapabilities(5.0.0) A statement of system capabilities

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities C 0..* TerminologyCapabilities(5.0.0) A statement of system capabilities
Constraints: cnl-0, tcp-2, tcp-3, tcp-4, tcp-5, tcp-6
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 0..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the terminology capabilities
... version Σ 0..1 string Business version of the terminology capabilities
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this terminology capabilities (computer friendly)
... title Σ 0..1 string Name for this terminology capabilities (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description C 0..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: JurisdictionValueSet (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
... copyrightLabel 0..1 string Copyright holder and year(s)
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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, tcp-7, tcp-8
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... uri C 0..1 canonical(CodeSystem) Canonical identifier for the code system, represented as a URI
.... version C 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code ΣC 0..1 string Version identifier for this version
..... isDefault ΣC 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
Binding: CommonLanguages (required): IETF language tag
..... filter 0..* BackboneElement Filter Properties supported
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
...... code 1..1 code Code of the property supported
...... op 1..* code Operations supported for the property
..... property 0..* code Properties supported for $lookup
.... content Σ 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... name 1..1 code Name of the supported expansion parameter
..... documentation 0..1 string Description of support for parameter
.... textFilter 0..1 markdown Documentation about text searching works
... codeSearch 0..1 code in-compose | in-expansion | in-compose-or-expansion
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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 required All Languages 📍5.0.0 FHIR Std.
TerminologyCapabilities.​versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
TerminologyCapabilities.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
TerminologyCapabilities.​jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
TerminologyCapabilities.​kind Base required Capability Statement Kind 📍5.0.0 FHIR Std.
TerminologyCapabilities.​codeSystem.version.language Base required Common Languages 📍5.0.0 FHIR Std.
TerminologyCapabilities.​codeSystem.content Base required Code System Content Mode 📍5.0.0 FHIR Std.
TerminologyCapabilities.​codeSearch Base required Code Search Support 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning TerminologyCapabilities Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning TerminologyCapabilities.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error TerminologyCapabilities.meta, TerminologyCapabilities.implicitRules, TerminologyCapabilities.language, TerminologyCapabilities.text, TerminologyCapabilities.extension, TerminologyCapabilities.modifierExtension, TerminologyCapabilities.url, TerminologyCapabilities.identifier, TerminologyCapabilities.version, TerminologyCapabilities.versionAlgorithm[x], TerminologyCapabilities.name, TerminologyCapabilities.title, TerminologyCapabilities.status, TerminologyCapabilities.experimental, TerminologyCapabilities.date, TerminologyCapabilities.publisher, TerminologyCapabilities.contact, TerminologyCapabilities.description, TerminologyCapabilities.useContext, TerminologyCapabilities.jurisdiction, TerminologyCapabilities.purpose, TerminologyCapabilities.copyright, TerminologyCapabilities.copyrightLabel, TerminologyCapabilities.kind, TerminologyCapabilities.software, TerminologyCapabilities.software.extension, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.software.name, TerminologyCapabilities.software.version, TerminologyCapabilities.implementation, TerminologyCapabilities.implementation.extension, TerminologyCapabilities.implementation.modifierExtension, TerminologyCapabilities.implementation.description, TerminologyCapabilities.implementation.url, TerminologyCapabilities.lockedDate, TerminologyCapabilities.codeSystem, TerminologyCapabilities.codeSystem.extension, TerminologyCapabilities.codeSystem.modifierExtension, TerminologyCapabilities.codeSystem.uri, TerminologyCapabilities.codeSystem.version, TerminologyCapabilities.codeSystem.version.extension, TerminologyCapabilities.codeSystem.version.modifierExtension, TerminologyCapabilities.codeSystem.version.code, TerminologyCapabilities.codeSystem.version.isDefault, TerminologyCapabilities.codeSystem.version.compositional, TerminologyCapabilities.codeSystem.version.language, TerminologyCapabilities.codeSystem.version.filter, TerminologyCapabilities.codeSystem.version.filter.extension, TerminologyCapabilities.codeSystem.version.filter.modifierExtension, TerminologyCapabilities.codeSystem.version.filter.code, TerminologyCapabilities.codeSystem.version.filter.op, TerminologyCapabilities.codeSystem.version.property, TerminologyCapabilities.codeSystem.content, TerminologyCapabilities.codeSystem.subsumption, TerminologyCapabilities.expansion, TerminologyCapabilities.expansion.extension, TerminologyCapabilities.expansion.modifierExtension, TerminologyCapabilities.expansion.hierarchical, TerminologyCapabilities.expansion.paging, TerminologyCapabilities.expansion.incomplete, TerminologyCapabilities.expansion.parameter, TerminologyCapabilities.expansion.parameter.extension, TerminologyCapabilities.expansion.parameter.modifierExtension, TerminologyCapabilities.expansion.parameter.name, TerminologyCapabilities.expansion.parameter.documentation, TerminologyCapabilities.expansion.textFilter, TerminologyCapabilities.codeSearch, TerminologyCapabilities.validateCode, TerminologyCapabilities.validateCode.extension, TerminologyCapabilities.validateCode.modifierExtension, TerminologyCapabilities.validateCode.translations, TerminologyCapabilities.translation, TerminologyCapabilities.translation.extension, TerminologyCapabilities.translation.modifierExtension, TerminologyCapabilities.translation.needsMap, TerminologyCapabilities.closure, TerminologyCapabilities.closure.extension, TerminologyCapabilities.closure.modifierExtension, TerminologyCapabilities.closure.translation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error TerminologyCapabilities.extension, TerminologyCapabilities.modifierExtension, TerminologyCapabilities.software.extension, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.implementation.extension, TerminologyCapabilities.implementation.modifierExtension, TerminologyCapabilities.codeSystem.extension, TerminologyCapabilities.codeSystem.modifierExtension, TerminologyCapabilities.codeSystem.version.extension, TerminologyCapabilities.codeSystem.version.modifierExtension, TerminologyCapabilities.codeSystem.version.filter.extension, TerminologyCapabilities.codeSystem.version.filter.modifierExtension, TerminologyCapabilities.expansion.extension, TerminologyCapabilities.expansion.modifierExtension, TerminologyCapabilities.expansion.parameter.extension, TerminologyCapabilities.expansion.parameter.modifierExtension, TerminologyCapabilities.validateCode.extension, TerminologyCapabilities.validateCode.modifierExtension, TerminologyCapabilities.translation.extension, TerminologyCapabilities.translation.modifierExtension, TerminologyCapabilities.closure.extension, TerminologyCapabilities.closure.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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 Terminology 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())
tcp-6 error TerminologyCapabilities Each instance of the codeSystem element must represent a distinct code system. codeSystem.uri.isDistinct()
tcp-7 error TerminologyCapabilities.codeSystem Each version.code element must be distinct for a particular code system. version.code.isDistinct()
tcp-8 error TerminologyCapabilities.codeSystem A codeSystem element instance may have at most one version.isDefault element with a value of 'true'. version.where(isDefault = true).count() <= 1

This structure is derived from TerminologyCapabilities

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities C 0..* TerminologyCapabilities(5.0.0) A statement of system capabilities
Constraints: cnl-0, tcp-2, tcp-3, tcp-4, tcp-5, tcp-6
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... date Σ 1..1 dateTime Date last changed
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 1..1 string A name the software is known by
... implementation ΣC 0..1 BackboneElement If this describes a specific instance
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 📍5.0.0 FHIR Std.
TerminologyCapabilities.​kind Base required Capability Statement Kind 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning TerminologyCapabilities Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
ele-1 error TerminologyCapabilities.implicitRules, TerminologyCapabilities.modifierExtension, TerminologyCapabilities.status, TerminologyCapabilities.date, TerminologyCapabilities.kind, TerminologyCapabilities.software, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.software.name, TerminologyCapabilities.implementation, TerminologyCapabilities.implementation.modifierExtension, TerminologyCapabilities.implementation.description All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error TerminologyCapabilities.modifierExtension, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.implementation.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
tcp-2 error TerminologyCapabilities A Terminology 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())
tcp-6 error TerminologyCapabilities Each instance of the codeSystem element must represent a distinct code system. codeSystem.uri.isDistinct()

Differential View

This structure is derived from TerminologyCapabilities

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities 0..* TerminologyCapabilities(5.0.0) A statement of system capabilities

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. TerminologyCapabilities C 0..* TerminologyCapabilities(5.0.0) A statement of system capabilities
Constraints: cnl-0, tcp-2, tcp-3, tcp-4, tcp-5, tcp-6
... 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: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... 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
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 0..1 uri Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the terminology capabilities
... version Σ 0..1 string Business version of the terminology capabilities
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this terminology capabilities (computer friendly)
... title Σ 0..1 string Name for this terminology capabilities (human friendly)
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 1..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description C 0..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: JurisdictionValueSet (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
... copyrightLabel 0..1 string Copyright holder and year(s)
... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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, tcp-7, tcp-8
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... uri C 0..1 canonical(CodeSystem) Canonical identifier for the code system, represented as a URI
.... version C 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... code ΣC 0..1 string Version identifier for this version
..... isDefault ΣC 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
Binding: CommonLanguages (required): IETF language tag
..... filter 0..* BackboneElement Filter Properties supported
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
...... code 1..1 code Code of the property supported
...... op 1..* code Operations supported for the property
..... property 0..* code Properties supported for $lookup
.... content Σ 1..1 code not-present | example | fragment | complete | supplement
Binding: CodeSystemContentMode (required): The extent of the content of the code system (the concepts and codes it defines) are represented in a code system resource.
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
..... name 1..1 code Name of the supported expansion parameter
..... documentation 0..1 string Description of support for parameter
.... textFilter 0..1 markdown Documentation about text searching works
... codeSearch 0..1 code in-compose | in-expansion | in-compose-or-expansion
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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... 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 required All Languages 📍5.0.0 FHIR Std.
TerminologyCapabilities.​versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
TerminologyCapabilities.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
TerminologyCapabilities.​jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
TerminologyCapabilities.​kind Base required Capability Statement Kind 📍5.0.0 FHIR Std.
TerminologyCapabilities.​codeSystem.version.language Base required Common Languages 📍5.0.0 FHIR Std.
TerminologyCapabilities.​codeSystem.content Base required Code System Content Mode 📍5.0.0 FHIR Std.
TerminologyCapabilities.​codeSearch Base required Code Search Support 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning TerminologyCapabilities Name should be usable as an identifier for the module by machine processing applications such as code generation name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$')
cnl-1 warning TerminologyCapabilities.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error TerminologyCapabilities.meta, TerminologyCapabilities.implicitRules, TerminologyCapabilities.language, TerminologyCapabilities.text, TerminologyCapabilities.extension, TerminologyCapabilities.modifierExtension, TerminologyCapabilities.url, TerminologyCapabilities.identifier, TerminologyCapabilities.version, TerminologyCapabilities.versionAlgorithm[x], TerminologyCapabilities.name, TerminologyCapabilities.title, TerminologyCapabilities.status, TerminologyCapabilities.experimental, TerminologyCapabilities.date, TerminologyCapabilities.publisher, TerminologyCapabilities.contact, TerminologyCapabilities.description, TerminologyCapabilities.useContext, TerminologyCapabilities.jurisdiction, TerminologyCapabilities.purpose, TerminologyCapabilities.copyright, TerminologyCapabilities.copyrightLabel, TerminologyCapabilities.kind, TerminologyCapabilities.software, TerminologyCapabilities.software.extension, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.software.name, TerminologyCapabilities.software.version, TerminologyCapabilities.implementation, TerminologyCapabilities.implementation.extension, TerminologyCapabilities.implementation.modifierExtension, TerminologyCapabilities.implementation.description, TerminologyCapabilities.implementation.url, TerminologyCapabilities.lockedDate, TerminologyCapabilities.codeSystem, TerminologyCapabilities.codeSystem.extension, TerminologyCapabilities.codeSystem.modifierExtension, TerminologyCapabilities.codeSystem.uri, TerminologyCapabilities.codeSystem.version, TerminologyCapabilities.codeSystem.version.extension, TerminologyCapabilities.codeSystem.version.modifierExtension, TerminologyCapabilities.codeSystem.version.code, TerminologyCapabilities.codeSystem.version.isDefault, TerminologyCapabilities.codeSystem.version.compositional, TerminologyCapabilities.codeSystem.version.language, TerminologyCapabilities.codeSystem.version.filter, TerminologyCapabilities.codeSystem.version.filter.extension, TerminologyCapabilities.codeSystem.version.filter.modifierExtension, TerminologyCapabilities.codeSystem.version.filter.code, TerminologyCapabilities.codeSystem.version.filter.op, TerminologyCapabilities.codeSystem.version.property, TerminologyCapabilities.codeSystem.content, TerminologyCapabilities.codeSystem.subsumption, TerminologyCapabilities.expansion, TerminologyCapabilities.expansion.extension, TerminologyCapabilities.expansion.modifierExtension, TerminologyCapabilities.expansion.hierarchical, TerminologyCapabilities.expansion.paging, TerminologyCapabilities.expansion.incomplete, TerminologyCapabilities.expansion.parameter, TerminologyCapabilities.expansion.parameter.extension, TerminologyCapabilities.expansion.parameter.modifierExtension, TerminologyCapabilities.expansion.parameter.name, TerminologyCapabilities.expansion.parameter.documentation, TerminologyCapabilities.expansion.textFilter, TerminologyCapabilities.codeSearch, TerminologyCapabilities.validateCode, TerminologyCapabilities.validateCode.extension, TerminologyCapabilities.validateCode.modifierExtension, TerminologyCapabilities.validateCode.translations, TerminologyCapabilities.translation, TerminologyCapabilities.translation.extension, TerminologyCapabilities.translation.modifierExtension, TerminologyCapabilities.translation.needsMap, TerminologyCapabilities.closure, TerminologyCapabilities.closure.extension, TerminologyCapabilities.closure.modifierExtension, TerminologyCapabilities.closure.translation All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error TerminologyCapabilities.extension, TerminologyCapabilities.modifierExtension, TerminologyCapabilities.software.extension, TerminologyCapabilities.software.modifierExtension, TerminologyCapabilities.implementation.extension, TerminologyCapabilities.implementation.modifierExtension, TerminologyCapabilities.codeSystem.extension, TerminologyCapabilities.codeSystem.modifierExtension, TerminologyCapabilities.codeSystem.version.extension, TerminologyCapabilities.codeSystem.version.modifierExtension, TerminologyCapabilities.codeSystem.version.filter.extension, TerminologyCapabilities.codeSystem.version.filter.modifierExtension, TerminologyCapabilities.expansion.extension, TerminologyCapabilities.expansion.modifierExtension, TerminologyCapabilities.expansion.parameter.extension, TerminologyCapabilities.expansion.parameter.modifierExtension, TerminologyCapabilities.validateCode.extension, TerminologyCapabilities.validateCode.modifierExtension, TerminologyCapabilities.translation.extension, TerminologyCapabilities.translation.modifierExtension, TerminologyCapabilities.closure.extension, TerminologyCapabilities.closure.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()
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 Terminology 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())
tcp-6 error TerminologyCapabilities Each instance of the codeSystem element must represent a distinct code system. codeSystem.uri.isDistinct()
tcp-7 error TerminologyCapabilities.codeSystem Each version.code element must be distinct for a particular code system. version.code.isDistinct()
tcp-8 error TerminologyCapabilities.codeSystem A codeSystem element instance may have at most one version.isDefault element with a value of 'true'. version.where(isDefault = true).count() <= 1

This structure is derived from TerminologyCapabilities

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron