Conformance-terminology-server.json

Terminology Server Base Conformance Statement

{
  "resourceType": "Conformance",
  "id": "conformance-terminology-server",
  "text": {
    "status": "generated",
    "div": "<div>\n      <h2>Terminology Service Conformance Statement</h2>\n      <p>Basic conformance statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount</p>\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": [
    {
      "fhir_comments": [
        "   \n    in addition to the code systems defined in line in value sets, \n\t  terminology servers also provide terminology functionality on \n\t\tadditional code systems. Typically, LOINC, SNOMED CT, RcNorm in USA, etc.). \n\t\t\n\t\tThese extra code systems are declared here in this extension. It's a todo \n\t\tfor a future version to standardise things like which versions are supported etc. \n\t   "
      ],
      "url": "http://hl7.org/fhir/StructureDefinition/conformance-supported-system",
      "valueUri": "http://loinc.org"
    }
  ],
  "url": "http://hl7.org/fhir/terminology-server",
  "name": "Terminology Service Conformance Statement",
  "status": "draft",
  "publisher": "HL7, Inc",
  "contact": [
    {
      "name": "FHIR Project",
      "telecom": [
        {
          "system": "other",
          "value": "http://hl7.org/fhir"
        }
      ]
    }
  ],
  "date": "2015-07-05",
  "description": "Basic conformance 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": "1.2.0",
  "acceptUnknown": "both",
  "_acceptUnknown": {
    "fhir_comments": [
      "    this can be either, but accepting unknown elements is \n    preferred for forwards compatibility (Not that it matters during the DSTU period)   "
    ]
  },
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "fhir_comments": [
        "    profile - terminology servers may consider \n    supporting the shareable value set directly, but\n    are not required. HL7 servers will\n  <profile>\n    <reference value=\"StructureDefinition/valueset-shareable-definition\"/>  \n  </profile>   \n     "
      ],
      "mode": "server",
      "documentation": "RESTful Terminology Server",
      "security": {
        "cors": true,
        "_cors": {
          "fhir_comments": [
            "    yes - terminology servers are expected to be used from web applications, and need to implement CORS    "
          ]
        },
        "service": [
          {
            "fhir_comments": [
              "    this bit is optional: security using registered client certificates    "
            ],
            "coding": [
              {
                "system": "http://hl7.org/fhir/restful-security-service",
                "code": "Certificates"
              }
            ]
          }
        ]
      },
      "resource": [
        {
          "fhir_comments": [
            "    Server could implement value set & concept map editing using \n         SMART-on-FHIR, but this doesn't make sense for the actual terminology services API\n      <service>\n        <coding>\n          <system value=\"http://hl7.org/fhir/restful-security-service\"/>\n          <code value=\"SMART-on-FHIR\"/>\n        </coding>\n      </service>\n         ",
            "    value set. Must provide read and search    "
          ],
          "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": [
            {
              "fhir_comments": [
                "    \n        servers should also consider offering these interactions to allow clients \n        to edit the content on the server, but are not required to do so\n      <interaction>\n\t\t<code value=\"create\"/>\n\t  </interaction>\n      <interaction>\n\t\t<code value=\"update\"/>\n\t  </interaction>\n      <interaction>\n\t\t<code value=\"delete\"/>\n\t  </interaction>\n      \n      this bit is up to servers - if they support editing, they should do so version safely\n      <versioning value=\"versioned-update\"/>\n         ",
                "    no need for version history (though servers can), and no need to conditional updates etc.   ",
                "    search parameters: at least code, date, name, reference, status, system, url and version. More is recommended    "
              ],
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-code",
              "type": "token"
            },
            {
              "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": "system",
              "definition": "http://hl7.org/fhir/SearchParameter/ValueSet-system",
              "type": "uri"
            },
            {
              "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": [
            {
              "fhir_comments": [
                "    \n        servers should also consider offering these interactions to allow clients \n        to edit the content on the server, but are not required to do so\n      <interaction>\n\t\t<code value=\"create\"/>\n\t  </interaction>\n      <interaction>\n\t\t<code value=\"update\"/>\n\t  </interaction>\n      <interaction>\n\t\t<code value=\"delete\"/>\n\t  </interaction>\n      \n      this bit is up to servers - if they support editing, they should do so version safely\n      <versioning value=\"versioned-update\"/>\n         ",
                "    no need for version history (though servers can), and no need to conditional updates etc.   ",
                "    search parameters: at least date, name, status, source, target, url, version. More is recommended    "
              ],
              "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": [
        {
          "fhir_comments": [
            "    now, operations. We expect terminology services to implement these \n      named services, though not necessarily actually these profiles    "
          ],
          "name": "expand",
          "definition": {
            "reference": "OperationDefinition/ValueSet-expand"
          }
        },
        {
          "name": "lookup",
          "definition": {
            "reference": "OperationDefinition/ValueSet-lookup"
          }
        },
        {
          "name": "validate-code",
          "definition": {
            "reference": "OperationDefinition/ValueSet-validate-code"
          }
        },
        {
          "name": "translate",
          "definition": {
            "reference": "OperationDefinition/ConceptMap-translate"
          }
        },
        {
          "name": "closure",
          "definition": {
            "reference": "OperationDefinition/ConceptMap-closure"
          }
        }
      ]
    }
  ]
}