type: resource-definitionsresource: TerminologyCapabilities

TerminologyCapabilities Definitions

TerminologyCapabilities

A statement of system capabilities

Definition: A TerminologyCapabilities resource documents a set of capabilities (behaviors) of a FHIR Terminology Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

Cardinality: 0..*

Constraints: cnl-0 | warning | 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{1,254}$'); tcp-3 | error | If kind = instance, implementation must be present and software may be present | (kind != 'instance') or implementation.exists(); tcp-2 | error | A Terminology Capability statement SHALL have at least one of description, software, or implementation element | (description.count() + software.count() + implementation.count()) > 0; tcp-5 | error | If kind = requirements, implementation and software must be absent | (kind!='requirements') or (implementation.exists().not() and software.exists().not()); tcp-4 | error | If kind = capability, implementation must be absent, software must be present | (kind != 'capability') or (implementation.exists().not() and software.exists()); tcp-6 | error | Each instance of the codeSystem element must represent a distinct code system. | codeSystem.uri.isDistinct()

Mappings: rim=n/a; w5=conformance.behavior

TerminologyCapabilities.url

Canonical identifier for this terminology capabilities, represented as a URI (globally unique)

Definition: An absolute URI that is used to identify this terminology capabilities when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which an authoritative instance of this terminology capabilities is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the terminology capabilities is stored on different servers.

Comments: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Requirements: Allows the terminology capabilities to be referenced by a single globally unique identifier.

Cardinality: 0..1

Type: uri

Summary: true

Mappings: w5=FiveWs.identifier

TerminologyCapabilities.identifier

Additional identifier for the terminology capabilities

Definition: A formal identifier that is used to identify this terminology capabilities when it is represented in other formats, or referenced in a specification, model, design or an instance.

Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.

Cardinality: 0..*

Type: Identifier

Summary: true

Mappings: w5=FiveWs.identifier; objimpl=no-gen-base

TerminologyCapabilities.version

Business version of the terminology capabilities

Definition: The identifier that is used to identify this version of the terminology capabilities when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the terminology capabilities author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

Comments: There may be different terminology capabilities instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the terminology capabilities with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.version

TerminologyCapabilities.versionAlgorithm[x]

How to compare versions

Definition: Indicates the mechanism used to compare versions to determine which is more current.

Comments: If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

Cardinality: 0..1

Type: string, Coding

Binding: extensible:version-algorithm

Summary: true

TerminologyCapabilities.name

Name for this terminology capabilities (computer friendly)

Definition: A natural language name identifying the terminology capabilities. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Comments: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Requirements: Support human navigation and code generation.

Conditions: cnl-0

Cardinality: 0..1

Type: string

Summary: true

TerminologyCapabilities.title

Name for this terminology capabilities (human friendly)

Definition: A short, descriptive, user-friendly title for the terminology capabilities.

Comments: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Cardinality: 0..1

Type: string

Summary: true

TerminologyCapabilities.status

draft | active | retired | unknown

Definition: The status of this terminology capabilities. Enables tracking the life-cycle of the content.

Comments: Allows filtering of terminology capabilitiess that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.

See guidance around (not) making local changes to elements here.

Cardinality: 1..1

Type: code

Binding: required:publication-status

Summary: true

Is Modifier: true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)

Mappings: w5=FiveWs.status

TerminologyCapabilities.experimental

For testing only - never for real usage

Definition: A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

Comments: Allows filtering of terminology capabilitiess that are appropriate for use versus not. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities.

Meaning if Missing: If absent, this resource is treated as though it is not experimental.

Cardinality: 0..1

Type: boolean

Summary: true

Mappings: w5=FiveWs.class

TerminologyCapabilities.date

Date last changed

Definition: The date (and optionally time) when the terminology capabilities was last significantly changed. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the terminology capabilities changes.

Comments: The date is often not tracked until the resource is published, but may be present on draft content. Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the terminology capabilities. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

See guidance around (not) making local changes to elements here.

Aliases: Revision Date

Cardinality: 1..1

Type: dateTime

Summary: true

Mappings: w5=FiveWs.recorded

TerminologyCapabilities.publisher

Name of the publisher/steward (organization or individual)

Definition: The name of the organization or individual responsible for the release and ongoing maintenance of the terminology capabilities.

Comments: Usually an organization but may be an individual. The publisher (or steward) of the terminology capabilities is the organization or individual primarily responsible for the maintenance and upkeep of the terminology capabilities. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the terminology capabilities. This item SHOULD be populated unless the information is available from context.

Requirements: Helps establish the "authority/credibility" of the terminology capabilities. May also allow for contact.

Cardinality: 0..1

Type: string

Summary: true

Mappings: w5=FiveWs.witness

TerminologyCapabilities.contact

Contact details for the publisher

Definition: Contact details to assist a user in finding and communicating with the publisher.

Comments: May be a web site, an email address, a telephone number, etc.

