STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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

5.3 Resource CapabilityStatement - Content

FHIR Infrastructure Work GroupMaturity Level: 2Compartments: 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.

5.3.1 Scope and Usage

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:

5.3.1.1 Describe an actual implementation

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.

5.3.1.2 Describe software solution capabilities

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.

5.3.1.3 Describe a desired solution

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.

5.3.2 Background and Context

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

5.3.3 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement IDomainResourceA 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 & mode
Capability Statements of kind 'instance' do not have implementation elements
Messaging end-point is required (and is only permitted) when 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
A Capability Statement SHALL have at least one of REST, messaging or document
... url Σ0..1uriLogical uri to reference this capability statement (globally unique)
... version Σ0..1stringBusiness version of the capability statement
... name Σ0..1stringName for this capability statement (Computer friendly)
... title Σ0..1stringName for this capability statement (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description I0..1markdownNatural language description of the capability statement
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind Σ1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... instantiates Σ0..*uriCanonical URL of another capability statement this implements
... software ΣI0..1BackboneElementSoftware that is covered by this capability statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
.... releaseDate Σ0..1dateTimeDate this version released
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1uriBase URL for the installation
... fhirVersion Σ1..1idFHIR Version the system uses
... acceptUnknown Σ1..1codeno | extensions | elements | both
UnknownContentCode (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
MimeType (Required)
... patchFormat Σ0..*codePatch formats supported
MimeType (Required)
... implementationGuide Σ0..*uriImplementation Guide supported
... profile Σ0..*Reference(StructureDefinition)Profiles for use cases supported
... rest ΣI0..*BackboneElementIf the endpoint is a RESTful one
A given resource can only be described once per RESTful mode
.... mode Σ1..1codeclient | server
RestfulCapabilityMode (Required)
.... documentation 0..1stringGeneral description of implementation
.... security Σ0..1BackboneElementInformation about security of implementation
..... cors Σ0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service Σ0..*CodeableConceptOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
RestfulSecurityService (Extensible)
..... description 0..1stringGeneral description of how security works
..... certificate 0..*BackboneElementCertificates associated with security profiles
...... type 0..1codeMime type for certificate
MimeType (Required)
...... blob 0..1base64BinaryActual certificate
.... resource ΣI0..*BackboneElementResource served on the REST interface
Search parameter names must be unique in the context of a resource
..... type Σ1..1codeA resource type that is supported
ResourceType (Required)
..... profile Σ0..1Reference(StructureDefinition)Base System profile for all uses of resource
..... documentation 0..1markdownAdditional information about the use of the resource type
..... interaction 1..*BackboneElementWhat operations are supported?
...... code 1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1stringAnything special about operation behavior
..... versioning 0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory 0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalRead 0..1codenot-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required)
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1codenot-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
..... referencePolicy 0..*codeliteral | 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..*BackboneElementSearch params supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1uriSource of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
...... documentation 0..1stringServer-specific usage
.... interaction 0..*BackboneElementWhat operations are supported?
..... code 1..1codetransaction | batch | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1stringAnything special about operation behavior
.... searchParam 0..*see searchParamSearch params for searching all resources
.... operation Σ0..*BackboneElementDefinition of an operation or a custom query
..... name 1..1stringName by which the operation/query is invoked
..... definition Σ1..1Reference(OperationDefinition)The defined operation/query
.... compartment 0..*uriCompartments served/used by system
... messaging ΣI0..*BackboneElementIf messaging is supported
.... endpoint 0..*BackboneElementWhere messages should be sent
..... protocol 1..1Codinghttp | ftp | mllp +
MessageTransport (Extensible)
..... address 1..1uriAddress of end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event Σ1..*BackboneElementDeclare support for this event
..... code Σ1..1CodingEvent type
MessageEvent (Preferred)
..... category 0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
..... mode 1..1codesender | receiver
EventCapabilityMode (Required)
..... focus 1..1codeResource that's focus of message
ResourceType (Required)
..... request Σ1..1Reference(StructureDefinition)Profile that describes the request
..... response Σ1..1Reference(StructureDefinition)Profile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document ΣI0..*BackboneElementDocument definition
.... mode 1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1stringDescription of document support
.... profile Σ1..1Reference(StructureDefinition)Constraint on a resource used in the document

doco Documentation for this format

UML Diagram (Legend)

CapabilityStatement (DomainResource)An absolute URL that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions)url : uri [0..1]The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderableversion : string [0..1]A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the capability statementtitle : string [0..1]The status of this capability statement. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A flag to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the capability statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changesdate : dateTime [1..1]The name of the individual or organization that published the capability statementpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the capability statement from the consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFPdescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitionsuseContext : UsageContext [0..*]A jurisdiction in which the capability statement is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »Explains why this capability statement is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statementcopyright : markdown [0..1]The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase)kind : code [1..1] « How a capability statement is intended to be used. (Strength=Required)CapabilityStatementKind! »Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do soinstantiates : uri [0..*]The version of the FHIR specification on which this capability statement is basedfhirVersion : id [1..1]A code that indicates whether the application accepts unknown elements or extensions when reading resourcesacceptUnknown : code [1..1] « A code that indicates whether an application accepts unknown elements or extensions when reading resources. (Strength=Required)UnknownContentCode! »A list of the formats supported by this implementation using their content typesformat : code [1..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »A list of the patch formats supported by this implementation using their content typespatchFormat : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »A list of implementation guides that the server does (or should) support in their entiretyimplementationGuide : uri [0..*]A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses)profile : Reference [0..*] « StructureDefinition »SoftwareName software is known byname : string [1..1]The version identifier for the software covered by this statementversion : string [0..1]Date this version of the software releasedreleaseDate : dateTime [0..1]ImplementationInformation about the specific installation that this capability statement relates todescription : string [1..1]An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfacesurl : uri [0..1]RestIdentifies whether this portion of the statement is describing ability to initiate or receive restful operationsmode : code [1..1] « The mode of a RESTful capability statement. (Strength=Required)RestfulCapabilityMode! »Information about the system's restful capabilities that apply across all applications, such as securitydocumentation : string [0..1]An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by it's canonical URLcompartment : uri [0..*]SecurityServer adds CORS headers when responding to requests - this enables javascript applications to use the servercors : boolean [0..1]Types of security services are supported/required by the systemservice : CodeableConcept [0..*] « Types of security services used with FHIR. (Strength=Extensible)RestfulSecurityService+ »General description of how security worksdescription : string [0..1]CertificateMime type for certificatetype : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »Actual certificateblob : base64Binary [0..1]ResourceA type of resource exposed via the restful interfacetype : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}profile : Reference [0..1] « StructureDefinition »Additional information about the resource type is used by the systemdocumentation : markdown [0..1]This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the APIversioning : code [0..1] « How the system supports versioning for a resource. (Strength=Required)ResourceVersionPolicy! »A flag for whether the server is able to return past versions as part of the vRead operationreadHistory : boolean [0..1]A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the serverupdateCreate : boolean [0..1]A flag that indicates that the server supports conditional createconditionalCreate : boolean [0..1]A code that indicates how the server supports conditional readconditionalRead : code [0..1] « A code that indicates how the server supports conditional read. (Strength=Required)ConditionalReadStatus! »A flag that indicates that the server supports conditional updateconditionalUpdate : boolean [0..1]A code that indicates how the server supports conditional deleteconditionalDelete : code [0..1] « A code that indicates how the server supports conditional delete. (Strength=Required)ConditionalDeleteStatus! »A set of flags that defines how references are supportedreferencePolicy : code [0..*] « A set of flags that defines how references are supported (Strength=Required)ReferenceHandlingPolicy! »A list of _include values supported by the serversearchInclude : string [0..*]A list of _revinclude (reverse include) values supported by the serversearchRevInclude : string [0..*]ResourceInteractionCoded identifier of the operation, supported by the system resourcecode : code [1..1] « Operations supported by REST at the type or instance level. (Strength=Required)TypeRestfulInteraction! »Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'documentation : string [0..1]SearchParamThe name of the search parameter used in the interfacename : string [1..1]An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])definition : uri [0..1]The type of value a search parameter refers to, and how the content is interpretedtype : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required)SearchParamType! »This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithmsdocumentation : string [0..1]SystemInteractionA coded identifier of the operation, supported by the systemcode : code [1..1] « Operations supported by REST at the system level. (Strength=Required)SystemRestfulInteraction! »Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implementeddocumentation : string [0..1]OperationThe name of the operation or query. For an operation, this is the name prefixed with $ and used in the url. For a query, this is the name used in the _query parameter when the query is calledname : string [1..1]Where the formal definition can be founddefinition : Reference [1..1] « OperationDefinition »MessagingLength if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender)reliableCache : unsignedInt [0..1]Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, process for becoming an authorized messaging exchange partnerdocumentation : string [0..1]EndpointA list of the messaging transport protocol(s) identifiers, supported by this endpointprotocol : Coding [1..1] « The protocol used for message transport. (Strength=Extensible)MessageTransport+ »The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifieraddress : uri [1..1]EventA coded identifier of a supported messaging eventcode : Coding [1..1] « One of the message events defined as part of FHIR. (Strength=Preferred)MessageEvent? »The impact of the content of the messagecategory : code [0..1] « The impact of the content of a message. (Strength=Required)MessageSignificanceCategory! »The mode of this event declaration - whether application is sender or receivermode : code [1..1] « The mode of a message capability statement. (Strength=Required)EventCapabilityMode! »A resource associated with the event. This is the resource that defines the eventfocus : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »Information about the request for this eventrequest : Reference [1..1] « StructureDefinition »Information about the response for this eventresponse : Reference [1..1] « StructureDefinition »Guidance on how this event is handled, such as internal system trigger points, business rules, etcdocumentation : string [0..1]DocumentMode of this document declaration - whether application is producer or consumermode : code [1..1] « Whether the application produces or consumes documents. (Strength=Required)DocumentMode! »A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etcdocumentation : string [0..1]A constraint on a resource used in the documentprofile : Reference [1..1] « StructureDefinition »Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installationsoftware[0..1]Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software programimplementation[0..1]Certificates associated with security profilescertificate[0..*]Information about security implementation from an interface perspective - what a client needs to knowsecurity[0..1]Identifies a restful operation supported by the solutioninteraction[1..*]Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementationsearchParam[0..*]A specification of the restful capabilities of the solution for a specific resource typeresource[0..*]A specification of restful operations supported by the systeminteraction[0..*]Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementationsearchParam[0..*]Definition of an operation or a named query and with its parameters and their meaning and typeoperation[0..*]An endpoint (network accessible address) to which messages and/or replies are to be sentendpoint[0..*]A description of the solution's support for an event at this end-pointevent[1..*]A description of the messaging capabilities of the solutionmessaging[0..*]A document definitiondocument[0..*]

