Release
4B
5
Ballot
Conformance
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
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
| FHIR Infrastructure Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Not linked to any defined compartments |
Raw JSON ( canonical form + also see JSON Format Specification )
Terminology Server Base Capability Statement
{
"resourceType" : "CapabilityStatement",
"id" : "terminology-server",
"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",
"experimental" : true,
"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"
"resourceType": "CapabilityStatement",
"id": "example-terminology-server",
"text": {
"status": "extensions",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>ACMETerminologyService—CapabilityStatement</h2>\n <div>\n <p>Example 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/>\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 title=\"GET a resource (read interaction)\">Read</b>\n </th>\n <th>\n <b title=\"GET all set of resources of the type (search interaction)\">Search</b>\n </th>\n <th>\n <b title=\"PUT a new resource version (update interaction)\">Update</b>\n </th>\n <th>\n <b title=\"POST a new resource (create interaction)\">Create</b>\n </th>\n </tr>\n <tr>\n <td>CodeSystem</td>\n <td>\n <a href=\"http://hl7.org/fhir/StructureDefinition/CodeSystem\">http://hl7.org/fhir/StructureDefinition/CodeSystem</a>\n </td>\n <td>y</td>\n <td>y</td>\n <td/>\n <td/>\n </tr>\n <tr>\n <td>ValueSet</td>\n <td>\n <a href=\"http://hl7.org/fhir/StructureDefinition/ValueSet\">http://hl7.org/fhir/StructureDefinition/ValueSet</a>\n </td>\n <td>y</td>\n <td>y</td>\n <td/>\n <td/>\n </tr>\n <tr>\n <td>ConceptMap</td>\n <td>\n <a href=\"http://hl7.org/fhir/StructureDefinition/ConceptMap\">http://hl7.org/fhir/StructureDefinition/ConceptMap</a>\n </td>\n <td>y</td>\n <td>y</td>\n <td/>\n <td/>\n </tr>\n </table>\n </div>"
},
"fhirVersion" : "4.3.0",
"format" : ["json",
"xml"],
"rest" : [{
"mode" : "server",
"documentation" : "RESTful Terminology Server",
"security" : {
"cors" : true,
"service" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "Certificates"
}]
}]
},
"resource" : [{
"type" : "ValueSet",
"profile" : "http://hl7.org/fhir/StructureDefinition/ValueSet",
"interaction" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the value sets"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"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" : "uri"
},
{
"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" : "http://hl7.org/fhir/StructureDefinition/ConceptMap",
"interaction" : [{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the concept maps"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"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" : "reference"
},
{
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/ConceptMap-target",
"type" : "reference"
},
{
"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" : [{
"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" : "lookup",
"definition" : "http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "validate-code",
"definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
},
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}],
"name" : "translate",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-translate"
},
"url": "http://hl7.org/fhir/CapabilityStatement/terminology-server",
"version": "5.0.0-ballot",
"name": "ACMETerminologyService—CapabilityStatement",
"title": "ACME Terminology Service — Capability Statement",
"status": "draft",
"date": "2022-09-01",
"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": "5.0.0-ballot",
"format": [
"json",
"xml"
],
"rest": [
{
"extension" : [{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}],
"name" : "closure",
"definition" : "http://hl7.org/fhir/OperationDefinition/ConceptMap-closure"
}]
}]
"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
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Sat,
May
28,
Sep
10,
2022
12:54+1000.
05:01+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change