TerminologyCapabilities

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. If the element is present, it must have either a @value, an @id, or extensions

type TerminologyCapabilities implements Resource {
  url: Uri
  version: String
  name: String
  title: String
  status: String
  experimental: Boolean
  date: Date
  publisher: String
  contact: [ContactDetail]
  description: String
  useContext: [UsageContext]
  jurisdiction: [CodeableConcept]
  purpose: String
  copyright: String
  kind: String
  software: TerminologyCapabilitiesSoftware
  implementation: TerminologyCapabilitiesImplementation
  lockedDate: Boolean
  codeSystem: [TerminologyCapabilitiesCodeSystem]
  expansion: TerminologyCapabilitiesExpansion
  codeSearch: String
  validateCode: TerminologyCapabilitiesValidateCode
  translation: TerminologyCapabilitiesTranslation
  closure: TerminologyCapabilitiesClosure
  text: Narrative
  contained: [Resource]
  extension: [Extension]
  modifierExtension: [Extension]
  id: String
  meta: Meta
  implicitRules: Uri
  language: String
}

Fields

TerminologyCapabilities.url ● Uri scalar

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 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.

TerminologyCapabilities.version ● String scalar

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.

TerminologyCapabilities.name ● String scalar

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.

TerminologyCapabilities.title ● String scalar

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

TerminologyCapabilities.status ● String scalar

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

TerminologyCapabilities.experimental ● Boolean scalar

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.

TerminologyCapabilities.date ● Date scalar

The date (and optionally time) when the terminology capabilities was published. 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.

TerminologyCapabilities.publisher ● String scalar

The name of the organization or individual that published the terminology capabilities.

TerminologyCapabilities.contact ● [ContactDetail] list object

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

TerminologyCapabilities.description ● String scalar

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.

TerminologyCapabilities.useContext ● [UsageContext] list object

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.

TerminologyCapabilities.jurisdiction ● [CodeableConcept] list object

A legal or geographic region in which the terminology capabilities is intended to be used.

TerminologyCapabilities.purpose ● String scalar

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

TerminologyCapabilities.copyright ● String scalar

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.

TerminologyCapabilities.kind ● String scalar

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

TerminologyCapabilities.software ● TerminologyCapabilitiesSoftware object

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.

TerminologyCapabilities.implementation ● TerminologyCapabilitiesImplementation object

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.

TerminologyCapabilities.lockedDate ● Boolean scalar

Whether the server supports lockedDate.

TerminologyCapabilities.codeSystem ● [TerminologyCapabilitiesCodeSystem] list object

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.

TerminologyCapabilities.expansion ● TerminologyCapabilitiesExpansion object

Information about the ValueSet/ expand operation.

TerminologyCapabilities.codeSearch ● String scalar

The degree to which the server supports the code search parameter on ValueSet, if it is supported.

TerminologyCapabilities.validateCode ● TerminologyCapabilitiesValidateCode object

Information about the ValueSet/ validate-code operation.

TerminologyCapabilities.translation ● TerminologyCapabilitiesTranslation object

Information about the ConceptMap/ translate operation.

TerminologyCapabilities.closure ● TerminologyCapabilitiesClosure object

Whether the closure operation is supported.

TerminologyCapabilities.text ● Narrative object

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it clinically safe for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

TerminologyCapabilities.contained ● [Resource] list interface

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

TerminologyCapabilities.extension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

TerminologyCapabilities.modifierExtension ● [Extension] list object

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element s descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

TerminologyCapabilities.id ● String scalar

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

TerminologyCapabilities.meta ● Meta object

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

TerminologyCapabilities.implicitRules ● Uri scalar

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

TerminologyCapabilities.language ● String scalar

The base language in which the resource is written.

Interfaces

Resource interface

This is the base resource type for everything.

Returned By

TerminologyCapabilities query ● TerminologyCapabilitiesCreate mutation ● TerminologyCapabilitiesList query ● TerminologyCapabilitiesUpdate mutation