XML Template

<CapabilityStatement xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <experimental value="[boolean]"/><!-- 0..1 If 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 Content intends to support these contexts --></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>  <!-- ?? 0..1 Software that is covered by this capability statement -->
  <name value="[string]"/><!-- 1..1 A name the software is known by -->
  <version value="[string]"/><!-- 0..1 Version covered by this statement -->
  <releaseDate value="[dateTime]"/><!-- 0..1 Date this version released -->
 </software>
 <implementation>  <!-- ?? 0..1 If this describes a specific instance -->
  <description value="[string]"/><!-- 1..1 Describes this specific instance -->
  <url value="[uri]"/><!-- 0..1 Base URL for the installation -->
 </implementation>
 <fhirVersion value="[id]"/><!-- 1..1 FHIR Version the system uses -->
 <acceptUnknown value="[code]"/><!-- 1..1 no | extensions | elements | both -->
 <format value="[code]"/><!-- 1..* formats supported (xml | json | ttl | mime type)  -->
 <patchFormat value="[code]"/><!-- 0..* Patch formats supported  -->
 <implementationGuide value="[uri]"/><!-- 0..* Implementation Guide supported -->
 <profile><!-- 0..* Reference(StructureDefinition) Profiles for use cases supported --></profile>
 <rest>  <!-- ?? 0..* If the endpoint is a RESTful one -->
  <mode value="[code]"/><!-- 1..1 client | server -->
  <documentation value="[string]"/><!-- 0..1 General description of implementation -->
  <security>  <!-- 0..1 Information about security of implementation -->
   <cors value="[boolean]"/><!-- 0..1 Adds CORS Headers (http://enable-cors.org/) -->
   <service><!-- 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates --></service>
   <description value="[string]"/><!-- 0..1 General description of how security works -->
   <certificate>  <!-- 0..* Certificates associated with security profiles -->
    <type value="[code]"/><!-- 0..1 Mime type for certificate  -->
    <blob value="[base64Binary]"/><!-- 0..1 Actual certificate -->
   </certificate>
  </security>
  <resource>  <!-- 0..* Resource served on the REST interface -->
   <type value="[code]"/><!-- 1..1 A resource type that is supported -->
   <profile><!-- 0..1 Reference(StructureDefinition) Base System profile for all uses of resource --></profile>
   <documentation value="[markdown]"/><!-- 0..1 Additional information about the use of the resource type -->
   <interaction>  <!-- 1..* What operations are supported? -->
    <code value="[code]"/><!-- 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type -->
    <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior -->
   </interaction>
   <versioning value="[code]"/><!-- 0..1 no-version | versioned | versioned-update -->
   <readHistory value="[boolean]"/><!-- 0..1 Whether vRead can return past versions -->
   <updateCreate value="[boolean]"/><!-- 0..1 If update can commit to a new identity -->
   <conditionalCreate value="[boolean]"/><!-- 0..1 If allows/uses conditional create -->
   <conditionalRead value="[code]"/><!-- 0..1 not-supported | modified-since | not-match | full-support -->
   <conditionalUpdate value="[boolean]"/><!-- 0..1 If allows/uses conditional update -->
   <conditionalDelete value="[code]"/><!-- 0..1 not-supported | single | multiple - how conditional delete is supported -->
   <referencePolicy value="[code]"/><!-- 0..* literal | logical | resolves | enforced | local -->
   <searchInclude value="[string]"/><!-- 0..* _include values supported by the server -->
   <searchRevInclude value="[string]"/><!-- 0..* _revinclude values supported by the server -->
   <searchParam>  <!-- 0..* Search params supported by implementation -->
    <name value="[string]"/><!-- 1..1 Name of search parameter -->
    <definition value="[uri]"/><!-- 0..1 Source of definition for parameter -->
    <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri -->
    <documentation value="[string]"/><!-- 0..1 Server-specific usage -->
   </searchParam>
  </resource>
  <interaction>  <!-- 0..* What operations are supported? -->
   <code value="[code]"/><!-- 1..1 transaction | batch | search-system | history-system -->
   <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior -->
  </interaction>
  <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search params for searching all resources --></searchParam>
  <operation>  <!-- 0..* Definition of an operation or a custom query -->
   <name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked -->
   <definition><!-- 1..1 Reference(OperationDefinition) The defined operation/query --></definition>
  </operation>
  <compartment value="[uri]"/><!-- 0..* Compartments served/used by system -->
 </rest>
 <messaging>  <!-- ?? 0..* If messaging is supported -->
  <endpoint>  <!-- 0..* Where messages should be sent -->
   <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol>
   <address value="[uri]"/><!-- 1..1 Address of end-point -->
  </endpoint>
  <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) -->
  <documentation value="[string]"/><!-- 0..1 Messaging interface behavior details -->
  <event>  <!-- 1..* Declare support for this event -->
   <code><!-- 1..1 Coding Event type --></code>
   <category value="[code]"/><!-- 0..1 Consequence | Currency | Notification -->
   <mode value="[code]"/><!-- 1..1 sender | receiver -->
   <focus value="[code]"/><!-- 1..1 Resource that's focus of message -->
   <request><!-- 1..1 Reference(StructureDefinition) Profile that describes the request --></request>
   <response><!-- 1..1 Reference(StructureDefinition) Profile that describes the response --></response>
   <documentation value="[string]"/><!-- 0..1 Endpoint-specific event documentation -->
  </event>
 </messaging>
 <document>  <!-- ?? 0..* Document definition -->
  <mode value="[code]"/><!-- 1..1 producer | consumer -->
  <documentation value="[string]"/><!-- 0..1 Description of document support -->
  <profile><!-- 1..1 Reference(StructureDefinition) Constraint on a resource used in the document --></profile>
 </document>