See guidance around (not) making local changes to elements here.

Cardinality: 0..*

Type: ContactDetail

Summary: true

TerminologyCapabilities.description

Natural language description of the terminology capabilities

Definition: A free text natural language description of the terminology capabilities from a consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFP.

Comments: This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the terminology capabilities as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the terminology capabilities is presumed to be the predominant language in the place the terminology capabilities was created).This does not need to be populated if the description is adequately implied by the software or implementation details.

Conditions: tcp-2

Cardinality: 0..1

Type: markdown

TerminologyCapabilities.useContext

The context that the content is intended to support

Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate terminology capabilities instances.

Comments: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Requirements: Assist in searching for appropriate content.

Cardinality: 0..*

Type: UsageContext

Summary: true

TerminologyCapabilities.jurisdiction

Jurisdiction of the authority that maintains the terminology capabilities (if applicable)

Definition: A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

Comments: It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended.

DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

Cardinality: 0..*

Type: CodeableConcept

Binding: extensible:jurisdiction

Summary: true

TerminologyCapabilities.purpose

Why this terminology capabilities is defined

Definition: Explanation of why this terminology capabilities is needed and why it has been designed as it has.

Comments: This element does not describe the usage of the terminology capabilities. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this terminology capabilities.

Cardinality: 0..1

Type: markdown

Mappings: w5=FiveWs.why[x]; objimpl=no-gen-base

TerminologyCapabilities.copyright

Notice about intellectual property ownership, can include restrictions on use

Definition: A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the terminology capabilities.

Requirements: Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content.

Aliases: License, Restrictions

Cardinality: 0..1

Type: markdown

Summary: true

Mappings: objimpl=no-gen-base

TerminologyCapabilities.copyrightLabel

Definition: A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

Comments: The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

Requirements: Defines the content expected to be rendered in all representations of the artifact.

Cardinality: 0..1

Type: string

TerminologyCapabilities.kind

instance | capability | requirements

Definition: The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind, not instance of software) or a class of implementation (e.g. a desired purchase).

Requirements: Allow searching the 3 modes.

Conditions: tcp-3, tcp-5, tcp-4

Cardinality: 1..1

Type: code

Binding: required:capability-statement-kind

Summary: true

TerminologyCapabilities.software

Software that is covered by this terminology capability statement

Definition: Software that is covered by this terminology capability statement. It is used when the statement describes the capabilities of a particular software version, independent of an installation.

Conditions: tcp-2, tcp-5, tcp-4

Cardinality: 0..1

Type: BackboneElement

Summary: true

TerminologyCapabilities.software.name

A name the software is known by

Definition: Name the software is known by.

Cardinality: 1..1

Type: string

Summary: true

TerminologyCapabilities.software.version

Version covered by this statement

Definition: The version identifier for the software covered by this statement.

Comments: If possible, a version should be specified, as statements are likely to be different for different versions of software.

Cardinality: 0..1

Type: string

Summary: true

TerminologyCapabilities.implementation

If this describes a specific instance

Definition: Identifies a specific implementation instance that is described by the terminology capability statement - i.e. a particular installation, rather than the capabilities of a software program.

Conditions: tcp-3, tcp-2, tcp-5, tcp-4

Cardinality: 0..1

Type: BackboneElement

Summary: true

TerminologyCapabilities.implementation.description

Describes this specific instance

Definition: Information about the specific installation that this terminology capability statement relates to.

Cardinality: 1..1

Type: markdown

Summary: true

TerminologyCapabilities.implementation.url

Base URL for the implementation

Definition: An absolute base URL for the implementation.

Cardinality: 0..1

Type: url

Summary: true

TerminologyCapabilities.lockedDate

Whether lockedDate is supported

Definition: Whether the server supports lockedDate.

Cardinality: 0..1

Type: boolean

Summary: true

TerminologyCapabilities.codeSystem

A code system supported by the server

Definition: Identifies a code system that is supported by the server. If there is a no code system URL, then this declares the general assumptions a client can make about support for any CodeSystem resource.

Comments: The code system - identified by its system URL - may also be declared explicitly as a Code System Resource at /CodeSystem, but it might not be.

Aliases: 1

Conditions: tcp-6

Cardinality: 0..*

Type: BackboneElement

Constraints: tcp-1 | error | If there is more than one version, a version code must be defined | version.count() > 1 implies version.all(code.exists()); tcp-7 | error | Each version.code element must be distinct for a particular code system. | version.code.isDistinct(); tcp-8 | error | A codeSystem element instance may have at most one version.isDefault element with a value of 'true'. | version.where(isDefault = true).count() <= 1

TerminologyCapabilities.codeSystem.uri

Canonical identifier for the code system, represented as a URI (no version portion)

Definition: Canonical identifier for the code system, represented as a URI. This cannot have a version in the canonical URL.

Conditions: tcp-6

Cardinality: 0..1

Type: canonical

