FHIR Release 3 (STU)
ConformanceThis 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
| FHIR Infrastructure Work Group | Maturity Level: 3 | Trial Use | Compartments: Not linked to any defined compartments |
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
The capability statement is a key part of the overall conformance framework in FHIR. It is used as a statement of the features of actual software, or of a set of rules for an application to provide. This statement connects to all the detailed statements of functionality, such as StructureDefinitions and ValueSets. This composite statement of application capability may be used for system compatibility testing, code generation, or as either the basis for a conformance assessment. For further information about Conformance testing, see Conformance Rules and Profiling FHIR.
Specifically, capability statements are used in one of three ways:
In this scenario, the capability statement describes the capabilities of a deployed and configured solution available at a particular access point or set of access points. The statement describes exactly how to interface with that deployed solution and thus provides for a degree of self-configuration of software solutions.
This is the type of profile that FHIR restful solutions are expected to make available on invocation of the capabilities operation. It is also the type of statement that forms a basis for the testing, certification or commissioning of specific software installations.
In this scenario, the capability statement describes generic capabilities of a software application or component solution. The solution might be available for purchase or other acquisition and might be deployed and configured at any number of independent sites. Because it is not dependent on any particular implementation, the profile cannot provide specific details such as endpoint addresses. It may also need to document various configurations in which the application can be set up or describe the degree of customizability associated with the solution.
This type of statement may be used as a marketing tool by software and system developers to formally describe their capabilities. It can also be used as the basis for conformance testing of software solutions independent of a particular installation.
In this scenario, the capability statement describes the capabilities of a desired system. It might be used as part of an architectural design process to document needed system capabilities, or might be used as part of an RFP process to formally document the requirements of a requested solution and to document the criteria by which proposals will be evaluated.
These three types of profiles can be used together. A requirements statement can be compared against the solution statements proffered by respondents to an RFP. A solution statement for a software package forms the starting point for the implementation statement associated with a particular installation of that software package.
Capability Statements provide for a degree of automatic configuration and adaptation. However, capturing absolutely every variation that could impact the interoperability of two systems, let alone keeping that detailed information up-to-date as systems evolve through maintenance and upgrades is rarely practical. Therefore, capability statements should be seen as an interim step. They provide a degree of automation. However, they also provide a great deal of human-readable content that can minimize the need for direct communication between the operators of the systems being configured to interoperate.
This resource is referenced by testscript
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  CapabilityStatement | I | DomainResource | A statement of system capabilities + There can only be one REST declaration per mode. + The set of documents must be unique by the combination of profile and mode. + Capability Statements of kind 'instance' do not have implementation elements. + Messaging end-point is required (and is only permitted) when a statement is for an implementation. + Capability Statements of kind 'requirements' do not have software or implementation elements. + A Capability Statement SHALL have at least one of description, software, or implementation element. + A Capability Statement SHALL have at least one of REST, messaging or document element. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
  url | Σ | 0..1 | uri | Logical URI to reference this capability statement (globally unique) |
