Release 4B

This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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.2 Resource CapabilityStatement - Content

FHIR Infrastructure Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Anonymous Compartments: Not linked to any defined compartments
This page has been approved as part of an ANSI standard. See the Conformance Package for further details.

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.

5.2.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 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:

Instanceimplementation must be present and software may be present
Capabilityimplementation must be absent, software must be present
Requirementsimplementation and software must be absent

5.2.1.1 Instance: 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 statement 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.2.1.2 Capability: 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.2.1.3 Requirements: 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.

CapabilityStatements of type "requirement" describe what capabilities are potentially relevant; additional documentation or extensions (see capabilitystatement-expectation) within the CapabilityStatement are expected to make more explicit statements of degree of expectation associated with each capability.

5.2.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.

5.2.2.1 Supporting Multiple Versions

Applications may implement multiple versions. If they do, then a CapabilityStatement describes the system's support for a particular version of FHIR, and the system will have multiple statements, one for each version it supports. For further information, see Managing Multiple Versions, and the $versions operation.

5.2.2.2 Mixed Normative Content

While the core of the CapabilityStatement resource is Normative, many of the flags that indicate exactly how the system operates are marked as trial-use. Roughly, the portions of the resource that correspond to OpenAPI document elements are normative.

Applications looking for normative stability should only use the normative parts of the resource, and not populate or ignore the portions labelled trial-use. To assist with this, clients can ask for the server to return a 'Normative content only' CapabilityStatement using the mode parameter on /metadata.

Community discussion regarding more capable, efficient and computable representations of an applications capabilities may lead to change to the trial-use parts of this resource or the creation of new resources and/or functionality in future versions of this specification.

5.2.3 References

This resource is referenced by itself and TestScript.

This resource does not implement any patterns.

