Release
4
5
Conformance
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
:
|
Raw JSON ( canonical form + also see JSON Format Specification )
Knowledge Repository Base Capability Statement
{
"resourceType": "CapabilityStatement",
"id": "knowledge-repository",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>Knowledge Repository Service Conformance Statement</h2>\n <div>\n <p>Basic conformance statement for a Knowledge Repository Service. A server can support more functionality\n 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 Knowledge Repository 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 </table>\n </div>"
"resourceType" : "CapabilityStatement",
"id" : "knowledge-repository",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n \n <h2>Knowledge Repository Service Conformance Statement</h2>\n \n <div>\n \n <p>Basic conformance statement for a Knowledge Repository Service. A server can support more functionality\n than defined here, but this is the minimum amount</p>\n\n \n </div>\n \n <table>\n \n <tr>\n \n <td>Mode</td>\n \n <td>SERVER</td>\n \n </tr>\n \n <tr>\n \n <td>Description</td>\n \n <td>RESTful Knowledge Repository Server</td>\n \n </tr>\n \n <tr>\n \n <td>Transaction</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <td>System History</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <td>System Search</td>\n \n <td/>\n \n </tr>\n \n </table>\n \n <table>\n \n <tr>\n \n <th>\n \n <b>Resource Type</b>\n \n </th>\n \n <th>\n \n <b>Profile</b>\n \n </th>\n \n <th>\n \n <b>Read</b>\n \n </th>\n \n <th>\n \n <b>V-Read</b>\n \n </th>\n \n <th>\n \n <b>Search</b>\n \n </th>\n \n <th>\n \n <b>Update</b>\n \n </th>\n \n <th>\n \n <b>Updates</b>\n \n </th>\n \n <th>\n \n <b>Create</b>\n \n </th>\n \n <th>\n \n <b>Delete</b>\n \n </th>\n \n <th>\n \n <b>History</b>\n \n </th>\n \n </tr>\n \n </table>\n \n </div>"
},
"url": "http://hl7.org/fhir/knowledge-repository",
"name": "Knowledge Repository Service Conformance Statement",
"status": "draft",
"date": "2017-02-25",
"publisher": "HL7, Inc",
"contact": [
{
"name": "FHIR Project",
"telecom": [
{
"system": "other",
"value": "http://hl7.org/fhir"
}
]
}
],
"description": "Basic conformance statement for a Knowledge Repository Service. A server can support more functionality than defined here, but this is the minimum amount",
"kind": "capability",
"software": {
"name": "ACME Knowledge Repository Service"
"url" : "http://hl7.org/fhir/knowledge-repository",
"name" : "KnowledgeRepositoryServiceConformanceStatement",
"title" : "Knowledge Repository Service Conformance Statement",
"status" : "draft",
"date" : "2017-02-25",
"publisher" : "HL7, Inc",
"contact" : [{
"name" : "FHIR Project",
"telecom" : [{
"system" : "other",
"value" : "http://hl7.org/fhir"
}]
}],
"description" : "Basic conformance statement for a Knowledge Repository Service. A server can support more functionality than defined here, but this is the minimum amount",
"kind" : "capability",
"software" : {
"name" : "ACME Knowledge Repository Service"
},
"fhirVersion": "4.0.1",
"format": [
"json",
"xml"
],
"rest": [
"fhirVersion" : "5.0.0",
"format" : ["json",
"xml"],
"rest" : [{
"mode" : "server",
"documentation" : "RESTful Knowledge Repository Service",
"security" : {
"cors" : true,
"service" : [{
"coding" : [{
"system" : "http://hl7.org/fhir/restful-security-service",
"code" : "Certificates"
}]
}]
},
"resource" : [{
"type" : "Library",
"profile" : "http://hl7.org/fhir/StructureDefinition/Library",
"interaction" : [{
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the libraries"
},
{
"code" : "search-type",
"documentation" : "Search allows clients to filter libraries based on a provided search parameter"
}],
"searchParam" : [{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-description",
"type" : "string"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-identifier",
"type" : "token"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-status",
"type" : "token"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-title",
"type" : "string"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-topic",
"type" : "token"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-version",
"type" : "token"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type" : "reference"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-depends-on",
"type" : "reference"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-derived-from",
"type" : "reference"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-predecessor",
"type" : "reference"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/Library-successor",
"type" : "reference"
}]
},
{
"mode": "server",
"documentation": "RESTful Knowledge Repository Service",
"security": {
"cors": true,
"service": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code": "Certificates"
}
]
}
]
"type" : "PlanDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/PlanDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the plan definitions"
},
"resource": [
{
"type": "Library",
"profile": "StructureDefinition/Library",
"interaction": [
{
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the libraries"
},
{
"code": "search-type",
"documentation": "Search allows clients to filter libraries based on a provided search parameter"
}
],
"searchParam": [
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Library-description",
"type": "string"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Library-identifier",
"type": "token"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Library-status",
"type": "token"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Library-title",
"type": "string"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/Library-topic",
"type": "token"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Library-version",
"type": "string"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/Library-composed-of",
"type": "reference"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/Library-depends-on",
"type": "reference"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/Library-derived-from",
"type": "reference"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/Library-predecessor",
"type": "reference"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/Library-successor",
"type": "reference"
}
]
},
{
"type": "PlanDefinition",
"profile": "StructureDefinition/PlanDefinition",
"interaction": [
{
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the plan definitions"
},
{
"code": "search-type",
"documentation": "Search allows clients to filter plan definitions based on a provided search parameter"
}
],
"searchParam": [
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-description",
"type": "string"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
"type": "token"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-status",
"type": "token"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
"type": "string"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-topic",
"type": "token"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-version",
"type": "string"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-composed-of",
"type": "reference"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on",
"type": "reference"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from",
"type": "reference"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor",
"type": "reference"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/PlanDefinition-successor",
"type": "reference"
}
]
},
{
"type": "ActivityDefinition",
"profile": "StructureDefinition/ActivityDefinition",
"interaction": [
{
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the activity definitions"
},
{
"code": "search-type",
"documentation": "Search allows clients to filter activity definitions based on a provided search parameter"
}
],
"searchParam": [
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-description",
"type": "string"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier",
"type": "token"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-status",
"type": "token"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-title",
"type": "string"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic",
"type": "token"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-version",
"type": "string"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of",
"type": "reference"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on",
"type": "reference"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from",
"type": "reference"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor",
"type": "reference"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor",
"type": "reference"
}
]
},
{
"type": "Measure",
"profile": "StructureDefinition/Measure",
"interaction": [
{
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the measures"
},
{
"code": "search-type",
"documentation": "Search allows clients to filter measures based on a provided search parameter"
}
],
"searchParam": [
{
"name": "description",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-description",
"type": "string"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-identifier",
"type": "token"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-status",
"type": "token"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-title",
"type": "string"
},
{
"name": "topic",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-topic",
"type": "token"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-version",
"type": "string"
},
{
"name": "composed-of",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-composed-of",
"type": "reference"
},
{
"name": "depends-on",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-depends-on",
"type": "reference"
},
{
"name": "derived-from",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-derived-from",
"type": "reference"
},
{
"name": "predecessor",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-predecessor",
"type": "reference"
},
{
"name": "successor",
"definition": "http://hl7.org/fhir/SearchParameter/Measure-successor",
"type": "reference"
}
]
},
{
"type": "Questionnaire",
"profile": "StructureDefinition/Questionnaire",
"interaction": [
{
"code": "read",
"documentation": "Read allows clients to get the logical definitions of the measures"
},
{
"code": "search-type",
"documentation": "Search allows clients to filter measures based on a provided search parameter"
}
],
"searchParam": [
{
"name": "code",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-code",
"type": "token"
},
{
"name": "context",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-context",
"type": "token"
},
{
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-date",
"type": "date"
},
{
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-identifier",
"type": "token"
},
{
"name": "publisher",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-publisher",
"type": "string"
},
{
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type": "token"
},
{
"name": "title",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type": "string"
},
{
"name": "version",
"definition": "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type": "string"
}
]
}
],
"operation": [
{
"name": "data-requirements",
"definition": "OperationDefinition/Library-data-requirements"
}
]
}
]
{
"code" : "search-type",
"documentation" : "Search allows clients to filter plan definitions based on a provided search parameter"
}],
"searchParam" : [{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-description",
"type" : "string"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-identifier",
"type" : "token"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-status",
"type" : "token"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-title",
"type" : "string"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-topic",
"type" : "token"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-version",
"type" : "token"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-composed-of",
"type" : "reference"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-depends-on",
"type" : "reference"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-derived-from",
"type" : "reference"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-predecessor",
"type" : "reference"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/PlanDefinition-successor",
"type" : "reference"
}]
},
{
"type" : "ActivityDefinition",
"profile" : "http://hl7.org/fhir/StructureDefinition/ActivityDefinition",
"interaction" : [{
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the activity definitions"
},
{
"code" : "search-type",
"documentation" : "Search allows clients to filter activity definitions based on a provided search parameter"
}],
"searchParam" : [{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-description",
"type" : "string"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-identifier",
"type" : "token"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-status",
"type" : "token"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-title",
"type" : "string"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-topic",
"type" : "token"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-version",
"type" : "token"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-composed-of",
"type" : "reference"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-depends-on",
"type" : "reference"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-derived-from",
"type" : "reference"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-predecessor",
"type" : "reference"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/ActivityDefinition-successor",
"type" : "reference"
}]
},
{
"type" : "Measure",
"profile" : "http://hl7.org/fhir/StructureDefinition/Measure",
"interaction" : [{
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the measures"
},
{
"code" : "search-type",
"documentation" : "Search allows clients to filter measures based on a provided search parameter"
}],
"searchParam" : [{
"name" : "description",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-description",
"type" : "string"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-identifier",
"type" : "token"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-status",
"type" : "token"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-title",
"type" : "string"
},
{
"name" : "topic",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-topic",
"type" : "token"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-version",
"type" : "token"
},
{
"name" : "composed-of",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-composed-of",
"type" : "reference"
},
{
"name" : "depends-on",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-depends-on",
"type" : "reference"
},
{
"name" : "derived-from",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-derived-from",
"type" : "reference"
},
{
"name" : "predecessor",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-predecessor",
"type" : "reference"
},
{
"name" : "successor",
"definition" : "http://hl7.org/fhir/SearchParameter/Measure-successor",
"type" : "reference"
}]
},
{
"type" : "Questionnaire",
"profile" : "http://hl7.org/fhir/StructureDefinition/Questionnaire",
"interaction" : [{
"code" : "read",
"documentation" : "Read allows clients to get the logical definitions of the measures"
},
{
"code" : "search-type",
"documentation" : "Search allows clients to filter measures based on a provided search parameter"
}],
"searchParam" : [{
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-code",
"type" : "token"
},
{
"name" : "context",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-context",
"type" : "token"
},
{
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-date",
"type" : "date"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-identifier",
"type" : "token"
},
{
"name" : "publisher",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-publisher",
"type" : "string"
},
{
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-status",
"type" : "token"
},
{
"name" : "title",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-title",
"type" : "string"
},
{
"name" : "version",
"definition" : "http://hl7.org/fhir/SearchParameter/Questionnaire-version",
"type" : "token"
}]
}],
"operation" : [{
"name" : "data-requirements",
"definition" : "http://hl7.org/fhir/OperationDefinition/Library-data-requirements"
}]
}]
}
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
4
(Technical
Correction
#1)
(v4.0.1)
R5
hl7.fhir.core#5.0.0
generated
on
Fri,
Nov
1,
2019
09:34+1100.
QA
Page
Sun,
Mar
26,
2023
15:24+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R4B
|
|
Propose
a
change