TerminologyCapabilities - FHIR Resource (r4)


This TerminologyCapabilities Resource uses the FHIR API standard for access and structure.

Validate an TerminologyCapabilities FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
closurefalseData Type# Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
codeSearchfalsecode# explicit | all
codeSystemtrueData Type# A code system supported by the server
contacttrueContactDetail# Contact details for the publisher
copyrightfalsemarkdown# Use and/or publishing restrictions
datefalsedateTime# Date last changed
descriptionfalsemarkdown# Natural language description of the terminology capabilities
expansionfalseData Type# Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
experimentalfalseboolean# For testing purposes, not real usage
implementationfalseData Type# C? If this describes a specific instance
jurisdictiontrueCodeableConcept# Intended jurisdiction for terminology capabilities (if applicable)
kindfalsecode# C? instance | capability | requirements
lockedDatefalseboolean# Whether lockedDate is supported
namefalsestring# C? Name for this terminology capabilities (computer friendly)
publisherfalsestring# Name of the publisher (organization or individual)
purposefalsemarkdown# Why this terminology capabilities is defined
softwarefalseData Type# C? Software that is covered by this terminology capability statement
statusfalsecode# draft | active | retired | unknown
titlefalsestring# Name for this terminology capabilities (human friendly)
translationfalseData Type# Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
urlfalseuri# Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
useContexttrueUsageContext# The context that the content is intended to support
validateCodefalseData Type# Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
versionfalsestring# Business version of the terminology capabilities

TerminologyCapabilities Example

{
  "resourceType": "TerminologyCapabilities",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>The EHR Server supports the following transactions for the resource Person: read, vread, \n        update, history, search(name,gender), create and updates.</p>\n\t\t\t<p>The EHR System supports the following message: admin-notify::Person.</p>\n\t\t\t<p>The EHR Application has a \n        <a href=\"http://fhir.hl7.org/base/Profilebc054d23-75e1-4dc6-aca5-838b6b1ac81d/_history/b5fdd9fc-b021-4ea1-911a-721a60663796\">general document profile</a>.\n      </p>\n\t\t</div>"
  },
  "url": "urn:uuid:68D043B5-9ECF-4559-A57A-396E0D452311",
  "version": "20130510",
  "name": "ACME-EHR",
  "title": "ACME EHR capability statement",
  "status": "draft",
  "experimental": true,
  "date": "2012-01-04",
  "publisher": "ACME Corporation",
  "contact": [
    {
      "name": "System Administrator",
      "telecom": [
        {
          "system": "email",
          "value": "wile@acme.org"
        }
      ]
    }
  ],
  "description": "This is the FHIR capability statement for the main EHR at ACME for the private interface - it does not describe the public interface",
  "kind": "instance",
  "software": {
    "name": "TxServer",
    "version": "0.1.2"
  },
  "implementation": {
    "description": "Acme Terminology Server",
    "url": "http://example.org/tx"
  },
  "codeSearch": "explicit"
}

TerminologyCapabilities Structure

{
  "resourceType" : "TerminologyCapabilities",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this terminology capabilities, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the terminology capabilities
  "name" : "<string>", // C? Name for this terminology capabilities (computer friendly)
  "title" : "<string>", // Name for this terminology capabilities (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the terminology capabilities
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for terminology capabilities (if applicable)
  "purpose" : "<markdown>", // Why this terminology capabilities is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "kind" : "<code>", // C? R!  instance | capability | requirements
  "software" : { // C? Software that is covered by this terminology capability statement
    "name" : "<string>", // R!  A name the software is known by
    "version" : "<string>" // Version covered by this statement
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<url>" // Base URL for the implementation
  },
  "lockedDate" : <boolean>, // Whether lockedDate is supported
  "codeSystem" : [{ // A code system supported by the server
    "uri" : { canonical(CodeSystem) }, // URI for the Code System
    "version" : [{ // Version of Code System supported
      "code" : "<string>", // C? Version identifier for this version
      "isDefault" : <boolean>, // If this is the default version for this code system
      "compositional" : <boolean>, // If compositional grammar is supported
      "language" : ["<code>"], // Language Displays supported
      "filter" : [{ // Filter Properties supported
        "code" : "<code>", // R!  Code of the property supported
        "op" : ["<code>"] // R!  Operations supported for the property
      }],
      "property" : ["<code>"] // Properties supported for $lookup
    }],
    "subsumption" : <boolean> // Whether subsumption is supported
  }],
  "expansion" : { // Information about the [ValueSet/$expand](valueset-operation-expand.html) operation
    "hierarchical" : <boolean>, // Whether the server can return nested value sets
    "paging" : <boolean>, // Whether the server supports paging on expansion
    "incomplete" : <boolean>, // Allow request for incomplete expansions?
    "parameter" : [{ // Supported expansion parameter
      "name" : "<code>", // R!  Expansion Parameter name
      "documentation" : "<string>" // Description of support for parameter
    }],
    "textFilter" : "<markdown>" // Documentation about text searching works
  },
  "codeSearch" : "<code>", // explicit | all
  "validateCode" : { // Information about the [ValueSet/$validate-code](valueset-operation-validate-code.html) operation
    "translations" : <boolean> // R!  Whether translations are validated
  },
  "translation" : { // Information about the [ConceptMap/$translate](conceptmap-operation-translate.html) operation
    "needsMap" : <boolean> // R!  Whether the client must identify the map
  },
  "closure" : { // Information about the [ConceptMap/$closure](conceptmap-operation-closure.html) operation
    "translation" : <boolean> // If cross-system closure is supported
  }
}

TerminologyCapabilities Search Parameters

The following search parameters can be used to query TerminologyCapabilities resources. Just submit them like so:

https://api.1up.health/fhir/r4/TerminologyCapabilities?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
contexttextuseContext.value
context-quantityquantityuseContext.value
context-typetextuseContext.code
context-type-quantitycompositeuseContext
context-type-valuecompositeuseContext
datedatedate
descriptiontextdescription
jurisdictiontextjurisdiction
nametextname
publishertextpublisher
statustextstatus
titletexttitle
urluriurl
versiontextversion