| version | Σ | 0..1 | string | Business version of the capability statement |
| name | Σ | 0..1 | string | Name for this capability statement (computer friendly) |
| title | Σ | 0..1 | string | Name for this capability statement (human friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| date | Σ | 1..1 | dateTime | Date this was last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
 contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | I | 0..1 | markdown | Natural language description of the capability statement |
| useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Jurisdiction ValueSet (Extensible) |
| purpose | 0..1 | markdown | Why this capability statement is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| kind | Σ | 1..1 | code | instance | capability | requirements CapabilityStatementKind (Required) |
| instantiates | Σ | 0..* | uri | Canonical URL of another capability statement this implements |
 software | ΣI | 0..1 | BackboneElement | Software that is covered by this capability statement |
 name | Σ | 1..1 | string | A name the software is known by |
| version | Σ | 0..1 | string | Version covered by this statement |
 releaseDate | Σ | 0..1 | dateTime | Date this version released |
| implementation | ΣI | 0..1 | BackboneElement | If this describes a specific instance |
| description | Σ | 1..1 | string | Describes this specific instance |
| url | Σ | 0..1 | uri | Base URL for the installation |
| fhirVersion | Σ | 1..1 | id | FHIR Version the system uses |
| acceptUnknown | Σ | 1..1 | code | no | extensions | elements | both UnknownContentCode (Required) |
| format | Σ | 1..* | code | formats supported (xml | json | ttl | mime type) MimeType (Required) |
| patchFormat | Σ | 0..* | code | Patch formats supported MimeType (Required) |
| implementationGuide | Σ | 0..* | uri | Implementation guides supported |
 profile | Σ | 0..* | Reference(StructureDefinition) | Profiles for use cases supported |
| rest | ΣI | 0..* | BackboneElement | If the endpoint is a RESTful one + A given resource can only be described once per RESTful mode. |
| mode | Σ | 1..1 | code | client | server RestfulCapabilityMode (Required) |
| documentation | 0..1 | string | General description of implementation | |
| security | Σ | 0..1 | BackboneElement | Information about security of implementation |
| cors | Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
| service | Σ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates RestfulSecurityService (Extensible) |
| description | 0..1 | string | General description of how security works | |
| certificate | 0..* | BackboneElement | Certificates associated with security profiles | |
 type | 0..1 | code | Mime type for certificates MimeType (Required) | |
| blob | 0..1 | base64Binary | Actual certificate | |
| resource | ΣI | 0..* | BackboneElement | Resource served on the REST interface + Search parameter names must be unique in the context of a resource. |
| type | Σ | 1..1 | code | A resource type that is supported ResourceType (Required) |
| profile | Σ | 0..1 | Reference(StructureDefinition) | Base System profile for all uses of resource |
| documentation | 0..1 | markdown | Additional information about the use of the resource type | |
| interaction | 1..* | BackboneElement | What operations are supported? | |
| code | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type TypeRestfulInteraction (Required) | |
| documentation | 0..1 | string | Anything special about operation behavior | |
| versioning | 0..1 | code | no-version | versioned | versioned-update ResourceVersionPolicy (Required) | |
| readHistory | 0..1 | boolean | Whether vRead can return past versions | |
| updateCreate | 0..1 | boolean | If update can commit to a new identity | |
| conditionalCreate | 0..1 | boolean | If allows/uses conditional create | |
| conditionalRead | 0..1 | code | not-supported | modified-since | not-match | full-support ConditionalReadStatus (Required) | |
| conditionalUpdate | 0..1 | boolean | If allows/uses conditional update | |
| conditionalDelete | 0..1 | code | not-supported | single | multiple - how conditional delete is supported ConditionalDeleteStatus (Required) | |
| referencePolicy | 0..* | code | literal | logical | resolves | enforced | local ReferenceHandlingPolicy (Required) | |
| searchInclude | 0..* | string | _include values supported by the server | |
| searchRevInclude | 0..* | string | _revinclude values supported by the server | |
| searchParam | 0..* | BackboneElement | Search parameters supported by implementation | |
| name | 1..1 | string | Name of search parameter | |
| definition | 0..1 | uri | Source of definition for parameter | |
| type | 1..1 | code | number | date | string | token | reference | composite | quantity | uri SearchParamType (Required) | |
| documentation | 0..1 | string | Server-specific usage | |
| interaction | 0..* | BackboneElement | What operations are supported? | |
| code | 1..1 | code | transaction | batch | search-system | history-system SystemRestfulInteraction (Required) | |
| documentation | 0..1 | string | Anything special about operation behavior | |
 searchParam | 0..* | see searchParam | Search parameters for searching all resources | |
| operation | Σ | 0..* | BackboneElement | Definition of an operation or a custom query |
| name | 1..1 | string | Name by which the operation/query is invoked | |
| definition | Σ | 1..1 | Reference(OperationDefinition) | The defined operation/query |
| compartment | 0..* | uri | Compartments served/used by system | |
| messaging | ΣI | 0..* | BackboneElement | If messaging is supported + A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. |
| endpoint | 0..* | BackboneElement | Where messages should be sent | |
| protocol | 1..1 | Coding | http | ftp | mllp + MessageTransport (Extensible) | |
| address | 1..1 | uri | Network address or identifier of the end-point | |
| reliableCache | 0..1 | unsignedInt | Reliable Message Cache Length (min) | |
| documentation | 0..1 | string | Messaging interface behavior details | |
| supportedMessage | Σ | 0..* | BackboneElement | Messages supported by this system |
| mode | Σ | 1..1 | code | sender | receiver EventCapabilityMode (Required) |
| definition | Σ | 1..1 | Reference(MessageDefinition) | Message supported by this system |
| event | Σ | 0..* | BackboneElement | Declare support for this event |
| code | Σ | 1..1 | Coding | Event type MessageEvent (Example) |
| category | 0..1 | code | Consequence | Currency | Notification MessageSignificanceCategory (Required) | |
| mode | 1..1 | code | sender | receiver EventCapabilityMode (Required) | |
| focus | 1..1 | code | Resource that's focus of message ResourceType (Required) | |
| request | Σ | 1..1 | Reference(StructureDefinition) | Profile that describes the request |
| response | Σ | 1..1 | Reference(StructureDefinition) | Profile that describes the response |
| documentation | 0..1 | string | Endpoint-specific event documentation | |
| document | ΣI | 0..* | BackboneElement | Document definition |
| mode | 1..1 | code | producer | consumer DocumentMode (Required) | |
| documentation | 0..1 | string | Description of document support | |
| profile | Σ | 1..1 | Reference(StructureDefinition) | Constraint on a resource used in the document |
| Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<CapabilityStatement xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Logical URI to reference this capability statement (globally unique) --> <version value="[string]"/><!-- 0..1 Business version of the capability statement --> <name value="[string]"/><!-- 0..1 Name for this capability statement (computer friendly) --> <title value="[string]"/><!-- 0..1 Name for this capability statement (human friendly) --> <status value="[code]"/><!-- 1..1 draft | active | retired | unknown --> <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage --> <date value="[dateTime]"/><!-- 1..1 Date this was last changed --> <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) --> <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact> <description value="[markdown]"/><!--
0..1 Natural language description of the capability statement --> <useContext><!-- 0..* UsageContext Context the content is intended to support --></useContext> <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable) --></jurisdiction> <purpose value="[markdown]"/><!-- 0..1 Why this capability statement is defined --> <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions --> <kind value="[code]"/><!-- 1..1 instance | capability | requirements --> <instantiates value="[uri]"/><!-- 0..* Canonical URL of another capability statement this implements --> <software> <!--
JSON Template
{
"resourceType" : "CapabilityStatement",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical URI to reference this capability statement (globally unique)
"version" : "<string>", // Business version of the capability statement
"name" : "<string>", // Name for this capability statement (computer friendly)
"title" : "<string>", // Name for this capability statement (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // R! Date this was last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // C? Natural language description of the capability statement
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable)
"purpose" : "<markdown>", // Why this capability statement is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"kind" : "<code>", // R! instance | capability | requirements
"instantiates" : ["<uri>"], // Canonical URL of another capability statement this implements
"software" : { // C? Software that is covered by this capability statement
"name" : "<string>", // R! A name the software is known by
"version" : "<string>", // Version covered by this statement
"releaseDate" : "<dateTime>" // Date this version released
},
"implementation" : { // C? If this describes a specific instance
"description" : "<string>", // R! Describes this specific instance
"url" : "<uri>" // Base URL for the installation
},
"fhirVersion" : "<id>", // R! FHIR Version the system uses
"acceptUnknown" : "<code>", // R! no | extensions | elements | both
"format" : ["<code>"], // R! formats supported (xml | json | ttl | mime type)
"patchFormat" : ["<code>"], // Patch formats supported
"implementationGuide" : ["<uri>"], // Implementation guides supported
"profile" : [{ Reference(StructureDefinition) }], // Profiles for use cases supported
"rest" : [{ // C? If the endpoint is a RESTful one
"mode" : "<code>", // R! client | server
"documentation" : "<string>", // General description of implementation
"security" : { // Information about security of implementation
"cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/)
"service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
"description" : "<string>", // General description of how security works
"certificate" : [{ // Certificates associated with security profiles
"type" : "<code>", // Mime type for certificates
"blob" : "<base64Binary>" // Actual certificate
}]
},
"resource" : [{ // Resource served on the REST interface
"type" : "<code>", // R! A resource type that is supported
"profile" : { Reference(StructureDefinition) }, // Base System profile for all uses of resource
"documentation" : "<markdown>", // Additional information about the use of the resource type
"interaction" : [{ // R! What operations are supported?
"code" : "<code>", // R! read | vread | update | patch | delete | history-instance | history-type | create | search-type
"documentation" : "<string>" // Anything special about operation behavior
}],
"versioning" : "<code>", // no-version | versioned | versioned-update
"readHistory" : <boolean>, // Whether vRead can return past versions
"updateCreate" : <boolean>, // If update can commit to a new identity
"conditionalCreate" : <boolean>, // If allows/uses conditional create
"conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support
"conditionalUpdate" : <boolean>, // If allows/uses conditional update
"conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
"referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local
"searchInclude" : ["<string>"], // _include values supported by the server
"searchRevInclude" : ["<string>"], // _revinclude values supported by the server
"searchParam" : [{ // Search parameters supported by implementation
"name" : "<string>", // R! Name of search parameter
"definition" : "<uri>", // Source of definition for parameter
"type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri
"documentation" : "<string>" // Server-specific usage
}]
}],
"interaction" : [{ // What operations are supported?
"code" : "<code>", // R! transaction | batch | search-system | history-system
"documentation" : "<string>" // Anything special about operation behavior
}],
"searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources
"operation" : [{ // Definition of an operation or a custom query
"name" : "<string>", // R! Name by which the operation/query is invoked
"definition" : { Reference(OperationDefinition) } // R! The defined operation/query
}],
"compartment" : ["<uri>"] // Compartments served/used by system
}],
"messaging" : [{ // C? If messaging is supported
"endpoint" : [{ // Where messages should be sent
"protocol" : { Coding }, // R! http | ftp | mllp +
"address" : "<uri>" // R! Network address or identifier of the end-point
}],
"reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
"documentation" : "<string>", // Messaging interface behavior details
"supportedMessage" : [{ // Messages supported by this system
"mode" : "<code>", // R! sender | receiver
"definition" : { Reference(MessageDefinition) } // R! Message supported by this system
}],
"event" : [{ // Declare support for this event
"code" : { Coding }, // R! Event type
"category" : "<code>", // Consequence | Currency | Notification
"mode" : "<code>", // R! sender | receiver
"focus" : "<code>", // R! Resource that's focus of message
"request" : { Reference(StructureDefinition) }, // R! Profile that describes the request
"response" : { Reference(StructureDefinition) }, // R! Profile that describes the response
"documentation" : "<string>" // Endpoint-specific event documentation
}]
}],
"document" : [{ // C? Document definition
"mode" : "<code>", // R! producer | consumer
"documentation" : "<string>", // Description of document support
"profile" : { Reference(StructureDefinition) } // R! Constraint on a resource used in the document
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Structure
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| CapabilityStatement | I | DomainResource | A statement of system capabilities + There can only be one REST declaration per mode. + The set of documents must be unique by the combination of profile and mode. + Capability Statements of kind 'instance' do not have implementation elements. + Messaging end-point is required (and is only permitted) when a statement is for an implementation. + Capability Statements of kind 'requirements' do not have software or implementation elements. + A Capability Statement SHALL have at least one of description, software, or implementation element. + A Capability Statement SHALL have at least one of REST, messaging or document element. Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| url | Σ | 0..1 | uri | Logical URI to reference this capability statement (globally unique) |
| version | Σ | 0..1 | string | Business version of the capability statement |
| name | Σ | 0..1 | string | Name for this capability statement (computer friendly) |
| title | Σ | 0..1 | string | Name for this capability statement (human friendly) |
| status | ?!Σ | 1..1 | code | draft | active | retired | unknown PublicationStatus (Required) |
| experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
| date | Σ | 1..1 | dateTime | Date this was last changed |
| publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
| contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
| description | I | 0..1 | markdown | Natural language description of the capability statement |
| useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
| jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for capability statement (if applicable) Jurisdiction ValueSet (Extensible) |
| purpose | 0..1 | markdown | Why this capability statement is defined | |
| copyright | 0..1 | markdown | Use and/or publishing restrictions | |
| kind | Σ | 1..1 | code | instance | capability | requirements CapabilityStatementKind (Required) |
| instantiates | Σ | 0..* | uri | Canonical URL of another capability statement this implements |
| software | ΣI | 0..1 | BackboneElement | Software that is covered by this capability statement |
| name | Σ | 1..1 | string | A name the software is known by |
| version | Σ | 0..1 | string | Version covered by this statement |
| releaseDate | Σ | 0..1 | dateTime | Date this version released |
| implementation | ΣI | 0..1 | BackboneElement | If this describes a specific instance |
| description | Σ | 1..1 | string | Describes this specific instance |
| url | Σ | 0..1 | uri | Base URL for the installation |
| fhirVersion | Σ | 1..1 | id | FHIR Version the system uses |
| acceptUnknown | Σ | 1..1 | code | no | extensions | elements | both UnknownContentCode (Required) |
| format | Σ | 1..* | code | formats supported (xml | json | ttl | mime type) MimeType (Required) |
| patchFormat | Σ | 0..* | code | Patch formats supported MimeType (Required) |
| implementationGuide | Σ | 0..* | uri | Implementation guides supported |
| profile | Σ | 0..* | Reference(StructureDefinition) | Profiles for use cases supported |
| rest | ΣI | 0..* | BackboneElement | If the endpoint is a RESTful one + A given resource can only be described once per RESTful mode. |
| mode | Σ | 1..1 | code | client | server RestfulCapabilityMode (Required) |
| documentation | 0..1 | string | General description of implementation | |
| security | Σ | 0..1 | BackboneElement | Information about security of implementation |
| cors | Σ | 0..1 | boolean | Adds CORS Headers (http://enable-cors.org/) |
| service | Σ | 0..* | CodeableConcept | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates RestfulSecurityService (Extensible) |
| description | 0..1 | string | General description of how security works | |
| certificate | 0..* | BackboneElement | Certificates associated with security profiles | |
| type | 0..1 | code | Mime type for certificates MimeType (Required) | |
| blob | 0..1 | base64Binary | Actual certificate | |
| resource | ΣI | 0..* | BackboneElement | Resource served on the REST interface + Search parameter names must be unique in the context of a resource. |
| type | Σ | 1..1 | code | A resource type that is supported ResourceType (Required) |
| profile | Σ | 0..1 | Reference(StructureDefinition) | Base System profile for all uses of resource |
| documentation | 0..1 | markdown | Additional information about the use of the resource type | |
| interaction | 1..* | BackboneElement | What operations are supported? | |
| code | 1..1 | code | read | vread | update | patch | delete | history-instance | history-type | create | search-type TypeRestfulInteraction (Required) | |
| documentation | 0..1 | string | Anything special about operation behavior | |
| versioning | 0..1 | code | no-version | versioned | versioned-update ResourceVersionPolicy (Required) | |
| readHistory | 0..1 | boolean | Whether vRead can return past versions | |
| updateCreate | 0..1 | boolean | If update can commit to a new identity | |
| conditionalCreate | 0..1 | boolean | If allows/uses conditional create | |
| conditionalRead | 0..1 | code | not-supported | modified-since | not-match | full-support ConditionalReadStatus (Required) | |
| conditionalUpdate | 0..1 | boolean | If allows/uses conditional update | |
| conditionalDelete | 0..1 | code | not-supported | single | multiple - how conditional delete is supported ConditionalDeleteStatus (Required) | |
| referencePolicy | 0..* | code | literal | logical | resolves | enforced | local ReferenceHandlingPolicy (Required) | |
| searchInclude | 0..* | string | _include values supported by the server | |
| searchRevInclude | 0..* | string | _revinclude values supported by the server | |
| searchParam | 0..* | BackboneElement | Search parameters supported by implementation | |
| name | 1..1 | string | Name of search parameter | |
| definition | 0..1 | uri | Source of definition for parameter | |
| type | 1..1 | code | number | date | string | token | reference | composite | quantity | uri SearchParamType (Required) | |
| documentation | 0..1 | string | Server-specific usage | |
| interaction | 0..* | BackboneElement | What operations are supported? | |
| code | 1..1 | code | transaction | batch | search-system | history-system SystemRestfulInteraction (Required) | |
| documentation | 0..1 | string | Anything special about operation behavior | |
| searchParam | 0..* | see searchParam | Search parameters for searching all resources | |
| operation | Σ | 0..* | BackboneElement | Definition of an operation or a custom query |
| name | 1..1 | string | Name by which the operation/query is invoked | |
| definition | Σ | 1..1 | Reference(OperationDefinition) | The defined operation/query |
| compartment | 0..* | uri | Compartments served/used by system | |
| messaging | ΣI | 0..* | BackboneElement | If messaging is supported + A Capability Statement messaging element SHALL have either supportedMessage or event element, but not both. |
| endpoint | 0..* | BackboneElement | Where messages should be sent | |
| protocol | 1..1 | Coding | http | ftp | mllp + MessageTransport (Extensible) | |
| address | 1..1 | uri | Network address or identifier of the end-point | |
| reliableCache | 0..1 | unsignedInt | Reliable Message Cache Length (min) | |
| documentation | 0..1 | string | Messaging interface behavior details | |
| supportedMessage | Σ | 0..* | BackboneElement | Messages supported by this system |
| mode | Σ | 1..1 | code | sender | receiver EventCapabilityMode (Required) |
| definition | Σ | 1..1 | Reference(MessageDefinition) | Message supported by this system |
| event | Σ | 0..* | BackboneElement | Declare support for this event |
| code | Σ | 1..1 | Coding | Event type MessageEvent (Example) |
| category | 0..1 | code | Consequence | Currency | Notification MessageSignificanceCategory (Required) | |
| mode | 1..1 | code | sender | receiver EventCapabilityMode (Required) | |
| focus | 1..1 | code | Resource that's focus of message ResourceType (Required) | |
| request | Σ | 1..1 | Reference(StructureDefinition) | Profile that describes the request |
| response | Σ | 1..1 | Reference(StructureDefinition) | Profile that describes the response |
| documentation | 0..1 | string | Endpoint-specific event documentation | |
| document | ΣI | 0..* | BackboneElement | Document definition |
| mode | 1..1 | code | producer | consumer DocumentMode (Required) | |
| documentation | 0..1 | string | Description of document support | |
| profile | Σ | 1..1 | Reference(StructureDefinition) | Constraint on a resource used in the document |
| Documentation for this format | ||||
XML Template
<CapabilityStatement xmlns="http://hl7.org/fhir">
JSON Template
{
"resourceType" : "CapabilityStatement",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"url" : "<uri>", // Logical URI to reference this capability statement (globally unique)
"version" : "<string>", // Business version of the capability statement
"name" : "<string>", // Name for this capability statement (computer friendly)
"title" : "<string>", // Name for this capability statement (human friendly)
"status" : "<code>", // R! draft | active | retired | unknown
"experimental" : <boolean>, // For testing purposes, not real usage
"date" : "<dateTime>", // R! Date this was last changed
"publisher" : "<string>", // Name of the publisher (organization or individual)
"contact" : [{ ContactDetail }], // Contact details for the publisher
"description" : "<markdown>", // C? Natural language description of the capability statement
"useContext" : [{ UsageContext }], // Context the content is intended to support
"jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable)
"purpose" : "<markdown>", // Why this capability statement is defined
"copyright" : "<markdown>", // Use and/or publishing restrictions
"kind" : "<code>", // R! instance | capability | requirements
"instantiates" : ["<uri>"], // Canonical URL of another capability statement this implements
"software" : { // C? Software that is covered by this capability statement
"name" : "<string>", // R! A name the software is known by
"version" : "<string>", // Version covered by this statement
"releaseDate" : "<dateTime>" // Date this version released
},
"implementation" : { // C? If this describes a specific instance
"description" : "<string>", // R! Describes this specific instance
"url" : "<uri>" // Base URL for the installation
},
"fhirVersion" : "<id>", // R! FHIR Version the system uses
"acceptUnknown" : "<code>", // R! no | extensions | elements | both
"format" : ["<code>"], // R! formats supported (xml | json | ttl | mime type)
"patchFormat" : ["<code>"], // Patch formats supported
"implementationGuide" : ["<uri>"], // Implementation guides supported
"profile" : [{ Reference(StructureDefinition) }], // Profiles for use cases supported
"rest" : [{ // C? If the endpoint is a RESTful one
"mode" : "<code>", // R! client | server
"documentation" : "<string>", // General description of implementation
"security" : { // Information about security of implementation
"cors" : <boolean>, // Adds CORS Headers (http://enable-cors.org/)
"service" : [{ CodeableConcept }], // OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
"description" : "<string>", // General description of how security works
"certificate" : [{ // Certificates associated with security profiles
"type" : "<code>", // Mime type for certificates
"blob" : "<base64Binary>" // Actual certificate
}]
},
"resource" : [{ // Resource served on the REST interface
"type" : "<code>", // R! A resource type that is supported
"profile" : { Reference(StructureDefinition) }, // Base System profile for all uses of resource
"documentation" : "<markdown>", // Additional information about the use of the resource type
"interaction" : [{ // R! What operations are supported?
"code" : "<code>", // R! read | vread | update | patch | delete | history-instance | history-type | create | search-type
"documentation" : "<string>" // Anything special about operation behavior
}],
"versioning" : "<code>", // no-version | versioned | versioned-update
"readHistory" : <boolean>, // Whether vRead can return past versions
"updateCreate" : <boolean>, // If update can commit to a new identity
"conditionalCreate" : <boolean>, // If allows/uses conditional create
"conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support
"conditionalUpdate" : <boolean>, // If allows/uses conditional update
"conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
"referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local
"searchInclude" : ["<string>"], // _include values supported by the server
"searchRevInclude" : ["<string>"], // _revinclude values supported by the server
"searchParam" : [{ // Search parameters supported by implementation
"name" : "<string>", // R! Name of search parameter
"definition" : "<uri>", // Source of definition for parameter
"type" : "<code>", // R! number | date | string | token | reference | composite | quantity | uri
"documentation" : "<string>" // Server-specific usage
}]
}],
"interaction" : [{ // What operations are supported?
"code" : "<code>", // R! transaction | batch | search-system | history-system
"documentation" : "<string>" // Anything special about operation behavior
}],
"searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources
"operation" : [{ // Definition of an operation or a custom query
"name" : "<string>", // R! Name by which the operation/query is invoked
"definition" : { Reference(OperationDefinition) } // R! The defined operation/query
}],
"compartment" : ["<uri>"] // Compartments served/used by system
}],
"messaging" : [{ // C? If messaging is supported
"endpoint" : [{ // Where messages should be sent
"protocol" : { Coding }, // R! http | ftp | mllp +
"address" : "<uri>" // R! Network address or identifier of the end-point
}],
"reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
"documentation" : "<string>", // Messaging interface behavior details
"supportedMessage" : [{ // Messages supported by this system
"mode" : "<code>", // R! sender | receiver
"definition" : { Reference(MessageDefinition) } // R! Message supported by this system
}],
"event" : [{ // Declare support for this event
"code" : { Coding }, // R! Event type
"category" : "<code>", // Consequence | Currency | Notification
"mode" : "<code>", // R! sender | receiver
"focus" : "<code>", // R! Resource that's focus of message
"request" : { Reference(StructureDefinition) }, // R! Profile that describes the request
"response" : { Reference(StructureDefinition) }, // R! Profile that describes the response
"documentation" : "<string>" // Endpoint-specific event documentation
}]
}],
"document" : [{ // C? Document definition
"mode" : "<code>", // R! producer | consumer
"documentation" : "<string>", // Description of document support
"profile" : { Reference(StructureDefinition) } // R! Constraint on a resource used in the document
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
| Path | Definition | Type | Reference |
|---|---|---|---|
| CapabilityStatement.status | The lifecycle status of a Value Set or Concept Map. | Required | PublicationStatus |
| CapabilityStatement.jurisdiction | Countries and regions within which this artifact is targeted for use | Extensible | Jurisdiction ValueSet |
| CapabilityStatement.kind | How a capability statement is intended to be used. | Required | CapabilityStatementKind |
| CapabilityStatement.acceptUnknown | A code that indicates whether an application accepts unknown elements or extensions when reading resources. | Required | UnknownContentCode |
| CapabilityStatement.format CapabilityStatement.patchFormat CapabilityStatement.rest.security.certificate.type | The mime type of an attachment. Any valid mime type is allowed. | Required | BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) |
| CapabilityStatement.rest.mode | The mode of a RESTful capability statement. | Required | RestfulCapabilityMode |
| CapabilityStatement.rest.security.service | Types of security services used with FHIR. | Extensible | RestfulSecurityService |
| CapabilityStatement.rest.resource.type CapabilityStatement.messaging.event.focus | One of the resource types defined as part of FHIR. | Required | Resource Types |
| CapabilityStatement.rest.resource.interaction.code | Operations supported by REST at the type or instance level. | Required | TypeRestfulInteraction |
| CapabilityStatement.rest.resource.versioning | How the system supports versioning for a resource. | Required | ResourceVersionPolicy |
| CapabilityStatement.rest.resource.conditionalRead | A code that indicates how the server supports conditional read. | Required | ConditionalReadStatus |
| CapabilityStatement.rest.resource.conditionalDelete | A code that indicates how the server supports conditional delete. | Required | ConditionalDeleteStatus |
| CapabilityStatement.rest.resource.referencePolicy | A set of flags that defines how references are supported. | Required | ReferenceHandlingPolicy |
| CapabilityStatement.rest.resource.searchParam.type | Data types allowed to be used for search parameters. | Required | SearchParamType |
| CapabilityStatement.rest.interaction.code | Operations supported by REST at the system level. | Required | SystemRestfulInteraction |
| CapabilityStatement.messaging.endpoint.protocol | The protocol used for message transport. | Extensible | MessageTransport |
| CapabilityStatement.messaging.supportedMessage.mode CapabilityStatement.messaging.event.mode | The mode of a message capability statement. | Required | EventCapabilityMode |
| CapabilityStatement.messaging.event.code | One of the message events defined as part of FHIR. | Example | Message Events |
| CapabilityStatement.messaging.event.category | The impact of the content of a message. | Required | MessageSignificanceCategory |
| CapabilityStatement.document.mode | Whether the application produces or consumes documents. | Required | DocumentMode |
: rest.exists() or messaging.exists() or document.exists()) on CapabilityStatement.rest.resource: searchParam.select(name).isDistinct()): (software.empty() and implementation.empty()) or kind != 'requirements'): implementation.empty() or kind != 'capability') on CapabilityStatement.messaging: supportedMessage.empty() != event.empty()): (description.count() + software.count() + implementation.count()) > 0): messaging.endpoint.empty() or kind = 'instance'): document.select(profile.reference&mode).isDistinct()): rest.select(mode).isDistinct()) on CapabilityStatement.rest: resource.select(type).isDistinct())supportedMessage element can be used in place of the event and the work group believes it may meet
implementer needs better, however because the new mechanism has not yet been reviewed by ballot, the older 'event' mechanism has
been retained. Implementers may use one or the other to define their capabilities. Feedback is welcome.CapabilityStatement resource
does not attempt to describe service based use of resources. The various service specifications will need to describe this usage in their own way.A CapabilityStatement declares two different kinds of profiles for the functionality it describes. For a discussion of the use of these two types of resources, see two uses for profiles.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
| Name | Type | Description | Expression | In Common |
| date | date | The capability statement publication date | CapabilityStatement.date | |
| description | string | The description of the capability statement | CapabilityStatement.description | |
| event | token | Event code in a capability statement | CapabilityStatement.messaging.event.code | |
| fhirversion | token | The version of FHIR | CapabilityStatement.version | |
| format | token | formats supported (xml | json | ttl | mime type) | CapabilityStatement.format | |
| guide | uri | Implementation guides supported | CapabilityStatement.implementationGuide | |
| jurisdiction | token | Intended jurisdiction for the capability statement | CapabilityStatement.jurisdiction | |
| mode | token | Mode - restful (server/client) or messaging (sender/receiver) | CapabilityStatement.rest.mode | |
| name | string | Computationally friendly name of the capability statement | CapabilityStatement.name | |
| publisher | string | Name of the publisher of the capability statement | CapabilityStatement.publisher | |
| resource | token | Name of a resource mentioned in a capability statement | CapabilityStatement.rest.resource.type | |
| resource-profile | reference | A profile id invoked in a capability statement | CapabilityStatement.rest.resource.profile (StructureDefinition) | |
| security-service | token | OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates | CapabilityStatement.rest.security.service | |
| software | string | Part of a the name of a software application | CapabilityStatement.software.name | |
| status | token | The current status of the capability statement | CapabilityStatement.status | |
| supported-profile | reference | Profiles for use cases supported | CapabilityStatement.profile (StructureDefinition) | |
| title | string | The human-friendly name of the capability statement | CapabilityStatement.title | |
| url | uri | The uri that identifies the capability statement | CapabilityStatement.url | |
| version | token | The business version of the capability statement | CapabilityStatement.version |
®© HL7.org 2011+. FHIR Release 3 (STU; v3.0.2-11200) generated on Thurs, Oct 24, 2019 11:53+1100. QA Page
Links: Search |
Version History |
Table of Contents |
Credits |
Compare to DSTU2 |
|
Propose a change