5.2.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement NDomainResourceA statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A Capability Statement SHALL have at least one of REST, messaging or document element.
+ Rule: A Capability Statement SHALL have at least one of description, software, or implementation element.
+ Rule: Messaging end-point is required (and is only permitted) when a statement is for an implementation.
+ Rule: The set of documents must be unique by the combination of profile and mode.
+ Rule: If kind = instance, implementation must be present and software may be present
+ Rule: If kind = capability, implementation must be absent, software must be present
+ Rule: If kind = requirements, implementation and software must be absent
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this capability statement, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the capability statement
... name Σ0..1stringName for this capability statement (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate 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 ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind ΣI1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... instantiates Σ0..*canonical(CapabilityStatement)Canonical URL of another capability statement this implements
... imports ΣTU0..*canonical(CapabilityStatement)Canonical URL of another capability statement this adds to
... 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 was released
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1urlBase URL for the installation
.... custodian ΣTU0..1Reference(Organization)Organization that manages the data
... fhirVersion Σ1..1codeFHIR Version the system supports
FHIRVersion (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
MimeType (Required)
... patchFormat Σ0..*codePatch formats supported
MimeType (Required)
... implementationGuide Σ0..*canonical(ImplementationGuide)Implementation guides supported
... rest ΣI0..*BackboneElementIf the endpoint is a RESTful one
+ Rule: A given resource can only be described once per RESTful mode.
.... mode Σ1..1codeclient | server
RestfulCapabilityMode (Required)
.... documentation 0..1markdownGeneral description of implementation
.... security ΣTU0..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..1markdownGeneral description of how security works
.... resource ΣI0..*BackboneElementResource served on the REST interface
+ Rule: Search parameter names must be unique in the context of a resource.
..... type Σ1..1codeA resource type that is supported
ResourceType (Required)
..... profile Σ0..1canonical(StructureDefinition)Base System profile for all uses of resource
..... supportedProfile ΣTU0..*canonical(StructureDefinition)Profiles for use cases supported
..... documentation 0..1markdownAdditional information about the use of the resource type
..... interaction 0..*BackboneElementWhat operations are supported?
...... code 1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1markdownAnything special about operation behavior
..... versioning TU0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory TU0..1booleanWhether vRead can return past versions
..... updateCreate TU0..1booleanIf update can commit to a new identity
..... conditionalCreate TU0..1booleanIf allows/uses conditional create
..... conditionalRead TU0..1codenot-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required)
..... conditionalUpdate TU0..1booleanIf allows/uses conditional update
..... conditionalDelete TU0..1codenot-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
..... referencePolicy TU0..*codeliteral | logical | resolves | enforced | local
ReferenceHandlingPolicy (Required)
..... searchInclude TU0..*string_include values supported by the server
..... searchRevInclude TU0..*string_revinclude values supported by the server
..... searchParam 0..*BackboneElementSearch parameters supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1canonical(SearchParameter)Source of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
...... documentation 0..1markdownServer-specific usage
..... operation Σ0..*BackboneElementDefinition of a resource operation
...... name Σ1..1stringName by which the operation/query is invoked
...... definition Σ1..1canonical(OperationDefinition)The defined operation/query
...... documentation 0..1markdownSpecific details about operation behavior
.... interaction 0..*BackboneElementWhat operations are supported?
..... code 1..1codetransaction | batch | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1markdownAnything special about operation behavior
.... searchParam 0..*see searchParamSearch parameters for searching all resources
.... operation Σ0..*see operationDefinition of a system level operation
.... compartment 0..*canonical(CompartmentDefinition)Compartments served/used by system
... messaging ΣITU0..*BackboneElementIf messaging is supported
.... endpoint 0..*BackboneElementWhere messages should be sent
..... protocol 1..1Codinghttp | ftp | mllp +
MessageTransport (Extensible)
..... address 1..1urlNetwork address or identifier of the end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1markdownMessaging interface behavior details
.... supportedMessage Σ0..*BackboneElementMessages supported by this system
..... mode Σ1..1codesender | receiver
EventCapabilityMode (Required)
..... definition Σ1..1canonical(MessageDefinition)Message supported by this system
... document ΣITU0..*BackboneElementDocument definition
.... mode Σ1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1markdownDescription of document support
.... profile Σ1..1canonical(StructureDefinition)Constraint on the resources used in the document

doco Documentation for this format

UML Diagram (Legend)

CapabilityStatement (DomainResource)An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different serversurl : 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 can be placed in a lexicographical sequenceversion : 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] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the capability statement was published. The date must change when the business version changes 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 organization or individual 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 a 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instancesuseContext : UsageContext [0..*]A legal or geographic region in which the capability statement is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of 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] « null (Strength=Required)CapabilityStatementKind! »Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability detailsinstantiates : canonical [0..*] « CapabilityStatement »Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to themimports : canonical [0..*] « CapabilityStatement »The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default valuefhirVersion : code [1..1] « null (Strength=Required)FHIRVersion! »A list of the formats supported by this implementation using their content typesformat : code [1..*] « null (Strength=Required)Mime Types! »A list of the patch formats supported by this implementation using their content typespatchFormat : code [0..*] « null (Strength=Required)Mime Types! »A list of implementation guides that the server does (or should) support in their entiretyimplementationGuide : canonical [0..*] « ImplementationGuide »SoftwareName the 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 was 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 : url [0..1]The organization responsible for the management of the instance and oversight of the data on the server at the specified URLcustodian : Reference [0..1] « Organization »RestIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operationsmode : code [1..1] « null (Strength=Required)RestfulCapabilityMode! »Information about the system's restful capabilities that apply across all applications, such as securitydocumentation : markdown [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 its canonical URL compartment : canonical [0..*] « CompartmentDefinition »SecurityServer adds CORS headers when responding to requests - this enables Javascript applications to use the servercors : boolean [0..1]Types of security services that are supported/required by the systemservice : CodeableConcept [0..*] « null (Strength=Extensible)RestfulSecurityService+ »General description of how security worksdescription : markdown [0..1]ResourceA type of resource exposed via the restful interfacetype : code [1..1] « null (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 : canonical [0..1] « StructureDefinition »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)supportedProfile : canonical [0..*] « StructureDefinition »Additional information about the resource type 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] « null (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 (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] « null (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] « null (Strength=Required)ConditionalDeleteStatus! »A set of flags that defines how references are supportedreferencePolicy : code [0..*] « null (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] « null (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 : markdown [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](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGsdefinition : canonical [0..1] « SearchParameter »The type of value a search parameter refers to, and how the content is interpretedtype : code [1..1] « null (Strength=Required)SearchParamType! »This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithmsdocumentation : markdown [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 found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supporteddefinition : canonical [1..1] « OperationDefinition »Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operationdocumentation : markdown [0..1]SystemInteractionA coded identifier of the operation, supported by the systemcode : code [1..1] « null (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 : markdown [0..1]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, the process for becoming an authorized messaging exchange partnerdocumentation : markdown [0..1]EndpointA list of the messaging transport protocol(s) identifiers, supported by this endpointprotocol : Coding [1..1] « null (Strength=Extensible)MessageTransport+ »The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifieraddress : url [1..1]SupportedMessageThe mode of this event declaration - whether application is sender or receivermode : code [1..1] « null (Strength=Required)EventCapabilityMode! »Points to a message definition that identifies the messaging event, message structure, allowed responses, etcdefinition : canonical [1..1] « MessageDefinition »DocumentMode of this document declaration - whether an application is a producer or consumermode : code [1..1] « null (Strength=Required)DocumentMode! »A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etcdocumentation : markdown [0..1]A profile on the document Bundle that constrains which resources are present, and their contentsprofile : canonical [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]Information about security implementation from an interface perspective - what a client needs to knowsecurity[0..1]Identifies a restful operation supported by the solutioninteraction[0..*]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..*]Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parametersoperation[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 together with its parameters and their meaning and typeoperation[0..*]A definition of the restful capabilities of the solution, if anyrest[0..*]An endpoint (network accessible address) to which messages and/or replies are to be sentendpoint[0..*]References to message definitions for messages this system can send or receivesupportedMessage[0..*]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 Canonical identifier for this capability statement, represented as a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the capability statement -->
 <name value="[string]"/><!-- 0..1 Name for this capability statement (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this capability statement (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date 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 The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this capability statement is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <kind value="[code]"/><!-- ?? 1..1 instance | capability | requirements -->
 <instantiates><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements --></instantiates>
 <imports><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this adds to --></imports>
 <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 was released -->
 </software>
 <implementation>  <!-- ?? 0..1 If this describes a specific instance -->
  <description value="[string]"/><!-- 1..1 Describes this specific instance -->
  <url value="[url]"/><!-- 0..1 Base URL for the installation -->
  <custodian><!-- 0..1 Reference(Organization) Organization that manages the data --></custodian>
 </implementation>
 <fhirVersion value="[code]"/><!-- 1..1 FHIR Version the system supports -->
 <format value="[code]"/><!-- 1..* formats supported (xml | json | ttl | mime type) -->
 <patchFormat value="[code]"/><!-- 0..* Patch formats supported -->
 <implementationGuide><!-- 0..* canonical(ImplementationGuide) Implementation guides supported --></implementationGuide>
 <rest>  <!-- ?? 0..* If the endpoint is a RESTful one -->
  <mode value="[code]"/><!-- 1..1 client | server -->
  <documentation value="[markdown]"/><!-- 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="[markdown]"/><!-- 0..1 General description of how security works -->
  </security>
  <resource>  <!-- 0..* Resource served on the REST interface -->
   <type value="[code]"/><!-- 1..1 A resource type that is supported -->
   <profile><!-- 0..1 canonical(StructureDefinition) Base System profile for all uses of resource --></profile>
   <supportedProfile><!-- 0..* canonical(StructureDefinition) Profiles for use cases supported --></supportedProfile>
   <documentation value="[markdown]"/><!-- 0..1 Additional information about the use of the resource type -->
   <interaction>  <!-- 0..* What operations are supported? -->
    <code value="[code]"/><!-- 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type -->
    <documentation value="[markdown]"/><!-- 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 parameters supported by implementation -->
    <name value="[string]"/><!-- 1..1 Name of search parameter -->
    <definition><!-- 0..1 canonical(SearchParameter) Source of definition for parameter --></definition>
    <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special -->
    <documentation value="[markdown]"/><!-- 0..1 Server-specific usage -->
   </searchParam>
   <operation>  <!-- 0..* Definition of a resource operation -->
    <name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked -->
    <definition><!-- 1..1 canonical(OperationDefinition) The defined operation/query --></definition>
    <documentation value="[markdown]"/><!-- 0..1 Specific details about operation behavior -->
   </operation>
  </resource>
  <interaction>  <!-- 0..* What operations are supported? -->
   <code value="[code]"/><!-- 1..1 transaction | batch | search-system | history-system -->
   <documentation value="[markdown]"/><!-- 0..1 Anything special about operation behavior -->
  </interaction>
  <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search parameters for searching all resources --></searchParam>
  <operation><!-- 0..* Content as for CapabilityStatement.rest.resource.operation Definition of a system level operation --></operation>
  <compartment><!-- 0..* canonical(CompartmentDefinition) Compartments served/used by system --></compartment>
 </rest>
 <messaging>  <!-- ?? 0..* If messaging is supported -->
  <endpoint>  <!-- 0..* Where messages should be sent -->
   <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol>
   <address value="[url]"/><!-- 1..1 Network address or identifier of the end-point -->
  </endpoint>
  <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) -->
  <documentation value="[markdown]"/><!-- 0..1 Messaging interface behavior details -->
  <supportedMessage>  <!-- 0..* Messages supported by this system -->
   <mode value="[code]"/><!-- 1..1 sender | receiver -->
   <definition><!-- 1..1 canonical(MessageDefinition) Message supported by this system --></definition>
  </supportedMessage>
 </messaging>
 <document>  <!-- ?? 0..* Document definition -->
  <mode value="[code]"/><!-- 1..1 producer | consumer -->
  <documentation value="[markdown]"/><!-- 0..1 Description of document support -->
  <profile><!-- 1..1 canonical(StructureDefinition) Constraint on the resources 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>", // Canonical identifier for this capability statement, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the capability statement
  "name" : "<string>", // Name for this capability statement (computer friendly)
  "title" : "<string>", // Name for this capability statement (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date 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 }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable)
  "purpose" : "<markdown>", // Why this capability statement is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "kind" : "<code>", // C? R!  instance | capability | requirements
  "instantiates" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this implements
  "imports" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this adds to
  "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 was released
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<url>", // Base URL for the installation
    "custodian" : { Reference(Organization) } // Organization that manages the data
  },
  "fhirVersion" : "<code>", // R!  FHIR Version the system supports
  "format" : ["<code>"], // R!  formats supported (xml | json | ttl | mime type)
  "patchFormat" : ["<code>"], // Patch formats supported
  "implementationGuide" : [{ canonical(ImplementationGuide) }], // Implementation guides supported
  "rest" : [{ // C? If the endpoint is a RESTful one
    "mode" : "<code>", // R!  client | server
    "documentation" : "<markdown>", // 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" : "<markdown>" // General description of how security works
    },
    "resource" : [{ // Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : { canonical(StructureDefinition) }, // Base System profile for all uses of resource
      "supportedProfile" : [{ canonical(StructureDefinition) }], // Profiles for use cases supported
      "documentation" : "<markdown>", // Additional information about the use of the resource type
      "interaction" : [{ // What operations are supported?
        "code" : "<code>", // R!  read | vread | update | patch | delete | history-instance | history-type | create | search-type
        "documentation" : "<markdown>" // Anything special about operation behavior
      }],
      "versioning" : "<code>", // no-version | versioned | versioned-update
      "readHistory" : <boolean>, // Whether vRead can return past versions
      "updateCreate" : <boolean>, // If update can commit to a new identity
      "conditionalCreate" : <boolean>, // If allows/uses conditional create
      "conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support
      "conditionalUpdate" : <boolean>, // If allows/uses conditional update
      "conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
      "referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local
      "searchInclude" : ["<string>"], // _include values supported by the server
      "searchRevInclude" : ["<string>"], // _revinclude values supported by the server
      "searchParam" : [{ // Search parameters supported by implementation
        "name" : "<string>", // R!  Name of search parameter
        "definition" : { canonical(SearchParameter) }, // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special
        "documentation" : "<markdown>" // Server-specific usage
      }],
      "operation" : [{ // Definition of a resource operation
        "name" : "<string>", // R!  Name by which the operation/query is invoked
        "definition" : { canonical(OperationDefinition) }, // R!  The defined operation/query
        "documentation" : "<markdown>" // Specific details about operation behavior
      }]
    }],
    "interaction" : [{ // What operations are supported?
      "code" : "<code>", // R!  transaction | batch | search-system | history-system
      "documentation" : "<markdown>" // Anything special about operation behavior
    }],
    "searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources
    "operation" : [{ Content as for CapabilityStatement.rest.resource.operation }], // Definition of a system level operation
    "compartment" : [{ canonical(CompartmentDefinition) }] // Compartments served/used by system
  }],
  "messaging" : [{ // C? If messaging is supported
    "endpoint" : [{ // Where messages should be sent
      "protocol" : { Coding }, // R!  http | ftp | mllp +
      "address" : "<url>" // R!  Network address or identifier of the end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<markdown>", // Messaging interface behavior details
    "supportedMessage" : [{ // Messages supported by this system
      "mode" : "<code>", // R!  sender | receiver
      "definition" : { canonical(MessageDefinition) } // R!  Message supported by this system
    }]
  }],
  "document" : [{ // C? Document definition
    "mode" : "<code>", // R!  producer | consumer
    "documentation" : "<markdown>", // Description of document support
    "profile" : { canonical(StructureDefinition) } // R!  Constraint on the resources 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 Canonical identifier for this capability statement, represented as a URI (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 | unknown
  fhir:CapabilityStatement.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:CapabilityStatement.date [ dateTime ]; # 1..1 Date 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..* The context that the content is intended to support
  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 [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this implements
  fhir:CapabilityStatement.imports [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this adds to
  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 was 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 [ url ]; # 0..1 Base URL for the installation
    fhir:CapabilityStatement.implementation.custodian [ Reference(Organization) ]; # 0..1 Organization that manages the data
  ];
  fhir:CapabilityStatement.fhirVersion [ code ]; # 1..1 FHIR Version the system supports
  fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported
  fhir:CapabilityStatement.implementationGuide [ canonical(ImplementationGuide) ], ... ; # 0..* Implementation guides 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 [ markdown ]; # 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 [ markdown ]; # 0..1 General description of how security works
    ];
    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 [ canonical(StructureDefinition) ]; # 0..1 Base System profile for all uses of resource
      fhir:CapabilityStatement.rest.resource.supportedProfile [ canonical(StructureDefinition) ], ... ; # 0..* Profiles for use cases supported
      fhir:CapabilityStatement.rest.resource.documentation [ markdown ]; # 0..1 Additional information about the use of the resource type
      fhir:CapabilityStatement.rest.resource.interaction [ # 0..* 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 [ markdown ]; # 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 parameters supported by implementation
        fhir:CapabilityStatement.rest.resource.searchParam.name [ string ]; # 1..1 Name of search parameter
        fhir:CapabilityStatement.rest.resource.searchParam.definition [ canonical(SearchParameter) ]; # 0..1 Source of definition for parameter
        fhir:CapabilityStatement.rest.resource.searchParam.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
        fhir:CapabilityStatement.rest.resource.searchParam.documentation [ markdown ]; # 0..1 Server-specific usage
      ], ...;
      fhir:CapabilityStatement.rest.resource.operation [ # 0..* Definition of a resource operation
        fhir:CapabilityStatement.rest.resource.operation.name [ string ]; # 1..1 Name by which the operation/query is invoked
        fhir:CapabilityStatement.rest.resource.operation.definition [ canonical(OperationDefinition) ]; # 1..1 The defined operation/query
        fhir:CapabilityStatement.rest.resource.operation.documentation [ markdown ]; # 0..1 Specific details about operation behavior
      ], ...;
    ], ...;
    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 [ markdown ]; # 0..1 Anything special about operation behavior
    ], ...;
    fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search parameters for searching all resources
    fhir:CapabilityStatement.rest.operation [ See CapabilityStatement.rest.resource.operation ], ... ; # 0..* Definition of a system level operation
    fhir:CapabilityStatement.rest.compartment [ canonical(CompartmentDefinition) ], ... ; # 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 [ url ]; # 1..1 Network address or identifier of the end-point
    ], ...;
    fhir:CapabilityStatement.messaging.reliableCache [ unsignedInt ]; # 0..1 Reliable Message Cache Length (min)
    fhir:CapabilityStatement.messaging.documentation [ markdown ]; # 0..1 Messaging interface behavior details
    fhir:CapabilityStatement.messaging.supportedMessage [ # 0..* Messages supported by this system
      fhir:CapabilityStatement.messaging.supportedMessage.mode [ code ]; # 1..1 sender | receiver
      fhir:CapabilityStatement.messaging.supportedMessage.definition [ canonical(MessageDefinition) ]; # 1..1 Message supported by this system
    ], ...;
  ], ...;
  fhir:CapabilityStatement.document [ # 0..* Document definition
    fhir:CapabilityStatement.document.mode [ code ]; # 1..1 producer | consumer
    fhir:CapabilityStatement.document.documentation [ markdown ]; # 0..1 Description of document support
    fhir:CapabilityStatement.document.profile [ canonical(StructureDefinition) ]; # 1..1 Constraint on the resources used in the document
  ], ...;
]

