FHIR CI-Build
ConformanceThis is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
| FHIR Infrastructure Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: No defined compartments |
Raw JSON (canonical form + also see JSON Format Specification)
Terminology Server Base Capability Statement
{
"resourceType" : "CapabilityStatement",
"id" : "example-terminology-server",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p class=\"res-header-id\">\n <b>Generated Narrative: CapabilityStatement example-terminology-server</b>\n </p>\n <a name=\"example-terminology-server\"> </a>\n <a name=\"hcexample-terminology-server\"> </a>\n <a name=\"example-terminology-server-en-US\"> </a>\n <h2 id=\"title\">ACME Terminology Service — Capability Statement</h2>\n <ul>\n <li>Implementation Guide Version: 6.0.0-ballot2 </li>\n <li>FHIR Version: 6.0.0-ballot2 </li>\n <li>Supported Formats: \n <code>json</code>, \n <code>xml</code>\n </li>\n <li>Supported Patch Formats: </li>\n <li>Published on: 2022-09-01 </li>\n <li>Published by: HL7 International / FHIR Infrastructure </li>\n </ul>\n <blockquote class=\"impl-note\">\n <p>\n <strong>Note to Implementers: FHIR Capabilities</strong>\n </p>\n <p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p>\n </blockquote>\n <h2 id=\"rest\">FHIR RESTful Capabilities</h2>\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\">\n <h3 id=\"mode1\" class=\"panel-title\">Mode: \n <code>server</code>\n </h3>\n </div>\n <div class=\"panel-body\">\n <div class=\"lead\">\n <em>Summary of System-wide Interactions</em>\n </div>\n </div>\n </div>\n <h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3>\n <h4 id=\"resourcesSummary1\">Summary</h4>\n <p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p>\n <ul>\n <li>The relevant profiles (if any)</li>\n <li>The interactions supported by each resource (\n <b>\n <span class=\"bg-info\">R</span>\n </b>ead, \n <b>\n <span class=\"bg-info\">S</span>\n </b>earch, \n <b>\n <span class=\"bg-info\">U</span>\n </b>pdate, and \n <b>\n <span class=\"bg-info\">C</span>\n </b>reate, are always shown, while \n <b>\n <span class=\"bg-info\">VR</span>\n </b>ead, \n <b>\n <span class=\"bg-info\">P</span>\n </b>atch, \n <b>\n <span class=\"bg-info\">D</span>\n </b>elete, \n <b>\n <span class=\"bg-info\">H</span>\n </b>istory on \n <b>\n <span class=\"bg-info\">I</span>\n </b>nstance, or \n <b>\n <span class=\"bg-info\">H</span>\n </b>istory on \n <b>\n <span class=\"bg-info\">T</span>\n </b>ype are only present if at least one of the resources has support for them.\n </li>\n <li>\n <span>The required, recommended, and some optional search parameters (if any). </span>\n </li>\n <li>The linked resources enabled for \n <code>_include</code>\n </li>\n <li>The other resources enabled for \n <code>_revinclude</code>\n </li>\n <li>The operations on the resource (if any)</li>\n </ul>\n <div class=\"table-responsive\">\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>\n <b>Resource Type</b>\n </th>\n <th>\n <b>Profile</b>\n </th>\n <th class=\"text-center\">\n <b title=\"GET a resource (read interaction)\">R</b>\n </th>\n <th class=\"text-center\">\n <b title=\"GET all set of resources of the type (search interaction)\">S</b>\n </th>\n <th class=\"text-center\">\n <b title=\"PUT a new resource version (update interaction)\">U</b>\n </th>\n <th class=\"text-center\">\n <b title=\"POST a new resource (create interaction)\">C</b>\n </th>\n <th>\n <b title=\"Required and recommended search parameters\">Searches</b>\n </th>\n <th>\n <code>\n <b>_include</b>\n </code>\n </th>\n <th>\n <code>\n <b>_revinclude</b>\n </code>\n </th>\n <th>\n <b>Operations</b>\n </th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <a href=\"#CodeSystem1-1\">CodeSystem</a>\n </td>\n <td>\n <a href=\"codesystem.html\">http://hl7.org/fhir/StructureDefinition/CodeSystem</a>\n </td>\n <td class=\"text-center\">y</td>\n <td class=\"text-center\">y</td>\n <td class=\"text-center\"/>\n <td class=\"text-center\"/>\n <td>url, version, name, title, status</td>\n <td/>\n <td/>\n <td>\n <code>$expand</code>, \n <code>$expand</code>, \n <code>$expand</code>\n </td>\n </tr>\n <tr>\n <td>\n <a href=\"#ValueSet1-2\">ValueSet</a>\n </td>\n <td>\n <a href=\"valueset.html\">http://hl7.org/fhir/StructureDefinition/ValueSet</a>\n </td>\n <td class=\"text-center\">y</td>\n <td class=\"text-center\">y</td>\n <td class=\"text-center\"/>\n <td class=\"text-center\"/>\n <td>url, version, name, title, status</td>\n <td/>\n <td/>\n <td>\n <code>$expand</code>, \n <code>$expand</code>\n </td>\n </tr>\n <tr>\n <td>\n <a href=\"#ConceptMap1-3\">ConceptMap</a>\n </td>\n <td>\n <a href=\"conceptmap.html\">http://hl7.org/fhir/StructureDefinition/ConceptMap</a>\n </td>\n <td class=\"text-center\">y</td>\n <td class=\"text-center\">y</td>\n <td class=\"text-center\"/>\n <td class=\"text-center\"/>\n <td>url, version, name, title, status</td>\n <td/>\n <td/>\n <td>\n <code>$expand</code>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <hr/>\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\">\n <h4 id=\"CodeSystem1-1\" class=\"panel-title\">\n <span style=\"float: right;\">Resource Conformance: SHALL </span>CodeSystem\n </h4>\n </div>\n <div class=\"panel-body\">\n <div class=\"container\">\n <div class=\"row\">\n <div class=\"col-lg-6\">\n <span class=\"lead\">Base System Profile</span>\n <br/>\n <a href=\"codesystem.html\">CodeSystem</a>\n </div>\n <div class=\"col-lg-3\">\n <span class=\"lead\">Profile Conformance</span>\n <br/>\n <b>SHALL</b>\n </div>\n <div class=\"col-lg-3\">\n <span class=\"lead\">Reference Policy</span>\n <br/>\n </div>\n </div>\n <p/>\n <div class=\"row\">\n <div class=\"col-lg-6\">\n <span class=\"lead\">Interaction summary</span>\n <br/>\n <ul>\n <li>\n <strong>SHALL</strong> support \n <code>read</code>, \n <code>search-type</code>.\n </li>\n </ul>\n </div>\n </div>\n <p/>\n <div class=\"row\">\n <div class=\"col-lg-7\">\n <span class=\"lead\">Search Parameters</span>\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Documentation</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>url</td>\n <td>\n <code>uri</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>version</td>\n <td>\n <code>token</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>name</td>\n <td>\n <code>string</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>title</td>\n <td>\n <code>string</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>status</td>\n <td>\n <code>token</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <div class=\"col-lg-5\">\u00a0</div>\n </div>\n <div class=\"row\">\n <div class=\"col-12\">\n <span class=\"lead\">Extended Operations</span>\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>Conformance</th>\n <th>Operation</th>\n <th>Documentation</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>\n <a href=\"codesystem-operation-lookup.html\">$expand</a>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>\n <a href=\"codesystem-operation-validate-code.html\">$expand</a>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>\n <a href=\"codesystem-operation-subsumes.html\">$expand</a>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n </div>\n </div>\n </div>\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\">\n <h4 id=\"ValueSet1-2\" class=\"panel-title\">\n <span style=\"float: right;\">Resource Conformance: SHALL </span>ValueSet\n </h4>\n </div>\n <div class=\"panel-body\">\n <div class=\"container\">\n <div class=\"row\">\n <div class=\"col-lg-6\">\n <span class=\"lead\">Base System Profile</span>\n <br/>\n <a href=\"valueset.html\">ValueSet</a>\n </div>\n <div class=\"col-lg-3\">\n <span class=\"lead\">Profile Conformance</span>\n <br/>\n <b>SHALL</b>\n </div>\n <div class=\"col-lg-3\">\n <span class=\"lead\">Reference Policy</span>\n <br/>\n </div>\n </div>\n <p/>\n <div class=\"row\">\n <div class=\"col-lg-6\">\n <span class=\"lead\">Interaction summary</span>\n <br/>\n <ul>\n <li>\n <strong>SHALL</strong> support \n <code>read</code>, \n <code>search-type</code>.\n </li>\n </ul>\n </div>\n </div>\n <p/>\n <div class=\"row\">\n <div class=\"col-lg-7\">\n <span class=\"lead\">Search Parameters</span>\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Documentation</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>url</td>\n <td>\n <code>uri</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>version</td>\n <td>\n <code>token</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>name</td>\n <td>\n <code>string</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>title</td>\n <td>\n <code>string</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>status</td>\n <td>\n <code>token</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <div class=\"col-lg-5\">\u00a0</div>\n </div>\n <div class=\"row\">\n <div class=\"col-12\">\n <span class=\"lead\">Extended Operations</span>\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>Conformance</th>\n <th>Operation</th>\n <th>Documentation</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>\n <a href=\"valueset-operation-expand.html\">$expand</a>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>\n <a href=\"valueset-operation-validate-code.html\">$expand</a>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n </div>\n </div>\n </div>\n <div class=\"panel panel-default\">\n <div class=\"panel-heading\">\n <h4 id=\"ConceptMap1-3\" class=\"panel-title\">\n <span style=\"float: right;\">Resource Conformance: SHALL </span>ConceptMap\n </h4>\n </div>\n <div class=\"panel-body\">\n <div class=\"container\">\n <div class=\"row\">\n <div class=\"col-lg-6\">\n <span class=\"lead\">Base System Profile</span>\n <br/>\n <a href=\"conceptmap.html\">ConceptMap</a>\n </div>\n <div class=\"col-lg-3\">\n <span class=\"lead\">Profile Conformance</span>\n <br/>\n <b>SHALL</b>\n </div>\n <div class=\"col-lg-3\">\n <span class=\"lead\">Reference Policy</span>\n <br/>\n </div>\n </div>\n <p/>\n <div class=\"row\">\n <div class=\"col-lg-6\">\n <span class=\"lead\">Interaction summary</span>\n <br/>\n <ul>\n <li>\n <strong>SHALL</strong> support \n <code>read</code>, \n <code>search-type</code>.\n </li>\n </ul>\n </div>\n </div>\n <p/>\n <div class=\"row\">\n <div class=\"col-lg-7\">\n <span class=\"lead\">Search Parameters</span>\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>Conformance</th>\n <th>Parameter</th>\n <th>Type</th>\n <th>Documentation</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>url</td>\n <td>\n <code>uri</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>version</td>\n <td>\n <code>token</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>name</td>\n <td>\n <code>string</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>title</td>\n <td>\n <code>string</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>status</td>\n <td>\n <code>token</code>\n </td>\n <td>\n <div/>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <div class=\"col-lg-5\">\u00a0</div>\n </div>\n <div class=\"row\">\n <div class=\"col-12\">\n <span class=\"lead\">Extended Operations</span>\n <table class=\"table table-condensed table-hover\">\n <thead>\n <tr>\n <th>Conformance</th>\n <th>Operation</th>\n <th>Documentation</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <td>\n <b>SHALL</b>\n </td>\n <td>$expand</td>\n <td>\n <div/>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>\n </div>\n </div>\n </div>\n </div>"
},
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
}],
"url" : "http://hl7.org/fhir/CapabilityStatement/terminology-server",
"version" : "6.0.0-ballot2",
"name" : "ACMETerminologyServiceCapabilityStatement",
"title" : "ACME Terminology Service — Capability Statement",
"status" : "draft",
"experimental" : true,
"date" : "2022-09-01",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [{
"telecom" : [{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}]
}],
"description" : "Example capability statement for a Terminology Server. A server can support more fucntionality than defined here, but this is the minimum amount",
"kind" : "instance",
"implementation" : {
"description" : "The ACME FHIR Terminology Server"
},
"fhirVersion" : "6.0.0-ballot2",
"format" : ["json",
"xml"],
"rest" : [{
"mode" : "server",
"resource" : [{
"type" : "CodeSystem",
"profile" : "http://hl7.org/fhir/StructureDefinition/CodeSystem",
"interaction" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "read"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "search-type"
}],
"searchParam" : [{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-url",
"type" : "uri"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-version",
"type" : "token"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-name",
"type" : "string"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-title",
"type" : "string"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/CodeSystem-status",
"type" : "token"
}],
"operation" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-validate-code"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-subsumes"
}]
},
{
"type" : "ValueSet",
"profile" : "http://hl7.org/fhir/StructureDefinition/ValueSet",
"interaction" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "read"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "search-type"
}],
"searchParam" : [{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-url",
"type" : "uri"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-version",
"type" : "token"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-name",
"type" : "string"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-title",
"type" : "string"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ValueSet-status",
"type" : "token"
}],
"operation" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
}]
},
{
"type" : "ConceptMap",
"profile" : "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"interaction" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "read"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "search-type"
}],
"searchParam" : [{
"name" : "url",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-url",
"type" : "uri"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-version",
"type" : "token"
},
{
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-name",
"type" : "string"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-title",
"type" : "string"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-status",
"type" : "token"
}],
"operation" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "expand",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate"
}]
}]
}]
}
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.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Wed, Nov 20, 2024 21:51+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change