TerminologyCapabilities | Medplum
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.
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| url | uri | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) Details 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. 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. |
|
| version | string | Business version of the terminology capabilities Details 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. 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] |
|
| name | string | Name for this terminology capabilities (computer friendly) Details 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. 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. |
|
| title | string | Name for this terminology capabilities (human friendly) Details A short, descriptive, user-friendly title for the terminology capabilities. This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
|
| status | ✓ | code | draft | active | retired | unknown Details The status of this terminology capabilities. Enables tracking the life-cycle of the content. Allows filtering of terminology capabilities 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. |
| experimental | boolean | For testing purposes, not real usage Details 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. Allows filtering of terminology capabilities that are appropriate for use versus not. |
|
| date | ✓ | dateTime | Date last changed Details 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. 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. |
| publisher | string | Name of the publisher (organization or individual) Details The name of the organization or individual that published the terminology capabilities. 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. |
|
| contact | ContactDetail[] | Contact details for the publisher Details Contact details to assist a user in finding and communicating with the publisher. May be a web site, an email address, a telephone number, etc. |
|
| description | markdown | Natural language description of the terminology capabilities Details 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. This description can be used to capture details such as why the terminology capabilities was built, 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. |
|
| useContext | UsageContext[] | The context that the content is intended to support Details 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. When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
|
| jurisdiction | CodeableConcept[] | Intended jurisdiction for terminology capabilities (if applicable) Details A legal or geographic region in which the terminology capabilities is intended to be used. It may be possible for the terminology capabilities to be used in jurisdictions other than those for which it was originally designed or intended. |
|
| purpose | markdown | Why this terminology capabilities is defined Details Explanation of why this terminology capabilities is needed and why it has been designed as it has. 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. |
|
| copyright | markdown | Use and/or publishing restrictions Details 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. |
|
| kind | ✓ | code | instance | capability | requirements Details 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). |
| software | TerminologyCapabilitiesSoftware | Software that is covered by this terminology capability statement Details 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. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained 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 can 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). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
The TerminologyCapabilities resource provides for a terminology server to describe how the underlying terminology service works.
A client can get the TerminologyCapabilities statement for a Terminology Service by using the capabilities API:
GET [base]/metadata?mode=terminology
This will return the TerminologyCapabilities resource that applies to the service itself.