Changes since R4

CapabilityStatement
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

Conversions between R3 and R4

See R3 <--> R4 Conversion Maps (status = 9 tests that all execute ok. 1 fail round-trip testing and 9 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. CapabilityStatement NDomainResourceA statement of system capabilities
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
+ Rule: A Capability Statement SHALL have at least one of REST, messaging or document element.
+ Rule: A Capability Statement SHALL have at least one of description, software, or implementation element.
+ Rule: Messaging end-point is required (and is only permitted) when a statement is for an implementation.
+ Rule: The set of documents must be unique by the combination of profile and mode.
+ Rule: If kind = instance, implementation must be present and software may be present
+ Rule: If kind = capability, implementation must be absent, software must be present
+ Rule: If kind = requirements, implementation and software must be absent
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this capability statement, represented as a URI (globally unique)
... version Σ0..1stringBusiness version of the capability statement
... name Σ0..1stringName for this capability statement (computer friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate 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 ΣTU0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this capability statement is defined
... copyright 0..1markdownUse and/or publishing restrictions
... kind ΣI1..1codeinstance | capability | requirements
CapabilityStatementKind (Required)
... instantiates Σ0..*canonical(CapabilityStatement)Canonical URL of another capability statement this implements
... imports ΣTU0..*canonical(CapabilityStatement)Canonical URL of another capability statement this adds to
... 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 was released
... implementation ΣI0..1BackboneElementIf this describes a specific instance
.... description Σ1..1stringDescribes this specific instance
.... url Σ0..1urlBase URL for the installation
.... custodian ΣTU0..1Reference(Organization)Organization that manages the data
... fhirVersion Σ1..1codeFHIR Version the system supports
FHIRVersion (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
MimeType (Required)
... patchFormat Σ0..*codePatch formats supported
MimeType (Required)
... implementationGuide Σ0..*canonical(ImplementationGuide)Implementation guides supported
... rest ΣI0..*BackboneElementIf the endpoint is a RESTful one
+ Rule: A given resource can only be described once per RESTful mode.
.... mode Σ1..1codeclient | server
RestfulCapabilityMode (Required)
.... documentation 0..1markdownGeneral description of implementation
.... security ΣTU0..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..1markdownGeneral description of how security works
.... resource ΣI0..*BackboneElementResource served on the REST interface
+ Rule: Search parameter names must be unique in the context of a resource.
..... type Σ1..1codeA resource type that is supported
ResourceType (Required)
..... profile Σ0..1canonical(StructureDefinition)Base System profile for all uses of resource
..... supportedProfile ΣTU0..*canonical(StructureDefinition)Profiles for use cases supported
..... documentation 0..1markdownAdditional information about the use of the resource type
..... interaction 0..*BackboneElementWhat operations are supported?
...... code 1..1coderead | vread | update | patch | delete | history-instance | history-type | create | search-type
TypeRestfulInteraction (Required)
...... documentation 0..1markdownAnything special about operation behavior
..... versioning TU0..1codeno-version | versioned | versioned-update
ResourceVersionPolicy (Required)
..... readHistory TU0..1booleanWhether vRead can return past versions
..... updateCreate TU0..1booleanIf update can commit to a new identity
..... conditionalCreate TU0..1booleanIf allows/uses conditional create
..... conditionalRead TU0..1codenot-supported | modified-since | not-match | full-support
ConditionalReadStatus (Required)
..... conditionalUpdate TU0..1booleanIf allows/uses conditional update
..... conditionalDelete TU0..1codenot-supported | single | multiple - how conditional delete is supported
ConditionalDeleteStatus (Required)
..... referencePolicy TU0..*codeliteral | logical | resolves | enforced | local
ReferenceHandlingPolicy (Required)
..... searchInclude TU0..*string_include values supported by the server
..... searchRevInclude TU0..*string_revinclude values supported by the server
..... searchParam 0..*BackboneElementSearch parameters supported by implementation
...... name 1..1stringName of search parameter
...... definition 0..1canonical(SearchParameter)Source of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri | special
SearchParamType (Required)
...... documentation 0..1markdownServer-specific usage
..... operation Σ0..*BackboneElementDefinition of a resource operation
...... name Σ1..1stringName by which the operation/query is invoked
...... definition Σ1..1canonical(OperationDefinition)The defined operation/query
...... documentation 0..1markdownSpecific details about operation behavior
.... interaction 0..*BackboneElementWhat operations are supported?
..... code 1..1codetransaction | batch | search-system | history-system
SystemRestfulInteraction (Required)
..... documentation 0..1markdownAnything special about operation behavior
.... searchParam 0..*see searchParamSearch parameters for searching all resources
.... operation Σ0..*see operationDefinition of a system level operation
.... compartment 0..*canonical(CompartmentDefinition)Compartments served/used by system
... messaging ΣITU0..*BackboneElementIf messaging is supported
.... endpoint 0..*BackboneElementWhere messages should be sent
..... protocol 1..1Codinghttp | ftp | mllp +
MessageTransport (Extensible)
..... address 1..1urlNetwork address or identifier of the end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation 0..1markdownMessaging interface behavior details
.... supportedMessage Σ0..*BackboneElementMessages supported by this system
..... mode Σ1..1codesender | receiver
EventCapabilityMode (Required)
..... definition Σ1..1canonical(MessageDefinition)Message supported by this system
... document ΣITU0..*BackboneElementDocument definition
.... mode Σ1..1codeproducer | consumer
DocumentMode (Required)
.... documentation 0..1markdownDescription of document support
.... profile Σ1..1canonical(StructureDefinition)Constraint on the resources used in the document

doco Documentation for this format

UML Diagram (Legend)

CapabilityStatement (DomainResource)An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this capability statement is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the capability statement is stored on different serversurl : 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 can be placed in a lexicographical sequenceversion : 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] « null (Strength=Required)PublicationStatus! »A Boolean value to indicate that this capability statement is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usageexperimental : boolean [0..1]The date (and optionally time) when the capability statement was published. The date must change when the business version changes 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 organization or individual 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 a 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 contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate capability statement instancesuseContext : UsageContext [0..*]A legal or geographic region in which the capability statement is intended to be usedjurisdiction : CodeableConcept [0..*] « null (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of 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] « null (Strength=Required)CapabilityStatementKind! »Reference to a canonical URL of another CapabilityStatement that this software implements. This capability statement is a published API description that corresponds to a business service. The server may actually implement a subset of the capability statement it claims to implement, so the capability statement must specify the full capability detailsinstantiates : canonical [0..*] « CapabilityStatement »Reference to a canonical URL of another CapabilityStatement that this software adds to. The capability statement automatically includes everything in the other statement, and it is not duplicated, though the server may repeat the same resources, interactions and operations to add additional details to themimports : canonical [0..*] « CapabilityStatement »The version of the FHIR specification that this CapabilityStatement describes (which SHALL be the same as the FHIR version of the CapabilityStatement itself). There is no default valuefhirVersion : code [1..1] « null (Strength=Required)FHIRVersion! »A list of the formats supported by this implementation using their content typesformat : code [1..*] « null (Strength=Required)Mime Types! »A list of the patch formats supported by this implementation using their content typespatchFormat : code [0..*] « null (Strength=Required)Mime Types! »A list of implementation guides that the server does (or should) support in their entiretyimplementationGuide : canonical [0..*] « ImplementationGuide »SoftwareName the 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 was 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 : url [0..1]The organization responsible for the management of the instance and oversight of the data on the server at the specified URLcustodian : Reference [0..1] « Organization »RestIdentifies whether this portion of the statement is describing the ability to initiate or receive restful operationsmode : code [1..1] « null (Strength=Required)RestfulCapabilityMode! »Information about the system's restful capabilities that apply across all applications, such as securitydocumentation : markdown [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 its canonical URL compartment : canonical [0..*] « CompartmentDefinition »SecurityServer adds CORS headers when responding to requests - this enables Javascript applications to use the servercors : boolean [0..1]Types of security services that are supported/required by the systemservice : CodeableConcept [0..*] « null (Strength=Extensible)RestfulSecurityService+ »General description of how security worksdescription : markdown [0..1]ResourceA type of resource exposed via the restful interfacetype : code [1..1] « null (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 : canonical [0..1] « StructureDefinition »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)supportedProfile : canonical [0..*] « StructureDefinition »Additional information about the resource type 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] « null (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 (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] « null (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] « null (Strength=Required)ConditionalDeleteStatus! »A set of flags that defines how references are supportedreferencePolicy : code [0..*] « null (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] « null (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 : markdown [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](searchparameter-definitions.html#SearchParameter.url)). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGsdefinition : canonical [0..1] « SearchParameter »The type of value a search parameter refers to, and how the content is interpretedtype : code [1..1] « null (Strength=Required)SearchParamType! »This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithmsdocumentation : markdown [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 found. If a server references the base definition of an Operation (i.e. from the specification itself such as ```http://hl7.org/fhir/OperationDefinition/ValueSet-expand```), that means it supports the full capabilities of the operation - e.g. both GET and POST invocation. If it only supports a subset, it must define its own custom [OperationDefinition](operationdefinition.html#) with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supporteddefinition : canonical [1..1] « OperationDefinition »Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operationdocumentation : markdown [0..1]SystemInteractionA coded identifier of the operation, supported by the systemcode : code [1..1] « null (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 : markdown [0..1]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, the process for becoming an authorized messaging exchange partnerdocumentation : markdown [0..1]EndpointA list of the messaging transport protocol(s) identifiers, supported by this endpointprotocol : Coding [1..1] « null (Strength=Extensible)MessageTransport+ »The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifieraddress : url [1..1]SupportedMessageThe mode of this event declaration - whether application is sender or receivermode : code [1..1] « null (Strength=Required)EventCapabilityMode! »Points to a message definition that identifies the messaging event, message structure, allowed responses, etcdefinition : canonical [1..1] « MessageDefinition »DocumentMode of this document declaration - whether an application is a producer or consumermode : code [1..1] « null (Strength=Required)DocumentMode! »A description of how the application supports or uses the specified document profile. For example, when documents are created, what action is taken with consumed documents, etcdocumentation : markdown [0..1]A profile on the document Bundle that constrains which resources are present, and their contentsprofile : canonical [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]Information about security implementation from an interface perspective - what a client needs to knowsecurity[0..1]Identifies a restful operation supported by the solutioninteraction[0..*]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..*]Definition of an operation or a named query together with its parameters and their meaning and type. Consult the definition of the operation for details about how to invoke the operation, and the parametersoperation[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 together with its parameters and their meaning and typeoperation[0..*]A definition of the restful capabilities of the solution, if anyrest[0..*]An endpoint (network accessible address) to which messages and/or replies are to be sentendpoint[0..*]References to message definitions for messages this system can send or receivesupportedMessage[0..*]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 Canonical identifier for this capability statement, represented as a URI (globally unique) -->
 <version value="[string]"/><!-- 0..1 Business version of the capability statement -->
 <name value="[string]"/><!-- 0..1 Name for this capability statement (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this capability statement (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 1..1 Date 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 The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for capability statement (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this capability statement is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <kind value="[code]"/><!-- ?? 1..1 instance | capability | requirements -->
 <instantiates><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this implements --></instantiates>
 <imports><!-- 0..* canonical(CapabilityStatement) Canonical URL of another capability statement this adds to --></imports>
 <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 was released -->
 </software>
 <implementation>  <!-- ?? 0..1 If this describes a specific instance -->
  <description value="[string]"/><!-- 1..1 Describes this specific instance -->
  <url value="[url]"/><!-- 0..1 Base URL for the installation -->
  <custodian><!-- 0..1 Reference(Organization) Organization that manages the data --></custodian>
 </implementation>
 <fhirVersion value="[code]"/><!-- 1..1 FHIR Version the system supports -->
 <format value="[code]"/><!-- 1..* formats supported (xml | json | ttl | mime type) -->
 <patchFormat value="[code]"/><!-- 0..* Patch formats supported -->
 <implementationGuide><!-- 0..* canonical(ImplementationGuide) Implementation guides supported --></implementationGuide>
 <rest>  <!-- ?? 0..* If the endpoint is a RESTful one -->
  <mode value="[code]"/><!-- 1..1 client | server -->
  <documentation value="[markdown]"/><!-- 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="[markdown]"/><!-- 0..1 General description of how security works -->
  </security>
  <resource>  <!-- 0..* Resource served on the REST interface -->
   <type value="[code]"/><!-- 1..1 A resource type that is supported -->
   <profile><!-- 0..1 canonical(StructureDefinition) Base System profile for all uses of resource --></profile>
   <supportedProfile><!-- 0..* canonical(StructureDefinition) Profiles for use cases supported --></supportedProfile>
   <documentation value="[markdown]"/><!-- 0..1 Additional information about the use of the resource type -->
   <interaction>  <!-- 0..* What operations are supported? -->
    <code value="[code]"/><!-- 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type -->
    <documentation value="[markdown]"/><!-- 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 parameters supported by implementation -->
    <name value="[string]"/><!-- 1..1 Name of search parameter -->
    <definition><!-- 0..1 canonical(SearchParameter) Source of definition for parameter --></definition>
    <type value="[code]"/><!-- 1..1 number | date | string | token | reference | composite | quantity | uri | special -->
    <documentation value="[markdown]"/><!-- 0..1 Server-specific usage -->
   </searchParam>
   <operation>  <!-- 0..* Definition of a resource operation -->
    <name value="[string]"/><!-- 1..1 Name by which the operation/query is invoked -->
    <definition><!-- 1..1 canonical(OperationDefinition) The defined operation/query --></definition>
    <documentation value="[markdown]"/><!-- 0..1 Specific details about operation behavior -->
   </operation>
  </resource>
  <interaction>  <!-- 0..* What operations are supported? -->
   <code value="[code]"/><!-- 1..1 transaction | batch | search-system | history-system -->
   <documentation value="[markdown]"/><!-- 0..1 Anything special about operation behavior -->
  </interaction>
  <searchParam><!-- 0..* Content as for CapabilityStatement.rest.resource.searchParam Search parameters for searching all resources --></searchParam>
  <operation><!-- 0..* Content as for CapabilityStatement.rest.resource.operation Definition of a system level operation --></operation>
  <compartment><!-- 0..* canonical(CompartmentDefinition) Compartments served/used by system --></compartment>
 </rest>
 <messaging>  <!-- ?? 0..* If messaging is supported -->
  <endpoint>  <!-- 0..* Where messages should be sent -->
   <protocol><!-- 1..1 Coding http | ftp | mllp + --></protocol>
   <address value="[url]"/><!-- 1..1 Network address or identifier of the end-point -->
  </endpoint>
  <reliableCache value="[unsignedInt]"/><!-- 0..1 Reliable Message Cache Length (min) -->
  <documentation value="[markdown]"/><!-- 0..1 Messaging interface behavior details -->
  <supportedMessage>  <!-- 0..* Messages supported by this system -->
   <mode value="[code]"/><!-- 1..1 sender | receiver -->
   <definition><!-- 1..1 canonical(MessageDefinition) Message supported by this system --></definition>
  </supportedMessage>
 </messaging>
 <document>  <!-- ?? 0..* Document definition -->
  <mode value="[code]"/><!-- 1..1 producer | consumer -->
  <documentation value="[markdown]"/><!-- 0..1 Description of document support -->
  <profile><!-- 1..1 canonical(StructureDefinition) Constraint on the resources 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>", // Canonical identifier for this capability statement, represented as a URI (globally unique)
  "version" : "<string>", // Business version of the capability statement
  "name" : "<string>", // Name for this capability statement (computer friendly)
  "title" : "<string>", // Name for this capability statement (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // R!  Date 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 }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for capability statement (if applicable)
  "purpose" : "<markdown>", // Why this capability statement is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "kind" : "<code>", // C? R!  instance | capability | requirements
  "instantiates" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this implements
  "imports" : [{ canonical(CapabilityStatement) }], // Canonical URL of another capability statement this adds to
  "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 was released
  },
  "implementation" : { // C? If this describes a specific instance
    "description" : "<string>", // R!  Describes this specific instance
    "url" : "<url>", // Base URL for the installation
    "custodian" : { Reference(Organization) } // Organization that manages the data
  },
  "fhirVersion" : "<code>", // R!  FHIR Version the system supports
  "format" : ["<code>"], // R!  formats supported (xml | json | ttl | mime type)
  "patchFormat" : ["<code>"], // Patch formats supported
  "implementationGuide" : [{ canonical(ImplementationGuide) }], // Implementation guides supported
  "rest" : [{ // C? If the endpoint is a RESTful one
    "mode" : "<code>", // R!  client | server
    "documentation" : "<markdown>", // 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" : "<markdown>" // General description of how security works
    },
    "resource" : [{ // Resource served on the REST interface
      "type" : "<code>", // R!  A resource type that is supported
      "profile" : { canonical(StructureDefinition) }, // Base System profile for all uses of resource
      "supportedProfile" : [{ canonical(StructureDefinition) }], // Profiles for use cases supported
      "documentation" : "<markdown>", // Additional information about the use of the resource type
      "interaction" : [{ // What operations are supported?
        "code" : "<code>", // R!  read | vread | update | patch | delete | history-instance | history-type | create | search-type
        "documentation" : "<markdown>" // Anything special about operation behavior
      }],
      "versioning" : "<code>", // no-version | versioned | versioned-update
      "readHistory" : <boolean>, // Whether vRead can return past versions
      "updateCreate" : <boolean>, // If update can commit to a new identity
      "conditionalCreate" : <boolean>, // If allows/uses conditional create
      "conditionalRead" : "<code>", // not-supported | modified-since | not-match | full-support
      "conditionalUpdate" : <boolean>, // If allows/uses conditional update
      "conditionalDelete" : "<code>", // not-supported | single | multiple - how conditional delete is supported
      "referencePolicy" : ["<code>"], // literal | logical | resolves | enforced | local
      "searchInclude" : ["<string>"], // _include values supported by the server
      "searchRevInclude" : ["<string>"], // _revinclude values supported by the server
      "searchParam" : [{ // Search parameters supported by implementation
        "name" : "<string>", // R!  Name of search parameter
        "definition" : { canonical(SearchParameter) }, // Source of definition for parameter
        "type" : "<code>", // R!  number | date | string | token | reference | composite | quantity | uri | special
        "documentation" : "<markdown>" // Server-specific usage
      }],
      "operation" : [{ // Definition of a resource operation
        "name" : "<string>", // R!  Name by which the operation/query is invoked
        "definition" : { canonical(OperationDefinition) }, // R!  The defined operation/query
        "documentation" : "<markdown>" // Specific details about operation behavior
      }]
    }],
    "interaction" : [{ // What operations are supported?
      "code" : "<code>", // R!  transaction | batch | search-system | history-system
      "documentation" : "<markdown>" // Anything special about operation behavior
    }],
    "searchParam" : [{ Content as for CapabilityStatement.rest.resource.searchParam }], // Search parameters for searching all resources
    "operation" : [{ Content as for CapabilityStatement.rest.resource.operation }], // Definition of a system level operation
    "compartment" : [{ canonical(CompartmentDefinition) }] // Compartments served/used by system
  }],
  "messaging" : [{ // C? If messaging is supported
    "endpoint" : [{ // Where messages should be sent
      "protocol" : { Coding }, // R!  http | ftp | mllp +
      "address" : "<url>" // R!  Network address or identifier of the end-point
    }],
    "reliableCache" : "<unsignedInt>", // Reliable Message Cache Length (min)
    "documentation" : "<markdown>", // Messaging interface behavior details
    "supportedMessage" : [{ // Messages supported by this system
      "mode" : "<code>", // R!  sender | receiver
      "definition" : { canonical(MessageDefinition) } // R!  Message supported by this system
    }]
  }],
  "document" : [{ // C? Document definition
    "mode" : "<code>", // R!  producer | consumer
    "documentation" : "<markdown>", // Description of document support
    "profile" : { canonical(StructureDefinition) } // R!  Constraint on the resources 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 Canonical identifier for this capability statement, represented as a URI (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 | unknown
  fhir:CapabilityStatement.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:CapabilityStatement.date [ dateTime ]; # 1..1 Date 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..* The context that the content is intended to support
  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 [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this implements
  fhir:CapabilityStatement.imports [ canonical(CapabilityStatement) ], ... ; # 0..* Canonical URL of another capability statement this adds to
  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 was 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 [ url ]; # 0..1 Base URL for the installation
    fhir:CapabilityStatement.implementation.custodian [ Reference(Organization) ]; # 0..1 Organization that manages the data
  ];
  fhir:CapabilityStatement.fhirVersion [ code ]; # 1..1 FHIR Version the system supports
  fhir:CapabilityStatement.format [ code ], ... ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:CapabilityStatement.patchFormat [ code ], ... ; # 0..* Patch formats supported
  fhir:CapabilityStatement.implementationGuide [ canonical(ImplementationGuide) ], ... ; # 0..* Implementation guides 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 [ markdown ]; # 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 [ markdown ]; # 0..1 General description of how security works
    ];
    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 [ canonical(StructureDefinition) ]; # 0..1 Base System profile for all uses of resource
      fhir:CapabilityStatement.rest.resource.supportedProfile [ canonical(StructureDefinition) ], ... ; # 0..* Profiles for use cases supported
      fhir:CapabilityStatement.rest.resource.documentation [ markdown ]; # 0..1 Additional information about the use of the resource type
      fhir:CapabilityStatement.rest.resource.interaction [ # 0..* 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 [ markdown ]; # 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 parameters supported by implementation
        fhir:CapabilityStatement.rest.resource.searchParam.name [ string ]; # 1..1 Name of search parameter
        fhir:CapabilityStatement.rest.resource.searchParam.definition [ canonical(SearchParameter) ]; # 0..1 Source of definition for parameter
        fhir:CapabilityStatement.rest.resource.searchParam.type [ code ]; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
        fhir:CapabilityStatement.rest.resource.searchParam.documentation [ markdown ]; # 0..1 Server-specific usage
      ], ...;
      fhir:CapabilityStatement.rest.resource.operation [ # 0..* Definition of a resource operation
        fhir:CapabilityStatement.rest.resource.operation.name [ string ]; # 1..1 Name by which the operation/query is invoked
        fhir:CapabilityStatement.rest.resource.operation.definition [ canonical(OperationDefinition) ]; # 1..1 The defined operation/query
        fhir:CapabilityStatement.rest.resource.operation.documentation [ markdown ]; # 0..1 Specific details about operation behavior
      ], ...;
    ], ...;
    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 [ markdown ]; # 0..1 Anything special about operation behavior
    ], ...;
    fhir:CapabilityStatement.rest.searchParam [ See CapabilityStatement.rest.resource.searchParam ], ... ; # 0..* Search parameters for searching all resources
    fhir:CapabilityStatement.rest.operation [ See CapabilityStatement.rest.resource.operation ], ... ; # 0..* Definition of a system level operation
    fhir:CapabilityStatement.rest.compartment [ canonical(CompartmentDefinition) ], ... ; # 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 [ url ]; # 1..1 Network address or identifier of the end-point
    ], ...;
    fhir:CapabilityStatement.messaging.reliableCache [ unsignedInt ]; # 0..1 Reliable Message Cache Length (min)
    fhir:CapabilityStatement.messaging.documentation [ markdown ]; # 0..1 Messaging interface behavior details
    fhir:CapabilityStatement.messaging.supportedMessage [ # 0..* Messages supported by this system
      fhir:CapabilityStatement.messaging.supportedMessage.mode [ code ]; # 1..1 sender | receiver
      fhir:CapabilityStatement.messaging.supportedMessage.definition [ canonical(MessageDefinition) ]; # 1..1 Message supported by this system
    ], ...;
  ], ...;
  fhir:CapabilityStatement.document [ # 0..* Document definition
    fhir:CapabilityStatement.document.mode [ code ]; # 1..1 producer | consumer
    fhir:CapabilityStatement.document.documentation [ markdown ]; # 0..1 Description of document support
    fhir:CapabilityStatement.document.profile [ canonical(StructureDefinition) ]; # 1..1 Constraint on the resources used in the document
  ], ...;
]