</CapabilityStatement>

JSON Template

{doco
  "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
  "experimental" : <boolean>, // If 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 }], // Content intends to support these contexts
  "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 Guide 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 certificate 
        "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 params 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 params 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!  Address of end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<string>", // Messaging interface behavior details
    "event" : [{ // R!  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/> .doco


[ a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:CapabilityStatement.url [ uri ]; # 0..1 Logical uri to reference this capability statement (globally unique)
  fhir:CapabilityStatement.version [ string ]; # 0..1 Business version of the capability statement
  fhir:CapabilityStatement.name [ string ]; # 0..1 Name for this capability statement (Computer friendly)
  fhir:CapabilityStatement.title [ string ]; # 0..1 Name for this capability statement (Human friendly)
  fhir:CapabilityStatement.status [ code ]; # 1..1 draft | active | retired
  fhir:CapabilityStatement.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:CapabilityStatement.date [ dateTime ]; # 1..1 Date this was last changed
  fhir:CapabilityStatement.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  fhir:CapabilityStatement.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:CapabilityStatement.description [ markdown ]; # 0..1 Natural language description of the capability statement
  fhir:CapabilityStatement.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:CapabilityStatement.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for capability statement (if applicable)
  fhir:CapabilityStatement.purpose [ markdown ]; # 0..1 Why this capability statement is defined
  fhir:CapabilityStatement.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:CapabilityStatement.kind [ code ]; # 1..1 instance | capability | requirements
  fhir:CapabilityStatement.instantiates [ uri ], ... ; # 0..* Canonical URL of another capability statement this implements
  fhir:CapabilityStatement.software [ # 0..1 Software that is covered by this capability statement
    fhir:CapabilityStatement.software.name [ string ]; # 1..1 A name the software is known by
    fhir:CapabilityStatement.software.version [ string ]; # 0..1 Version covered by this statement
    fhir:CapabilityStatement.software.releaseDate [ dateTime ]; # 0..1 Date this version released
  ];
  fhir:CapabilityStatement.implementation [ # 0..1 If this describes a specific instance
    fhir:CapabilityStatement.implementation.description [ string ]; # 1..1 Describes this specific instance
    fhir:CapabilityStatement.implementation.url [ uri ]; # 0..1 Base URL for the installation
  ];
  fhir:CapabilityStatement.fhirVersion [ id ]; # 1..1 FHIR Version the system uses
  fhir:CapabilityStatement.acceptUnknown [ code ]; # 1..1 no | extensions | elements | both
  fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported
  fhir:CapabilityStatement.implementationGuide [ uri ], ... ; # 0..* Implementation Guide supported
  fhir:CapabilityStatement.profile [ Reference(StructureDefinition) ], ... ; # 0..* Profiles for use cases supported
  fhir:CapabilityStatement.rest [ # 0..* If the endpoint is a RESTful one
    fhir:CapabilityStatement.rest.mode [ code ]; # 1..1 client | server
    fhir:CapabilityStatement.rest.documentation [ string ]; # 0..1 General description of implementation
    fhir:CapabilityStatement.rest.security [ # 0..1 Information about security of implementation
      fhir:CapabilityStatement.rest.security.cors [ boolean ]; # 0..1 Adds CORS Headers (http://enable-cors.org/)
      fhir:CapabilityStatement.rest.security.service [ CodeableConcept ], ... ; # 0..* OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
      fhir:CapabilityStatement.rest.security.description [ string ]; # 0..1 General description of how security works
      fhir:CapabilityStatement.rest.security.certificate [ # 0..* Certificates associated with security profiles
        fhir:CapabilityStatement.rest.security.certificate.type [ code ]; # 0..1 Mime type for certificate
        fhir:CapabilityStatement.rest.security.certificate.blob [ base64Binary ]; # 0..1 Actual certificate
      ], ...;
    ];
    fhir:CapabilityStatement.rest.resource [ # 0..* Resource served on the REST interface
      fhir:CapabilityStatement.rest.resource.type [ code ]; # 1..1 A resource type that is supported
      fhir:CapabilityStatement.rest.resource.profile [ Reference(StructureDefinition) ]; # 0..1 Base System profile for all uses of resource
      fhir:CapabilityStatement.rest.resource.documentation [ markdown ]; # 0..1 Additional information about the use of the resource type
      fhir:CapabilityStatement.rest.resource.interaction [ # 1..* What operations are supported?
        fhir:CapabilityStatement.rest.resource.interaction.code [ code ]; # 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type
        fhir:CapabilityStatement.rest.resource.interaction.documentation [ string ]; # 0..1 Anything special about operation behavior
      ], ...;
      fhir:CapabilityStatement.rest.resource.versioning [ code ]; # 0..1 no-version | versioned | versioned-update
      fhir:CapabilityStatement.rest.resource.readHistory [ boolean ]; # 0..1 Whether vRead can return past versions
      fhir:CapabilityStatement.rest.resource.updateCreate [ boolean ]; # 0..1 If update can commit to a new identity
      fhir:CapabilityStatement.rest.resource.conditionalCreate [ boolean ]; # 0..1 If allows/uses conditional create
      fhir:CapabilityStatement.rest.resource.conditionalRead [ code ]; # 0..1 not-supported | modified-since | not-match | full-support
      fhir:CapabilityStatement.rest.resource.conditionalUpdate [ boolean ]; # 0..1 If allows/uses conditional update
      fhir:CapabilityStatement.rest.resource.conditionalDelete [ code ]; # 0..1 not-supported | single | multiple - how conditional delete is supported
      fhir:CapabilityStatement.rest.resource.referencePolicy [ code ], ... ; # 0..* literal | logical | resolves | enforced | local
      fhir:CapabilityStatement.rest.resource.searchInclude [ string ], ... ; # 0..* _include values supported by the server
      fhir:CapabilityStatement.rest.resource.searchRevInclude [ string ], ... ; # 0..* _revinclude values supported by the server
      fhir:CapabilityStatement.rest.resource.searchParam [ # 0..* Search params supported by implementation
        fhir:CapabilityStatement.rest.resource.searchParam.name [ string ]; # 1..1 Name of search parameter
        fhir:CapabilityStatement.rest.resource.searchParam.definition [ uri ]; # 0..1 Source of definition for parameter
        fhir:CapabilityStatement.rest.resource.searchParam.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri
        fhir:CapabilityStatement.rest.resource.searchParam.documentation [ string ]; # 0..1 Server-specific usage
      ], ...;
    ], ...;
    fhir:CapabilityStatement.rest.interaction [ # 0..* What operations are supported?
      fhir:CapabilityStatement.rest.interaction.code [ code ]; # 1..1 transaction | batch | search-system | history-system
      fhir:CapabilityStatement.rest.interaction.documentation [ string ]; # 0..1 Anything special about operation behavior
    ], ...;
    fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search params for searching all resources
    fhir:CapabilityStatement.rest.operation [ # 0..* Definition of an operation or a custom query
      fhir:CapabilityStatement.rest.operation.name [ string ]; # 1..1 Name by which the operation/query is invoked
      fhir:CapabilityStatement.rest.operation.definition [ Reference(OperationDefinition) ]; # 1..1 The defined operation/query
    ], ...;
    fhir:CapabilityStatement.rest.compartment [ uri ], ... ; # 0..* Compartments served/used by system
  ], ...;
  fhir:CapabilityStatement.messaging [ # 0..* If messaging is supported
    fhir:CapabilityStatement.messaging.endpoint [ # 0..* Where messages should be sent
      fhir:CapabilityStatement.messaging.endpoint.protocol [ Coding ]; # 1..1 http | ftp | mllp +
      fhir:CapabilityStatement.messaging.endpoint.address [ uri ]; # 1..1 Address of end-point
    ], ...;
    fhir:CapabilityStatement.messaging.reliableCache [ unsignedInt ]; # 0..1 Reliable Message Cache Length (min)
    fhir:CapabilityStatement.messaging.documentation [ string ]; # 0..1 Messaging interface behavior details
    fhir:CapabilityStatement.messaging.event [ # 1..* Declare support for this event
      fhir:CapabilityStatement.messaging.event.code [ Coding ]; # 1..1 Event type
      fhir:CapabilityStatement.messaging.event.category [ code ]; # 0..1 Consequence | Currency | Notification
      fhir:CapabilityStatement.messaging.event.mode [ code ]; # 1..1 sender | receiver
      fhir:CapabilityStatement.messaging.event.focus [ code ]; # 1..1 Resource that's focus of message
      fhir:CapabilityStatement.messaging.event.request [ Reference(StructureDefinition) ]; # 1..1 Profile that describes the request
      fhir:CapabilityStatement.messaging.event.response [ Reference(StructureDefinition) ]; # 1..1 Profile that describes the response
      fhir:CapabilityStatement.messaging.event.documentation [ string ]; # 0..1 Endpoint-specific event documentation
    ], ...;
  ], ...;
  fhir:CapabilityStatement.document [ # 0..* Document definition
    fhir:CapabilityStatement.document.mode [ code ]; # 1..1 producer | consumer
    fhir:CapabilityStatement.document.documentation [ string ]; # 0..1 Description of document support
    fhir:CapabilityStatement.document.profile [ Reference(StructureDefinition) ]; # 1..1 Constraint on a resource used in the document
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement IDomainResourceA 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 & mode
Capability Statements of kind 'instance' do not have implementation elements
Messaging end-point is required (and is only permitted) when 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
A Capability Statement SHALL have at least one of REST, messaging or document
... url Σ0..1uriLogical uri to reference this capability statement (globally unique)
... version Σ0..1stringBusiness version of the capability statement
... name Σ0..1stringName for this capability statement (Computer friendly)
... title Σ0..1stringName for this capability statement (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... date Σ1..1dateTimeDate this was last changed
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description I0..1markdownNatural language description of the capability statement
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind Σ1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... instantiates Σ0..*uriCanonical URL of another capability statement this implements
... software ΣI0..1BackboneElementSoftware that is covered by this capability statement
.... name Σ1..1stringA name the software is known by
.... version Σ0..1stringVersion covered by this statement
.... releaseDate Σ0..1dateTimeDate this version released
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1uriBase URL for the installation
... fhirVersion Σ1..1idFHIR Version the system uses
... acceptUnknown Σ1..1codeno | extensions | elements | both
UnknownContentCode (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
MimeType (Required)
... patchFormat Σ0..*codePatch formats supported
MimeType (Required)
... implementationGuide Σ0..*uriImplementation Guide supported
... profile Σ0..*Reference(StructureDefinition)Profiles for use cases supported
... rest ΣI0..*BackboneElementIf the endpoint is a RESTful one
A given resource can only be described once per RESTful mode
.... mode Σ1..1codeclient | server
RestfulCapabilityMode (Required)
.... documentation 0..1stringGeneral description of implementation
.... security Σ0..1BackboneElementInformation about security of implementation
..... cors Σ0..1booleanAdds CORS Headers (http://enable-cors.org/)
..... service Σ0..*CodeableConceptOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
RestfulSecurityService (Extensible)
..... description 0..1stringGeneral description of how security works
..... certificate 0..*BackboneElementCertificates associated with security profiles
...... type 0..1codeMime type for certificate
MimeType (Required)
...... blob 0..1base64BinaryActual certificate
.... resource ΣI0..*BackboneElementResource served on the REST interface
Search parameter names must be unique in the context of a resource
..... type Σ1..1codeA resource type that is supported
ResourceType (Required)
..... profile Σ0..1Reference(StructureDefinition)Base System profile for all uses of resource
..... documentation 0..1markdownAdditional information about the use of the resource type
..... interaction 1..*BackboneElementWhat operations are supported?
...... code 1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1stringAnything special about operation behavior
..... versioning 0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory 0..1booleanWhether vRead can return past versions
..... updateCreate 0..1booleanIf update can commit to a new identity
..... conditionalCreate 0..1booleanIf allows/uses conditional create
..... conditionalRead 0..1codenot-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required)
..... conditionalUpdate 0..1booleanIf allows/uses conditional update
..... conditionalDelete 0..1codenot-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
..... referencePolicy 0..*codeliteral | 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..*BackboneElementSearch params supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1uriSource of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri
SearchParamType (Required)
...... documentation 0..1stringServer-specific usage
.... interaction 0..*BackboneElementWhat operations are supported?
..... code 1..1codetransaction | batch | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1stringAnything special about operation behavior
.... searchParam 0..*see searchParamSearch params for searching all resources
.... operation Σ0..*BackboneElementDefinition of an operation or a custom query
..... name 1..1stringName by which the operation/query is invoked
..... definition Σ1..1Reference(OperationDefinition)The defined operation/query
.... compartment 0..*uriCompartments served/used by system
... messaging ΣI0..*BackboneElementIf messaging is supported
.... endpoint 0..*BackboneElementWhere messages should be sent
..... protocol 1..1Codinghttp | ftp | mllp +
MessageTransport (Extensible)
..... address 1..1uriAddress of end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1stringMessaging interface behavior details
.... event Σ1..*BackboneElementDeclare support for this event
..... code Σ1..1CodingEvent type
MessageEvent (Preferred)
..... category 0..1codeConsequence | Currency | Notification
MessageSignificanceCategory (Required)
..... mode 1..1codesender | receiver
EventCapabilityMode (Required)
..... focus 1..1codeResource that's focus of message
ResourceType (Required)
..... request Σ1..1Reference(StructureDefinition)Profile that describes the request
..... response Σ1..1Reference(StructureDefinition)Profile that describes the response
..... documentation 0..1stringEndpoint-specific event documentation
... document ΣI0..*BackboneElementDocument definition
.... mode 1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1stringDescription of document support
.... profile Σ1..1Reference(StructureDefinition)Constraint on a resource used in the document

doco Documentation for this format

UML Diagram (Legend)

CapabilityStatement (DomainResource)An absolute URL that is used to identify this capability statement when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this capability statement is (or will be) published. The URL SHOULD include the major version of the capability statement. For more information see [Technical and Business Versions](resource.html#versions)url : uri [0..1]The identifier that is used to identify this version of the capability statement when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the capability statement author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderableversion : string [0..1]A natural language name identifying the capability statement. This name should be usable as an identifier for the module by machine processing applications such as code generationname : string [0..1]A short, descriptive, user-friendly title for the capability statementtitle : string [0..1]The status of this capability statement. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A flag to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage (this element modifies the meaning of other elements)experimental : boolean [0..1]The date (and optionally time) when the capability statement was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changesdate : dateTime [1..1]The name of the individual or organization that published the capability statementpublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the capability statement from the consumer's perspective. Typically, this is used when the capability statement describes a desired rather than an actual solution, for example as a formal expression of requirements as part of an RFPdescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitionsuseContext : UsageContext [0..*]A jurisdiction in which the capability statement is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use (Strength=Extensible)Jurisdiction ValueSet+ »Explains why this capability statement is needed and why it has been designed as it haspurpose : markdown [0..1]A copyright statement relating to the capability statement and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the capability statementcopyright : markdown [0..1]The way that this statement is intended to be used, to describe an actual running instance of software, a particular product (kind not instance of software) or a class of implementation (e.g. a desired purchase)kind : code [1..1] « How a capability statement is intended to be used. (Strength=Required)CapabilityStatementKind! »Reference to a canonical URL of another CapabilityStatement that this software implements or uses. This capability statement is a published API description that corresponds to a business service. The rest of the capability statement does not need to repeat the details of the referenced resource, but can do soinstantiates : uri [0..*]The version of the FHIR specification on which this capability statement is basedfhirVersion : id [1..1]A code that indicates whether the application accepts unknown elements or extensions when reading resourcesacceptUnknown : code [1..1] « A code that indicates whether an application accepts unknown elements or extensions when reading resources. (Strength=Required)UnknownContentCode! »A list of the formats supported by this implementation using their content typesformat : code [1..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »A list of the patch formats supported by this implementation using their content typespatchFormat : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »A list of implementation guides that the server does (or should) support in their entiretyimplementationGuide : uri [0..*]A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses)profile : Reference [0..*] « StructureDefinition »SoftwareName software is known byname : string [1..1]The version identifier for the software covered by this statementversion : string [0..1]Date this version of the software releasedreleaseDate : dateTime [0..1]ImplementationInformation about the specific installation that this capability statement relates todescription : string [1..1]An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfacesurl : uri [0..1]RestIdentifies whether this portion of the statement is describing ability to initiate or receive restful operationsmode : code [1..1] « The mode of a RESTful capability statement. (Strength=Required)RestfulCapabilityMode! »Information about the system's restful capabilities that apply across all applications, such as securitydocumentation : string [0..1]An absolute URI which is a reference to the definition of a compartment that the system supports. The reference is to a CompartmentDefinition resource by it's canonical URLcompartment : uri [0..*]SecurityServer adds CORS headers when responding to requests - this enables javascript applications to use the servercors : boolean [0..1]Types of security services are supported/required by the systemservice : CodeableConcept [0..*] « Types of security services used with FHIR. (Strength=Extensible)RestfulSecurityService+ »General description of how security worksdescription : string [0..1]CertificateMime type for certificatetype : code [0..1] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeType! »Actual certificateblob : base64Binary [0..1]ResourceA type of resource exposed via the restful interfacetype : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles]{profiling.html#profile-uses}profile : Reference [0..1] « StructureDefinition »Additional information about the resource type is used by the systemdocumentation : markdown [0..1]This field is set to no-version to specify that the system does not support (server) or use (client) versioning for this resource type. If this has some other value, the server must at least correctly track and populate the versionId meta-property on resources. If the value is 'versioned-update', then the server supports all the versioning features, including using e-tags for version integrity in the APIversioning : code [0..1] « How the system supports versioning for a resource. (Strength=Required)ResourceVersionPolicy! »A flag for whether the server is able to return past versions as part of the vRead operationreadHistory : boolean [0..1]A flag to indicate that the server allows or needs to allow the client to create new identities on the server (e.g. that is, the client PUTs to a location where there is no existing resource). Allowing this operation means that the server allows the client to create new identities on the serverupdateCreate : boolean [0..1]A flag that indicates that the server supports conditional createconditionalCreate : boolean [0..1]A code that indicates how the server supports conditional readconditionalRead : code [0..1] « A code that indicates how the server supports conditional read. (Strength=Required)ConditionalReadStatus! »A flag that indicates that the server supports conditional updateconditionalUpdate : boolean [0..1]A code that indicates how the server supports conditional deleteconditionalDelete : code [0..1] « A code that indicates how the server supports conditional delete. (Strength=Required)ConditionalDeleteStatus! »A set of flags that defines how references are supportedreferencePolicy : code [0..*] « A set of flags that defines how references are supported (Strength=Required)ReferenceHandlingPolicy! »A list of _include values supported by the serversearchInclude : string [0..*]A list of _revinclude (reverse include) values supported by the serversearchRevInclude : string [0..*]ResourceInteractionCoded identifier of the operation, supported by the system resourcecode : code [1..1] « Operations supported by REST at the type or instance level. (Strength=Required)TypeRestfulInteraction! »Guidance specific to the implementation of this operation, such as 'delete is a logical delete' or 'updates are only allowed with version id' or 'creates permitted from pre-authorized certificates only'documentation : string [0..1]SearchParamThe name of the search parameter used in the interfacename : string [1..1]An absolute URI that is a formal reference to where this parameter was first defined, so that a client can be confident of the meaning of the search parameter (a reference to [[[SearchParameter.url]]])definition : uri [0..1]The type of value a search parameter refers to, and how the content is interpretedtype : code [1..1] « Data types allowed to be used for search parameters. (Strength=Required)SearchParamType! »This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithmsdocumentation : string [0..1]SystemInteractionA coded identifier of the operation, supported by the systemcode : code [1..1] « Operations supported by REST at the system level. (Strength=Required)SystemRestfulInteraction! »Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implementeddocumentation : string [0..1]OperationThe name of the operation or query. For an operation, this is the name prefixed with $ and used in the url. For a query, this is the name used in the _query parameter when the query is calledname : string [1..1]Where the formal definition can be founddefinition : Reference [1..1] « OperationDefinition »MessagingLength if the receiver's reliable messaging cache in minutes (if a receiver) or how long the cache length on the receiver should be (if a sender)reliableCache : unsignedInt [0..1]Documentation about the system's messaging capabilities for this endpoint not otherwise documented by the capability statement. For example, process for becoming an authorized messaging exchange partnerdocumentation : string [0..1]EndpointA list of the messaging transport protocol(s) identifiers, supported by this endpointprotocol : Coding [1..1] « The protocol used for message transport. (Strength=Extensible)MessageTransport+ »The network address of the end-point. For solutions that do not use network addresses for routing, it can be just an identifieraddress : uri [1..1]EventA coded identifier of a supported messaging eventcode : Coding [1..1] « One of the message events defined as part of FHIR. (Strength=Preferred)MessageEvent? »The impact of the content of the messagecategory : code [0..1] « The impact of the content of a message. (Strength=Required)MessageSignificanceCategory! »The mode of this event declaration - whether application is sender or receivermode : code [1..1] « The mode of a message capability statement. (Strength=Required)EventCapabilityMode! »A resource associated with the event. This is the resource that defines the eventfocus : code [1..1] « One of the resource types defined as part of FHIR. (Strength=Required)ResourceType! »Information about the request for this eventrequest : Reference [1..1] « StructureDefinition »Information about the response for this eventresponse : Reference [1..1] « StructureDefinition »Guidance on how this event is handled, such as internal system trigger points, business rules, etcdocumentation : string [0..1]DocumentMode of this document declaration - whether application is producer or consumermode : code [1..1] « Whether the application produces or consumes documents. (Strength=Required)DocumentMode! »A description of how the application supports or uses the specified document profile. For example, when are documents created, what action is taken with consumed documents, etcdocumentation : string [0..1]A constraint on a resource used in the documentprofile : Reference [1..1] « StructureDefinition »Software that is covered by this capability statement. It is used when the capability statement describes the capabilities of a particular software version, independent of an installationsoftware[0..1]Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software programimplementation[0..1]Certificates associated with security profilescertificate[0..*]Information about security implementation from an interface perspective - what a client needs to knowsecurity[0..1]Identifies a restful operation supported by the solutioninteraction[1..*]Search parameters for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementationsearchParam[0..*]A specification of the restful capabilities of the solution for a specific resource typeresource[0..*]A specification of restful operations supported by the systeminteraction[0..*]Search parameters that are supported for searching all resources for implementations to support and/or make use of - either references to ones defined in the specification, or additional ones defined for/by the implementationsearchParam[0..*]Definition of an operation or a named query and with its parameters and their meaning and typeoperation[0..*]An endpoint (network accessible address) to which messages and/or replies are to be sentendpoint[0..*]A description of the solution's support for an event at this end-pointevent[1..*]A description of the messaging capabilities of the solutionmessaging[0..*]A document definitiondocument[0..*]

XML Template

<CapabilityStatement xmlns="http://hl7.org/fhir"> doco
 <!-- 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 -->
 <experimental value="[boolean]"/><!-- 0..1 If 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 Content intends to support these contexts --></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>  <!-- ?? 0..1 Software that is covered by this capability statement -->
  <name value="[string]"/><!-- 1..1 A name the software is known by -->
  <version value="[string]"/><!-- 0..1 Version covered by this statement -->
  <releaseDate value="[dateTime]"/><!-- 0..1 Date this version released -->
 </software>
 <implementation>  <!-- ?? 0..1 If this describes a specific instance -->
  <description value="[string]"/><!-- 1..1 Describes this specific instance -->
  <url value="[uri]"/><!-- 0..1 Base URL for the installation -->
 </implementation>
 <fhirVersion value="[id]"/><!-- 1..1 FHIR Version the system uses -->
 <acceptUnknown value="[code]"/><!-- 1..1 no | extensions | elements | both -->
 <format value="[code]"/><!-- 1..* formats supported (xml | json | ttl | mime type)  -->
 <patchFormat value="[code]"/><!-- 0..* Patch formats supported  -->
 <implementationGuide value="[uri]"/><!-- 0..* Implementation Guide supported -->
 <profile><!-- 0..* Reference(StructureDefinition) Profiles for use cases supported --></profile>
 <rest>  <!-- ?? 0..* If the endpoint is a RESTful one -->
  <mode value="[code]"/><!-- 1..1 client | server -->
  <documentation value="[string]"/><!-- 0..1 General description of implementation -->
  <security>  <!-- 0..1 Information about security of implementation -->
   <cors value="[boolean]"/><!-- 0..1 Adds CORS Headers (http://enable-cors.org/) -->
   <service><!-- 0..* CodeableConcept OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates --></service>
   <description value="[string]"/><!-- 0..1 General description of how security works -->
   <certificate>  <!-- 0..* Certificates associated with security profiles -->
    <type value="[code]"/><!-- 0..1 Mime type for certificate  -->
    <blob value="[base64Binary]"/><!-- 0..1 Actual certificate -->
   </certificate>
  </security>
  <resource>  <!-- 0..* Resource served on the REST interface -->
   <type value="[code]"/><!-- 1..1 A resource type that is supported -->
   <profile><!-- 0..1 Reference(StructureDefinition) Base System profile for all uses of resource --></profile>
   <documentation value="[markdown]"/><!-- 0..1 Additional information about the use of the resource type -->
   <interaction>  <!-- 1..* What operations are supported? -->
    <code value="[code]"/><!-- 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type -->
    <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior -->
   </interaction>
   <versioning value="[code]"/><!-- 0..1 no-version | versioned | versioned-update -->
   <readHistory value="[boolean]"/><!-- 0..1 Whether vRead can return past versions -->
   <updateCreate value="[boolean]"/><!-- 0..1 If update can commit to a new identity -->
   <conditionalCreate value="[boolean]"/><!-- 0..1 If allows/uses conditional create -->
   <conditionalRead value="[code]"/><!-- 0..1 not-supported | modified-since | not-match | full-support -->
   <conditionalUpdate value="[boolean]"/><!-- 0..1 If allows/uses conditional update -->
   <conditionalDelete value="[code]"/><!-- 0..1 not-supported | single | multiple - how conditional delete is supported -->
   <referencePolicy value="[code]"/><!-- 0..* literal | logical | resolves | enforced | local -->
   <searchInclude value="[string]"/><!-- 0..* _include values supported by the server -->
   <searchRevInclude value="[string]"/><!-- 0..* _revinclude values supported by the server -->
   <searchParam>  <!-- 0..* Search params supported by implementation -->
    <name value="[string]"/><!-- 1..1 Name of search parameter -->
    <definition value="[uri]"/><!-- 0..1 Source of definition for parameter -->
    <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri -->
    <documentation value="[string]"/><!-- 0..1 Server-specific usage -->
   </searchParam>
  </resource>
  <interaction>  <!-- 0..* What operations are supported? -->
   <code value="[code]"/><!-- 1..1 transaction | batch | search-system | history-system -->
   <documentation value="[string]"/><!-- 0..1 Anything special about operation behavior -->
  </interaction>
  <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search params for searching all resources --></searchParam>
  <operation>  <!-- 0..* Definition of an operation or a custom query -->
   <name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked -->
   <definition><!-- 1..1 Reference(OperationDefinition) The defined operation/query --></definition>
  </operation>
  <compartment value="[uri]"/><!-- 0..* Compartments served/used by system -->
 </rest>
 <messaging>  <!-- ?? 0..* If messaging is supported -->
  <endpoint>  <!-- 0..* Where messages should be sent -->
   <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol>
   <address value="[uri]"/><!-- 1..1 Address of end-point -->
  </endpoint>
  <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) -->
  <documentation value="[string]"/><!-- 0..1 Messaging interface behavior details -->
  <event>  <!-- 1..* Declare support for this event -->
   <code><!-- 1..1 Coding Event type --></code>
   <category value="[code]"/><!-- 0..1 Consequence | Currency | Notification -->
   <mode value="[code]"/><!-- 1..1 sender | receiver -->
   <focus value="[code]"/><!-- 1..1 Resource that's focus of message -->
   <request><!-- 1..1 Reference(StructureDefinition) Profile that describes the request --></request>
   <response><!-- 1..1 Reference(StructureDefinition) Profile that describes the response --></response>
   <documentation value="[string]"/><!-- 0..1 Endpoint-specific event documentation -->
  </event>
 </messaging>
 <document>  <!-- ?? 0..* Document definition -->
  <mode value="[code]"/><!-- 1..1 producer | consumer -->
  <documentation value="[string]"/><!-- 0..1 Description of document support -->
  <profile><!-- 1..1 Reference(StructureDefinition) Constraint on a resource used in the document --></profile>
 </document>
</CapabilityStatement>

JSON Template

{doco
  "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
  "experimental" : <boolean>, // If 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 }], // Content intends to support these contexts
  "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 Guide 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 certificate 
        "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 params 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 params 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!  Address of end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<string>", // Messaging interface behavior details
    "event" : [{ // R!  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/> .doco


[ a fhir:CapabilityStatement;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:CapabilityStatement.url [ uri ]; # 0..1 Logical uri to reference this capability statement (globally unique)
  fhir:CapabilityStatement.version [ string ]; # 0..1 Business version of the capability statement
  fhir:CapabilityStatement.name [ string ]; # 0..1 Name for this capability statement (Computer friendly)
  fhir:CapabilityStatement.title [ string ]; # 0..1 Name for this capability statement (Human friendly)
  fhir:CapabilityStatement.status [ code ]; # 1..1 draft | active | retired
  fhir:CapabilityStatement.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  fhir:CapabilityStatement.date [ dateTime ]; # 1..1 Date this was last changed
  fhir:CapabilityStatement.publisher [ string ]; # 0..1 Name of the publisher (Organization or individual)
  fhir:CapabilityStatement.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:CapabilityStatement.description [ markdown ]; # 0..1 Natural language description of the capability statement
  fhir:CapabilityStatement.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  fhir:CapabilityStatement.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for capability statement (if applicable)
  fhir:CapabilityStatement.purpose [ markdown ]; # 0..1 Why this capability statement is defined
  fhir:CapabilityStatement.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:CapabilityStatement.kind [ code ]; # 1..1 instance | capability | requirements
  fhir:CapabilityStatement.instantiates [ uri ], ... ; # 0..* Canonical URL of another capability statement this implements
  fhir:CapabilityStatement.software [ # 0..1 Software that is covered by this capability statement
    fhir:CapabilityStatement.software.name [ string ]; # 1..1 A name the software is known by
    fhir:CapabilityStatement.software.version [ string ]; # 0..1 Version covered by this statement
    fhir:CapabilityStatement.software.releaseDate [ dateTime ]; # 0..1 Date this version released
  ];
  fhir:CapabilityStatement.implementation [ # 0..1 If this describes a specific instance
    fhir:CapabilityStatement.implementation.description [ string ]; # 1..1 Describes this specific instance
    fhir:CapabilityStatement.implementation.url [ uri ]; # 0..1 Base URL for the installation
  ];
  fhir:CapabilityStatement.fhirVersion [ id ]; # 1..1 FHIR Version the system uses
  fhir:CapabilityStatement.acceptUnknown [ code ]; # 1..1 no | extensions | elements | both
  fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported
  fhir:CapabilityStatement.implementationGuide [ uri ], ... ; # 0..* Implementation Guide supported
  fhir:CapabilityStatement.profile [ Reference(StructureDefinition) ], ... ; # 0..* Profiles for use cases supported
  fhir:CapabilityStatement.rest [ # 0..* If the endpoint is a RESTful one
    fhir:CapabilityStatement.rest.mode [ code ]; # 1..1 client | server
    fhir:CapabilityStatement.rest.documentation [ string ]; # 0..1 General description of implementation
    fhir:CapabilityStatement.rest.security [ # 0..1 Information about security of implementation
      fhir:CapabilityStatement.rest.security.cors [ boolean ]; # 0..1 Adds CORS Headers (http://enable-cors.org/)
      fhir:CapabilityStatement.rest.security.service [ CodeableConcept ], ... ; # 0..* OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
      fhir:CapabilityStatement.rest.security.description [ string ]; # 0..1 General description of how security works
      fhir:CapabilityStatement.rest.security.certificate [ # 0..* Certificates associated with security profiles
        fhir:CapabilityStatement.rest.security.certificate.type [ code ]; # 0..1 Mime type for certificate
        fhir:CapabilityStatement.rest.security.certificate.blob [ base64Binary ]; # 0..1 Actual certificate
      ], ...;
    ];
    fhir:CapabilityStatement.rest.resource [ # 0..* Resource served on the REST interface
      fhir:CapabilityStatement.rest.resource.type [ code ]; # 1..1 A resource type that is supported
      fhir:CapabilityStatement.rest.resource.profile [ Reference(StructureDefinition) ]; # 0..1 Base System profile for all uses of resource
      fhir:CapabilityStatement.rest.resource.documentation [ markdown ]; # 0..1 Additional information about the use of the resource type
      fhir:CapabilityStatement.rest.resource.interaction [ # 1..* What operations are supported?
        fhir:CapabilityStatement.rest.resource.interaction.code [ code ]; # 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type
        fhir:CapabilityStatement.rest.resource.interaction.documentation [ string ]; # 0..1 Anything special about operation behavior
      ], ...;
      fhir:CapabilityStatement.rest.resource.versioning [ code ]; # 0..1 no-version | versioned | versioned-update
      fhir:CapabilityStatement.rest.resource.readHistory [ boolean ]; # 0..1 Whether vRead can return past versions
      fhir:CapabilityStatement.rest.resource.updateCreate [ boolean ]; # 0..1 If update can commit to a new identity
      fhir:CapabilityStatement.rest.resource.conditionalCreate [ boolean ]; # 0..1 If allows/uses conditional create
      fhir:CapabilityStatement.rest.resource.conditionalRead [ code ]; # 0..1 not-supported | modified-since | not-match | full-support
      fhir:CapabilityStatement.rest.resource.conditionalUpdate [ boolean ]; # 0..1 If allows/uses conditional update
      fhir:CapabilityStatement.rest.resource.conditionalDelete [ code ]; # 0..1 not-supported | single | multiple - how conditional delete is supported
      fhir:CapabilityStatement.rest.resource.referencePolicy [ code ], ... ; # 0..* literal | logical | resolves | enforced | local
      fhir:CapabilityStatement.rest.resource.searchInclude [ string ], ... ; # 0..* _include values supported by the server
      fhir:CapabilityStatement.rest.resource.searchRevInclude [ string ], ... ; # 0..* _revinclude values supported by the server
      fhir:CapabilityStatement.rest.resource.searchParam [ # 0..* Search params supported by implementation
        fhir:CapabilityStatement.rest.resource.searchParam.name [ string ]; # 1..1 Name of search parameter
        fhir:CapabilityStatement.rest.resource.searchParam.definition [ uri ]; # 0..1 Source of definition for parameter
        fhir:CapabilityStatement.rest.resource.searchParam.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri
        fhir:CapabilityStatement.rest.resource.searchParam.documentation [ string ]; # 0..1 Server-specific usage
      ], ...;
    ], ...;
    fhir:CapabilityStatement.rest.interaction [ # 0..* What operations are supported?
      fhir:CapabilityStatement.rest.interaction.code [ code ]; # 1..1 transaction | batch | search-system | history-system
      fhir:CapabilityStatement.rest.interaction.documentation [ string ]; # 0..1 Anything special about operation behavior
    ], ...;
    fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search params for searching all resources
    fhir:CapabilityStatement.rest.operation [ # 0..* Definition of an operation or a custom query
      fhir:CapabilityStatement.rest.operation.name [ string ]; # 1..1 Name by which the operation/query is invoked
      fhir:CapabilityStatement.rest.operation.definition [ Reference(OperationDefinition) ]; # 1..1 The defined operation/query
    ], ...;
    fhir:CapabilityStatement.rest.compartment [ uri ], ... ; # 0..* Compartments served/used by system
  ], ...;
  fhir:CapabilityStatement.messaging [ # 0..* If messaging is supported
    fhir:CapabilityStatement.messaging.endpoint [ # 0..* Where messages should be sent
      fhir:CapabilityStatement.messaging.endpoint.protocol [ Coding ]; # 1..1 http | ftp | mllp +
      fhir:CapabilityStatement.messaging.endpoint.address [ uri ]; # 1..1 Address of end-point
    ], ...;
    fhir:CapabilityStatement.messaging.reliableCache [ unsignedInt ]; # 0..1 Reliable Message Cache Length (min)
    fhir:CapabilityStatement.messaging.documentation [ string ]; # 0..1 Messaging interface behavior details
    fhir:CapabilityStatement.messaging.event [ # 1..* Declare support for this event
      fhir:CapabilityStatement.messaging.event.code [ Coding ]; # 1..1 Event type
      fhir:CapabilityStatement.messaging.event.category [ code ]; # 0..1 Consequence | Currency | Notification
      fhir:CapabilityStatement.messaging.event.mode [ code ]; # 1..1 sender | receiver
      fhir:CapabilityStatement.messaging.event.focus [ code ]; # 1..1 Resource that's focus of message
      fhir:CapabilityStatement.messaging.event.request [ Reference(StructureDefinition) ]; # 1..1 Profile that describes the request
      fhir:CapabilityStatement.messaging.event.response [ Reference(StructureDefinition) ]; # 1..1 Profile that describes the response
      fhir:CapabilityStatement.messaging.event.documentation [ string ]; # 0..1 Endpoint-specific event documentation
    ], ...;
  ], ...;
  fhir:CapabilityStatement.document [ # 0..* Document definition
    fhir:CapabilityStatement.document.mode [ code ]; # 1..1 producer | consumer
    fhir:CapabilityStatement.document.documentation [ string ]; # 0..1 Description of document support
    fhir:CapabilityStatement.document.profile [ Reference(StructureDefinition) ]; # 1..1 Constraint on a resource used in the document
  ], ...;
]

Changes since DSTU2

This resource did not exist in Release 2

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

5.3.3.1 Terminology Bindings

PathDefinitionTypeReference
CapabilityStatement.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
CapabilityStatement.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
CapabilityStatement.kind How a capability statement is intended to be used.RequiredCapabilityStatementKind
CapabilityStatement.acceptUnknown A code that indicates whether an application accepts unknown elements or extensions when reading resources.RequiredUnknownContentCode
CapabilityStatement.format
CapabilityStatement.patchFormat
CapabilityStatement.rest.security.certificate.type 		The mime type of an attachment. Any valid mime type is allowed.RequiredBCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
CapabilityStatement.rest.mode The mode of a RESTful capability statement.RequiredRestfulCapabilityMode
CapabilityStatement.rest.security.service Types of security services used with FHIR.ExtensibleRestfulSecurityService
CapabilityStatement.rest.resource.type
CapabilityStatement.messaging.event.focus 		One of the resource types defined as part of FHIR.Requiredhttp://hl7.org/fhir/valueset/resource-typesResourceType
CapabilityStatement.rest.resource.interaction.code Operations supported by REST at the type or instance level.RequiredTypeRestfulInteraction
CapabilityStatement.rest.resource.versioning How the system supports versioning for a resource.RequiredResourceVersionPolicy
CapabilityStatement.rest.resource.conditionalRead A code that indicates how the server supports conditional read.RequiredConditionalReadStatus
CapabilityStatement.rest.resource.conditionalDelete A code that indicates how the server supports conditional delete.RequiredConditionalDeleteStatus
CapabilityStatement.rest.resource.referencePolicy A set of flags that defines how references are supportedRequiredReferenceHandlingPolicy
CapabilityStatement.rest.resource.searchParam.type Data types allowed to be used for search parameters.RequiredSearchParamType
CapabilityStatement.rest.interaction.code Operations supported by REST at the system level.RequiredSystemRestfulInteraction
CapabilityStatement.messaging.endpoint.protocol The protocol used for message transport.ExtensibleMessageTransport
CapabilityStatement.messaging.event.code One of the message events defined as part of FHIR.Preferredhttp://hl7.org/fhir/valueset/message-eventsMessageEvent
CapabilityStatement.messaging.event.category The impact of the content of a message.RequiredMessageSignificanceCategory
CapabilityStatement.messaging.event.mode The mode of a message capability statement.RequiredEventCapabilityMode
CapabilityStatement.document.mode Whether the application produces or consumes documents.RequiredDocumentMode

5.3.3.2 Constraints

  • cpb-1: A Capability Statement SHALL have at least one of REST, messaging or document (expression : rest.exists() or messaging.exists() or document.exists())
  • cpb-12: On CapabilityStatement.rest.resource: Search parameter names must be unique in the context of a resource (expression on CapabilityStatement.rest.resource: searchParam.select(name).isDistinct())
  • cpb-14: Capability Statements of kind 'requirements' do not have software or implementation elements (expression : (software.empty() and implementation.empty()) or kind != 'requirements')
  • cpb-15: Capability Statements of kind 'instance' do not have implementation elements (expression : implementation.empty() or kind != 'capability')
  • cpb-2: A Capability Statement SHALL have at least one of description, software, or implementation (expression : (description.count() + software.count() + implementation.count()) > 0)
  • cpb-3: Messaging end-point is required (and is only permitted) when statement is for an implementation (expression : messaging.endpoint.empty() or kind = 'instance')
  • cpb-7: The set of documents must be unique by the combination of profile & mode (expression : document.select(profile.reference&mode).isDistinct())
  • cpb-8: There can only be one REST declaration per mode (expression : rest.select(mode).isDistinct())
  • cpb-9: On CapabilityStatement.rest: A given resource can only be described once per RESTful mode (expression on CapabilityStatement.rest: resource.select(type).isDistinct())

5.3.4 Notes:

  • The CapabilityStatement resource provides for an application to describe its use of the RESTful paradigm messaging events, or FHIR documents. Usually, an application would only describe one, but more than one may be described
  • RESTful CapabilityStatement rules:
    • RESTful servers are required to provide this resource on demand. Servers SHALL specify what resource types and operations are supported, and SHOULD also specify profiles for each resource type.
    • RESTful clients SHOULD publish a capability statement
    • The search parameters that a server supports (or a client makes use of) are specified in the resource profile that the capability statement references
    • Resource Types or operations that are not listed are not supported
  • Messaging CapabilityStatement rules:
    • The interpretation of request and response depends on the mode. If the mode is sender, then request specifies what the application sends, and response specifies what it accepts. If the mode is "receiver", then this is reversed
    • If a request or response is not specified for an event, then no rules are made for it
    • Events that are not listed are not supported
  • Document CapabilityStatement rules:
    • Document profiles should directly constrain the Document.information.class & type elements so that there is no ambiguity concerning which profile any given document conforms to.
  • Other service based use of resources: Due to the variability of these services, the 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.

5.3.4.1 Supporting Profiles

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.

5.3.5 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionPathsIn Common
datedateThe capability statement publication dateCapabilityStatement.date
descriptionstringText search against the description of the capability statementCapabilityStatement.description
eventtokenEvent code in a capability statementCapabilityStatement.messaging.event.code
fhirversiontokenThe version of FHIRCapabilityStatement.version
formattokenformats supported (xml | json | ttl | mime type)CapabilityStatement.format
guideuriImplementation Guide supportedCapabilityStatement.implementationGuide
jurisdictiontokenIntended jurisdiction for capability statementCapabilityStatement.jurisdiction
modetokenMode - restful (server/client) or messaging (sender/receiver)CapabilityStatement.rest.mode
namestringName of the capability statementCapabilityStatement.name
publisherstringName of the publisher of the capability statementCapabilityStatement.publisher
resourcetokenName of a resource mentioned in a capability statementCapabilityStatement.rest.resource.type
resourceprofilereferenceA profile id invoked in a capability statementCapabilityStatement.rest.resource.profile
(StructureDefinition)
securityservicetokenOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | CertificatesCapabilityStatement.rest.security.service
softwarestringPart of a the name of a software applicationCapabilityStatement.software.name
statustokenThe current status of the capability statementCapabilityStatement.status
supported-profilereferenceProfiles for use cases supportedCapabilityStatement.profile
(StructureDefinition)
titlestringText search against the title of the capability statementCapabilityStatement.title
urluriThe uri that identifies the capability statementCapabilityStatement.url
versiontokenThe version identifier of the capability statementCapabilityStatement.version