This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Terminology Infrastructure Work Group | Maturity Level: 1 | Trial Use | Security Category: Anonymous | Compartments: No defined compartments |
Detailed Descriptions for the elements in the TerminologyCapabilities resource.
TerminologyCapabilities | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | A statement of system capabilities | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | CanonicalResource | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.url | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.url | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | uri | ||||||||||||||||||||||||||||
Requirements | Allows the terminology capabilities to be referenced by a single globally unique identifier. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.identifier | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.identifier | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Additional identifier for the terminology capabilities | ||||||||||||||||||||||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | Identifier | ||||||||||||||||||||||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Comments | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this terminology capabilities outside of FHIR, where it is not possible to use the logical URI. | ||||||||||||||||||||||||||||
TerminologyCapabilities.version | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.version | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Business version of the terminology capabilities | ||||||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.versionAlgorithm[x] | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.versionAlgorithm[x] | ||||||||||||||||||||||||||||
Definition | Indicates the mechanism used to compare versions to determine which is more current. | ||||||||||||||||||||||||||||
Short Display | How to compare versions | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Terminology Binding | Version Algorithm (Extensible) | ||||||||||||||||||||||||||||
Type | string|Coding | ||||||||||||||||||||||||||||
[x] Note | See Choice of Datatypes for further information about how to use [x] | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.name | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.name | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Name for this terminology capabilities (computer friendly) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Requirements | Support human navigation and code generation. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.title | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.title | ||||||||||||||||||||||||||||
Definition | A short, descriptive, user-friendly title for the terminology capabilities. | ||||||||||||||||||||||||||||
Short Display | Name for this terminology capabilities (human friendly) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||||||||||||||||||||||
TerminologyCapabilities.status | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.status | ||||||||||||||||||||||||||||
Definition | The status of this terminology capabilities. Enables tracking the life-cycle of the content. | ||||||||||||||||||||||||||||
Short Display | draft | active | retired | unknown | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.experimental | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.experimental | ||||||||||||||||||||||||||||
Definition | A Boolean value to indicate that this terminology capabilities is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | ||||||||||||||||||||||||||||
Short Display | For testing purposes, not real usage | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Meaning if Missing | If absent, this resource is treated as though it is not experimental. | ||||||||||||||||||||||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level terminology capabilities. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Comments | Allows filtering of terminology capabilitiess that are appropriate for use versus not. | ||||||||||||||||||||||||||||
TerminologyCapabilities.date | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.date | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Date last changed | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | dateTime | ||||||||||||||||||||||||||||
Alternate Names | Revision Date | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.publisher | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.publisher | ||||||||||||||||||||||||||||
Definition | The name of the organization or individual responsible for the release and ongoing maintenance of the terminology capabilities. | ||||||||||||||||||||||||||||
Short Display | Name of the publisher/steward (organization or individual) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Requirements | Helps establish the "authority/credibility" of the terminology capabilities. May also allow for contact. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.contact | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.contact | ||||||||||||||||||||||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||||||||||||||||||||||
Short Display | Contact details for the publisher | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | ContactDetail | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Comments | May be a web site, an email address, a telephone number, etc. See guidance around (not) making local changes to elements here. | ||||||||||||||||||||||||||||
TerminologyCapabilities.description | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.description | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Natural language description of the terminology capabilities | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.useContext | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.useContext | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | The context that the content is intended to support | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | UsageContext | ||||||||||||||||||||||||||||
Requirements | Assist in searching for appropriate content. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||||||||||||||||||||||
TerminologyCapabilities.jurisdiction | |||||||||||||||||||||||||||||
Standards Status | This element has a standards status of "Deprecated" which is different from the status of the whole resource | ||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.jurisdiction | ||||||||||||||||||||||||||||
Definition | A legal or geographic region in which the terminology capabilities is intended to be used. | ||||||||||||||||||||||||||||
Short Display | Intended jurisdiction for terminology capabilities (if applicable) | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Terminology Binding | Jurisdiction ValueSet (Extensible) | ||||||||||||||||||||||||||||
Type | CodeableConcept | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
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.) | ||||||||||||||||||||||||||||
TerminologyCapabilities.purpose | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.purpose | ||||||||||||||||||||||||||||
Definition | Explanation of why this terminology capabilities is needed and why it has been designed as it has. | ||||||||||||||||||||||||||||
Short Display | Why this terminology capabilities is defined | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.copyright | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.copyright | ||||||||||||||||||||||||||||
Definition | A copyright statement relating to the terminology capabilities and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the terminology capabilities. | ||||||||||||||||||||||||||||
Short Display | Use and/or publishing restrictions | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the terminology capabilities and/or its content. | ||||||||||||||||||||||||||||
Alternate Names | License; Restrictions | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
TerminologyCapabilities.copyrightLabel | |||||||||||||||||||||||||||||
Element Id | 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 resctricted. (e.g. 'All rights reserved', 'Some rights reserved'). | ||||||||||||||||||||||||||||
Short Display | Copyright holder and year(s) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Requirements | Defines the content expected to be rendered in all representations of the artifact. | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Comments | The (c) symbol 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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.kind | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.kind | ||||||||||||||||||||||||||||
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). | ||||||||||||||||||||||||||||
Short Display | instance | capability | requirements | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Terminology Binding | Capability Statement Kind (Required) | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Requirements | Allow searching the 3 modes. | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.software | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.software | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | Software that is covered by this terminology capability statement | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.software.name | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.software.name | ||||||||||||||||||||||||||||
Definition | Name the software is known by. | ||||||||||||||||||||||||||||
Short Display | A name the software is known by | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
TerminologyCapabilities.software.version | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.software.version | ||||||||||||||||||||||||||||
Definition | The version identifier for the software covered by this statement. | ||||||||||||||||||||||||||||
Short Display | Version covered by this statement | ||||||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Comments | If possible, a version should be specified, as statements are likely to be different for different versions of software. | ||||||||||||||||||||||||||||
TerminologyCapabilities.implementation | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.implementation | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | If this describes a specific instance | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.implementation.description | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.implementation.description | ||||||||||||||||||||||||||||
Definition | Information about the specific installation that this terminology capability statement relates to. | ||||||||||||||||||||||||||||
Short Display | Describes this specific instance | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
TerminologyCapabilities.implementation.url | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.implementation.url | ||||||||||||||||||||||||||||
Definition | An absolute base URL for the implementation. | ||||||||||||||||||||||||||||
Short Display | Base URL for the implementation | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | url | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
TerminologyCapabilities.lockedDate | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.lockedDate | ||||||||||||||||||||||||||||
Definition | Whether the server supports lockedDate. | ||||||||||||||||||||||||||||
Short Display | Whether lockedDate is supported | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Short Display | A code system supported by the server | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Alternate Names | 1 | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.uri | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.uri | ||||||||||||||||||||||||||||
Definition | Canonical identifier for the code system, represented as a URI. | ||||||||||||||||||||||||||||
Short Display | Canonical identifier for the code system, represented as a URI | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | canonical(CodeSystem) | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version | ||||||||||||||||||||||||||||
Definition | For the code system, a list of versions that are supported by the server. | ||||||||||||||||||||||||||||
Short Display | Version of Code System supported | ||||||||||||||||||||||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Comments | Language translations might not be available for all codes. | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.code | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.code | ||||||||||||||||||||||||||||
Definition | For version-less code systems, there should be a single version with no identifier. | ||||||||||||||||||||||||||||
Short Display | Version identifier for this version | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | string | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.isDefault | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.isDefault | ||||||||||||||||||||||||||||
Definition | If this is the default version for this code system. | ||||||||||||||||||||||||||||
Short Display | If this is the default version for this code system | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
Invariants |
| ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.compositional | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.compositional | ||||||||||||||||||||||||||||
Definition | If the compositional grammar defined by the code system is supported. | ||||||||||||||||||||||||||||
Short Display | If compositional grammar is supported | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.language | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.language | ||||||||||||||||||||||||||||
Definition | Language Displays supported. | ||||||||||||||||||||||||||||
Short Display | Language Displays supported | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Terminology Binding | All Languages (Required)
| ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.filter | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.filter | ||||||||||||||||||||||||||||
Definition | Filter Properties supported. | ||||||||||||||||||||||||||||
Short Display | Filter Properties supported | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.filter.code | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.filter.code | ||||||||||||||||||||||||||||
Definition | Code of the property supported. | ||||||||||||||||||||||||||||
Short Display | Code of the property supported | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.filter.op | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.filter.op | ||||||||||||||||||||||||||||
Definition | Operations supported for the property. | ||||||||||||||||||||||||||||
Short Display | Operations supported for the property | ||||||||||||||||||||||||||||
Cardinality | 1..* | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.version.property | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.version.property | ||||||||||||||||||||||||||||
Definition | Properties supported for $lookup. | ||||||||||||||||||||||||||||
Short Display | Properties supported for $lookup | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.content | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.content | ||||||||||||||||||||||||||||
Definition | The extent of the content of the code system (the concepts and codes it defines) are represented in this resource instance. | ||||||||||||||||||||||||||||
Short Display | not-present | example | fragment | complete | supplement | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Terminology Binding | Code System Content Mode (Required) | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | true | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSystem.subsumption | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSystem.subsumption | ||||||||||||||||||||||||||||
Definition | True if subsumption is supported for this version of the code system. | ||||||||||||||||||||||||||||
Short Display | Whether subsumption is supported | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion | ||||||||||||||||||||||||||||
Definition | Information about the ValueSet/$expand operation. | ||||||||||||||||||||||||||||
Short Display | Information about the [ValueSet/$expand](valueset-operation-expand.html) operation | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.hierarchical | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.hierarchical | ||||||||||||||||||||||||||||
Definition | Whether the server can return nested value sets. | ||||||||||||||||||||||||||||
Short Display | Whether the server can return nested value sets | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.paging | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.paging | ||||||||||||||||||||||||||||
Definition | Whether the server supports paging on expansion. | ||||||||||||||||||||||||||||
Short Display | Whether the server supports paging on expansion | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.incomplete | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.incomplete | ||||||||||||||||||||||||||||
Definition | True if requests for incomplete expansions are allowed. | ||||||||||||||||||||||||||||
Short Display | Allow request for incomplete expansions? | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.parameter | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.parameter | ||||||||||||||||||||||||||||
Definition | Supported expansion parameter. | ||||||||||||||||||||||||||||
Short Display | Supported expansion parameter | ||||||||||||||||||||||||||||
Cardinality | 0..* | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.parameter.name | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.parameter.name | ||||||||||||||||||||||||||||
Definition | Name of the supported expansion parameter. | ||||||||||||||||||||||||||||
Short Display | Name of the supported expansion parameter | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.parameter.documentation | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.parameter.documentation | ||||||||||||||||||||||||||||
Definition | Description of support for parameter. | ||||||||||||||||||||||||||||
Short Display | Description of support for parameter | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.expansion.textFilter | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.expansion.textFilter | ||||||||||||||||||||||||||||
Definition | Documentation about text searching works. | ||||||||||||||||||||||||||||
Short Display | Documentation about text searching works | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | markdown | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||
TerminologyCapabilities.codeSearch | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.codeSearch | ||||||||||||||||||||||||||||
Definition | The degree to which the server supports the code search parameter on ValueSet, if it is supported. | ||||||||||||||||||||||||||||
Short Display | in-compose | in-expansion | in-compose-or-expansion | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Terminology Binding | Code Search Support (Required) | ||||||||||||||||||||||||||||
Type | code | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
Comments | See notes on the ValueSet resource. | ||||||||||||||||||||||||||||
TerminologyCapabilities.validateCode | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.validateCode | ||||||||||||||||||||||||||||
Definition | Information about the ValueSet/$validate-code operation. | ||||||||||||||||||||||||||||
Short Display | Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.validateCode.translations | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.validateCode.translations | ||||||||||||||||||||||||||||
Definition | Whether translations are validated. | ||||||||||||||||||||||||||||
Short Display | Whether translations are validated | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.translation | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.translation | ||||||||||||||||||||||||||||
Definition | Information about the ConceptMap/$translate operation. | ||||||||||||||||||||||||||||
Short Display | Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.translation.needsMap | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.translation.needsMap | ||||||||||||||||||||||||||||
Definition | Whether the client must identify the map. | ||||||||||||||||||||||||||||
Short Display | Whether the client must identify the map | ||||||||||||||||||||||||||||
Cardinality | 1..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.closure | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.closure | ||||||||||||||||||||||||||||
Definition | Whether the $closure operation is supported. | ||||||||||||||||||||||||||||
Short Display | Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Summary | false | ||||||||||||||||||||||||||||
TerminologyCapabilities.closure.translation | |||||||||||||||||||||||||||||
Element Id | TerminologyCapabilities.closure.translation | ||||||||||||||||||||||||||||
Definition | If cross-system closure is supported. | ||||||||||||||||||||||||||||
Short Display | If cross-system closure is supported | ||||||||||||||||||||||||||||
Cardinality | 0..1 | ||||||||||||||||||||||||||||
Type | boolean | ||||||||||||||||||||||||||||
Summary | false |