TerminologyCapabilities.codeSystem.supplement

Canonical identifier for a supported supplement to this code system (including supplement version)

Definition: Canonical identifier for a supported supplement to this code system. Supplements listed here supplement all versions of the code system. This reference SHOULD be version specific.

Cardinality: 0..*

Type: canonical

TerminologyCapabilities.codeSystem.version

Version of Code System supported

Definition: For the code system, a list of versions that are supported by the server.

Comments: Language translations might not be available for all codes.

Conditions: tcp-1, tcp-7, tcp-8

Cardinality: 0..*

Type: BackboneElement

TerminologyCapabilities.codeSystem.version.code

Version identifier for this version

Definition: For version-less code systems, there should be a single version with no identifier.

Conditions: tcp-1, tcp-7

Cardinality: 0..1

Type: string

Summary: true

TerminologyCapabilities.codeSystem.version.isDefault

If this is the default version for this code system

Definition: If this is the default version for this code system.

Conditions: tcp-8

Cardinality: 0..1

Type: boolean

Summary: true

TerminologyCapabilities.codeSystem.version.supplement

Canonical identifier for a supported supplement to this code system version (including supplement version)

Definition: Canonical identifier for a supported supplement to this code system. Supplements listed here supplement this specific version of the code system (and by implication, not all of the supported versions). This reference SHOULD be version specific.

Cardinality: 0..*

Type: canonical

TerminologyCapabilities.codeSystem.version.compositional

If compositional grammar is supported

Definition: If the compositional grammar defined by the code system is supported.

Cardinality: 0..1

Type: boolean

TerminologyCapabilities.codeSystem.version.language

Language Displays supported

Definition: Language Displays supported.

Cardinality: 0..*

Type: code

Binding: required:all-languages

TerminologyCapabilities.codeSystem.version.filter

Filter Properties supported

Definition: Filter Properties supported.

Cardinality: 0..*

Type: BackboneElement

TerminologyCapabilities.codeSystem.version.filter.code

Code of the property supported

Definition: Code of the property supported.

Cardinality: 1..1

Type: code

TerminologyCapabilities.codeSystem.version.filter.op

Operations supported for the property

Definition: Operations supported for the property.

Cardinality: 1..*

Type: code

TerminologyCapabilities.codeSystem.version.property

Properties supported for $lookup

Definition: Properties supported for $lookup.

Cardinality: 0..*

Type: code

TerminologyCapabilities.codeSystem.content

not-present | example | fragment | complete | supplement

Definition: The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance.

Cardinality: 1..1

Type: code

Binding: required:codesystem-content-mode|6.0.0

Summary: true

TerminologyCapabilities.codeSystem.subsumption

Whether subsumption is supported

Definition: True if subsumption is supported for this version of the code system.

Cardinality: 0..1

Type: boolean

TerminologyCapabilities.supplements

Supplement Support Information

Definition: Information about how the system supports CodeSystem supplements.

Cardinality: 0..1

Type: BackboneElement

TerminologyCapabilities.supplements.globals

not-supported | explicit | implicit

Definition: Codes that describes how the server implements global language packs - that is, supplements that contain only designations for a single language that are marked as intended by the extension http://hl7.org/fhir/StructureDefinition/codesystem-globalLangPack for use with all value sets and codesystem without explicit reference.

Cardinality: 0..1

Type: code

Binding: required:global-langpack-support

TerminologyCapabilities.expansion

Information about the ValueSet/$expand operation

Definition: Information about the ValueSet/$expand operation.

Cardinality: 0..1

Type: BackboneElement

TerminologyCapabilities.expansion.hierarchical

Whether the server can return nested value sets

Definition: Whether the server can return nested value sets.

Cardinality: 0..1

Type: boolean

TerminologyCapabilities.expansion.paging

Whether the server supports paging on expansion

Definition: Whether the server supports paging on expansion.

Cardinality: 0..1

Type: boolean

TerminologyCapabilities.expansion.incomplete

Allow request for incomplete expansions?

Definition: True if requests for incomplete expansions are allowed.

Cardinality: 0..1

Type: boolean

TerminologyCapabilities.expansion.parameter

Supported expansion parameter

Definition: Supported expansion parameter.

Cardinality: 0..*

Type: BackboneElement

TerminologyCapabilities.expansion.parameter.name

Name of the supported expansion parameter

Definition: Name of the supported expansion parameter.

Cardinality: 1..1

Type: code

TerminologyCapabilities.expansion.parameter.documentation

Description of support for parameter

Definition: Description of support for parameter.

Cardinality: 0..1

Type: markdown

TerminologyCapabilities.expansion.textFilter

Documentation about text searching works

Definition: Documentation about text searching works.

Comments: This documentation should cover things like case sensitivity, use of punctuation if not ignored, what wild cards are supported (if any), whether text is starts with or contains, and whether word order matters.

Cardinality: 0..1

Type: markdown