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.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/TerminologyCapabilities| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/TerminologyCapabilities/[id] |
| Vread | GET | /fhir/R4/TerminologyCapabilities/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/TerminologyCapabilities/[id] |
| Patch | PATCH | /fhir/R4/TerminologyCapabilities/[id] |
| Delete | DELETE | /fhir/R4/TerminologyCapabilities/[id] |
| Create | POST | /fhir/R4/TerminologyCapabilities |
| Search | GET | /fhir/R4/TerminologyCapabilities |
| History | GET | /fhir/R4/TerminologyCapabilities/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..1 | Canonical identifier for this terminology capabilities, represented as a URI (globally unique) |
version | string | 0..1 | Business version of the terminology capabilities |
name | string | 0..1 | Name for this terminology capabilities (computer friendly) |
title | string | 0..1 | Name for this terminology capabilities (human friendly) |
status | code | 1..1 | draft | active | retired | unknown modifier |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 1..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the terminology capabilities |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for terminology capabilities (if applicable) |
purpose | markdown | 0..1 | Why this terminology capabilities is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
kind | code | 1..1 | instance | capability | requirements |
software | BackboneElement | 0..1 | Software that is covered by this terminology capability statement |
implementation | BackboneElement | 0..1 | If this describes a specific instance |
lockedDate | boolean | 0..1 | Whether lockedDate is supported |
codeSystem | BackboneElement | 0..* | A code system supported by the server |
expansion | BackboneElement | 0..1 | Information about the ValueSet/$expand operation |
codeSearch | code | 0..1 | explicit | all |
validateCode | BackboneElement | 0..1 | Information about the ValueSet/$validate-code operation |
translation | BackboneElement | 0..1 | Information about the ConceptMap/$translate operation |
closure | BackboneElement | 0..1 | Information about the ConceptMap/$closure operation |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
TerminologyCapabilities - Maturity: Draft (FMM 0).