FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

Capabilitystatement-terminology-server.json

FHIR Infrastructure Work GroupMaturity Level: N/ABallot Status: InformativeCompartments: Not linked to any defined compartments

Raw JSON (canonical form)

Terminology Server Base Capability Statement

{
  "resourceType": "CapabilityStatement",
  "id": "terminology-server",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n      <h2>Terminology Service Capability Statement</h2>\n      <div>\n        <p>Basic capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount</p>\n\n      </div>\n      <table>\n        <tr>\n          <td>Mode</td>\n          <td>SERVER</td>\n        </tr>\n        <tr>\n          <td>Description</td>\n          <td>RESTful Terminology Server</td>\n        </tr>\n        <tr>\n          <td>Transaction</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>System History</td>\n          <td/>\n        </tr>\n        <tr>\n          <td>System Search</td>\n          <td/>\n        </tr>\n      </table>\n      <table>\n        <tr>\n          <th>\n            <b>Resource Type</b>\n          </th>\n          <th>\n            <b>Profile</b>\n          </th>\n          <th>\n            <b>Read</b>\n          </th>\n          <th>\n            <b>V-Read</b>\n          </th>\n          <th>\n            <b>Search</b>\n          </th>\n          <th>\n            <b>Update</b>\n          </th>\n          <th>\n            <b>Updates</b>\n          </th>\n          <th>\n            <b>Create</b>\n          </th>\n          <th>\n            <b>Delete</b>\n          </th>\n          <th>\n            <b>History</b>\n          </th>\n        </tr>\n        <tr>\n          <td>ValueSet</td>\n          <td>\n            <a href=\"StructureDefinition/ValueSet\">StructureDefinition/ValueSet</a>\n          </td>\n          <td>y</td>\n          <td/>\n          <td>y</td>\n          <td/>\n          <td/>\n          <td/>\n          <td/>\n          <td/>\n        </tr>\n        <tr>\n          <td>ConceptMap</td>\n          <td>\n            <a href=\"StructureDefinition/ConceptMap\">StructureDefinition/ConceptMap</a>\n          </td>\n          <td>y</td>\n          <td/>\n          <td>y</td>\n          <td/>\n          <td/>\n          <td/>\n          <td/>\n          <td/>\n        </tr>\n      </table>\n    </div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-supported-system",
      "valueUri": "http://loinc.org"
    }
  ],
  "url": "http://hl7.org/fhir/terminology-server",
  "name": "Terminology Service Capability Statement",
  "status": "draft",
  "date": "2015-07-05",
  "publisher": "HL7, Inc",
  "contact": [
    {
      "name": "FHIR Project",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "description": "Basic capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount",
  "kind": "capability",
  "software": {
    "name": "ACME Terminology Server"
  },
  "fhirVersion": "3.0.2",
  "acceptUnknown": "both",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "RESTful Terminology Server",
      "security": {
        "cors": true,
        "service": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/restful-security-service",
                "code": "Certificates"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "type": "ValueSet",
          "profile": {
            "reference": "StructureDefinition/ValueSet"
          },
          "interaction": [
            {
              "code": "read",
              "documentation": "Read allows clients to get the logical definitions of the value sets"
            },
            {
              "code": "search-type",
              "documentation": "Search allows clients to find value sets on the server"
            }
          ],
          "searchParam": [
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-date",
              "type": "date"
            },
            {
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-name",
              "type": "string"
            },
            {
              "name": "reference",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-reference",
              "type": "token"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-status",
              "type": "token"
            },
            {
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-url",
              "type": "uri"
            },
            {
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-version",
              "type": "token"
            }
          ]
        },
        {
          "type": "ConceptMap",
          "profile": {
            "reference": "StructureDefinition/ConceptMap"
          },
          "interaction": [
            {
              "code": "read",
              "documentation": "Read allows clients to get the logical definitions of the concept maps"
            },
            {
              "code": "search-type",
              "documentation": "Search allows clients to find concept maps on the server"
            }
          ],
          "searchParam": [
            {
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-date",
              "type": "date"
            },
            {
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-name",
              "type": "string"
            },
            {
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-status",
              "type": "token"
            },
            {
              "name": "source",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-source",
              "type": "uri"
            },
            {
              "name": "target",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-target",
              "type": "uri"
            },
            {
              "name": "url",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-url",
              "type": "uri"
            },
            {
              "name": "version",
              "definition": "http://hl7.org/fhir/SearchParameter/ConceptMap-version",
              "type": "token"
            }
          ]
        }
      ],
      "operation": [
        {
          "name": "expand",
          "definition": {
            "reference": "OperationDefinition/ValueSet-expand"
          }
        },
        {
          "name": "lookup",
          "definition": {
            "reference": "OperationDefinition/CodeSystem-lookup"
          }
        },
        {
          "name": "validate-code",
          "definition": {
            "reference": "OperationDefinition/ValueSet-validate-code"
          }
        },
        {
          "name": "translate",
          "definition": {
            "reference": "OperationDefinition/ConceptMap-translate"
          }
        },
        {
          "name": "closure",
          "definition": {
            "reference": "OperationDefinition/ConceptMap-closure"
          }
        }
      ]
    }
  ]
}

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.