Changes since Release 4

CapabilityStatement
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

Conversions between R3 and R4

See R3 <--> R4 Conversion Maps (status = 9 tests that all execute ok. 1 fail round-trip testing and 9 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

5.2.4.1 Terminology Bindings

PathDefinitionTypeReference
CapabilityStatement.status RequiredPublicationStatus
CapabilityStatement.jurisdiction ExtensibleJurisdiction ValueSet
CapabilityStatement.kind RequiredCapabilityStatementKind
CapabilityStatement.fhirVersion RequiredFHIRVersion
CapabilityStatement.format RequiredMime Types
CapabilityStatement.patchFormat RequiredMime Types
CapabilityStatement.rest.mode RequiredRestfulCapabilityMode
CapabilityStatement.rest.security.service ExtensibleRestfulSecurityService
CapabilityStatement.rest.resource.type RequiredResourceType
CapabilityStatement.rest.resource.interaction.code RequiredTypeRestfulInteraction
CapabilityStatement.rest.resource.versioning RequiredResourceVersionPolicy
CapabilityStatement.rest.resource.conditionalRead RequiredConditionalReadStatus
CapabilityStatement.rest.resource.conditionalDelete RequiredConditionalDeleteStatus
CapabilityStatement.rest.resource.referencePolicy RequiredReferenceHandlingPolicy
CapabilityStatement.rest.resource.searchParam.type RequiredSearchParamType
CapabilityStatement.rest.interaction.code RequiredSystemRestfulInteraction
CapabilityStatement.messaging.endpoint.protocol ExtensibleMessageTransport
CapabilityStatement.messaging.supportedMessage.mode RequiredEventCapabilityMode
CapabilityStatement.document.mode RequiredDocumentMode

5.2.4.2 Constraints

idLevelLocationDescriptionExpression
cpb-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cpb-1Rule (base)A Capability Statement SHALL have at least one of REST, messaging or document element.rest.exists() or messaging.exists() or document.exists()
cpb-2Rule (base)A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
cpb-3Rule (base)Messaging end-point is required (and is only permitted) when a statement is for an implementation.messaging.endpoint.empty() or kind = 'instance'
cpb-7Rule (base)The set of documents must be unique by the combination of profile and mode.document.select(profile&mode).isDistinct()
cpb-9Rule CapabilityStatement.restA given resource can only be described once per RESTful mode.resource.select(type).isDistinct()
cpb-12Rule CapabilityStatement.rest.resourceSearch parameter names must be unique in the context of a resource.searchParam.select(name).isDistinct()
cpb-14Rule (base)If kind = instance, implementation must be present and software may be present(kind != 'instance') or implementation.exists()
cpb-15Rule (base)If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
cpb-16Rule (base)If kind = requirements, implementation and software must be absent(kind!='requirements') or (implementation.exists().not() and software.exists().not())

5.2.5 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.
    • The CapabilityStatement returned on demand may represent the specific capabilities granted to a specific user if retrieved with that specific user's credentials, if one is in context. Servers that require authentication SHOULD still return a CapabilityStatemnt before authentication/authorization is performed
    • 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
    • The MessageDefinition resource is newly proposed and is still considered 'draft'. The supportedMessage element can be used in place of the event and the work group believes it may meet implementer needs better, however because the new mechanism has not yet been reviewed by ballot, the older 'event' mechanism has been retained. Implementers may use one or the other to define their capabilities. Feedback is welcome.
  • 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.2.5.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.2.6 Search Parameters

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

NameTypeDescriptionExpressionIn Common
context TUtokenA use context assigned to the capability statement(CapabilityStatement.useContext.value as CodeableConcept)
context-quantity TUquantityA quantity- or range-valued use context assigned to the capability statement(CapabilityStatement.useContext.value as Quantity) | (CapabilityStatement.useContext.value as Range)
context-type TUtokenA type of use context assigned to the capability statementCapabilityStatement.useContext.code
context-type-quantity TUcompositeA use context type and quantity- or range-based value assigned to the capability statementOn CapabilityStatement.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-value TUcompositeA use context type and value assigned to the capability statementOn CapabilityStatement.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date TUdateThe capability statement publication dateCapabilityStatement.date
description TUstringThe description of the capability statementCapabilityStatement.description
fhirversion TUtokenThe version of FHIRCapabilityStatement.version
format TUtokenformats supported (xml | json | ttl | mime type)CapabilityStatement.format
guide TUreferenceImplementation guides supportedCapabilityStatement.implementationGuide
(ImplementationGuide)
jurisdiction TUtokenIntended jurisdiction for the capability statementCapabilityStatement.jurisdiction
mode TUtokenMode - restful (server/client) or messaging (sender/receiver)CapabilityStatement.rest.mode
name TUstringComputationally friendly name of the capability statementCapabilityStatement.name
publisher TUstringName of the publisher of the capability statementCapabilityStatement.publisher
resource TUtokenName of a resource mentioned in a capability statementCapabilityStatement.rest.resource.type
resource-profile TUreferenceA profile id invoked in a capability statementCapabilityStatement.rest.resource.profile
(StructureDefinition)
security-service TUtokenOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | CertificatesCapabilityStatement.rest.security.service
software TUstringPart of the name of a software applicationCapabilityStatement.software.name
status TUtokenThe current status of the capability statementCapabilityStatement.status
supported-profile TUreferenceProfiles for use cases supportedCapabilityStatement.rest.resource.supportedProfile
(StructureDefinition)
title TUstringThe human-friendly name of the capability statementCapabilityStatement.title
url TUuriThe uri that identifies the capability statementCapabilityStatement.url
version TUtokenThe business version of the capability statementCapabilityStatement.version