Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3

5.3 Resource CapabilityStatement - Content

FHIR Infrastructure icon Work GroupMaturity Level: N Normative (from v4.0.0)Security Category: Anonymous Compartments: No defined compartments

A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server or Client 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.3.1 Scope and Usage

The capability statement is a key part of the overall conformance framework in FHIR. It is used as a statement of the features of actual software, or of a set of rules for an application to provide. This statement connects to all the detailed statements of functionality, such as StructureDefinitions and ValueSets. This composite statement of application capability may be used for system compatibility testing, code generation, or as 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.3.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.3.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.3.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.3.2 Background and Context

Capability Statements provide for a degree of automatic configuration and adaptation. However, capturing absolutely every variation that could impact the interoperability of two systems, let alone keeping that detailed information up-to-date as systems evolve through maintenance and upgrades, is rarely practical. Therefore, capability statements should be seen as an interim step. They provide a degree of automation. However, they also provide a great deal of human-readable content that can minimize the need for direct communication between the operators of the systems being configured to interoperate.

5.3.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.3.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 icon 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.3.3 References to this Resource

5.3.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 only permitted when a capability statement is for an implementation.
+ Rule: There should only be one CapabilityStatement.rest per mode.
+ 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
Interfaces Implemented: CanonicalResource
... url ΣC0..1uriCanonical identifier for this capability statement, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier ΣTU0..*IdentifierAdditional identifier for the CapabilityStatement (business identifier)

... version Σ0..1stringBusiness version of the capability statement
... versionAlgorithm[x] ΣTU0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this capability statement (computer friendly)
... title ΣT0..1stringName for this capability statement (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description TC0..1markdownNatural language description of the capability statement
... useContext ΣTU0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this capability statement is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel TTU0..1stringCopyright holder and year(s)
... kind ΣC1..1codeinstance | capability | requirements
Binding: Capability Statement Kind (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 ΣC0..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 ΣC0..1BackboneElementIf this describes a specific instance
.... description Σ1..1markdownDescribes 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
Binding: FHIRVersion (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
Binding: Mime Types (Required)
Additional BindingsPurpose
Capability Format TypeStarter Set


... patchFormat Σ0..*codePatch formats supported
Binding: Mime Types (Required)

... acceptLanguage ΣTU0..*codeLanguages supported
Binding: All Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set


... implementationGuide Σ0..*canonical(ImplementationGuide)Implementation guides supported

... rest ΣC0..*BackboneElementIf the endpoint is a RESTful one
+ Rule: A given resource can only be described once per RESTful mode.

.... mode ΣC1..1codeclient | server
Binding: Restful Capability Mode (Required)
.... documentation T0..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
Binding: Restful Security Service (Extensible)

..... description T0..1markdownGeneral description of how security works
.... resource ΣC0..*BackboneElementResource served on the REST interface
+ Rule: Search parameter names must be unique in the context of a resource.

..... type ΣC1..1codeA resource type that is supported
Binding: Resource Types (Required)
..... profile Σ0..1canonical(StructureDefinition)System-wide profile
..... supportedProfile ΣTU0..*canonical(StructureDefinition)Use-case specific profiles

..... documentation T0..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
Binding: Type Restful Interaction (Required)
...... documentation T0..1markdownAnything special about operation behavior
..... versioning TU0..1codeno-version | versioned | versioned-update
Binding: Resource Version Policy (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
Binding: Conditional Read Status (Required)
..... conditionalUpdate TU0..1booleanIf allows/uses conditional update
..... conditionalPatch TU0..1booleanIf allows/uses conditional patch
..... conditionalDelete TU0..1codenot-supported | single | multiple - how conditional delete is supported
Binding: Conditional Delete Status (Required)
..... referencePolicy TU0..*codeliteral | logical | resolves | enforced | local
Binding: Reference Handling Policy (Required)

..... searchInclude TU0..*string_include values supported by the server

..... searchRevInclude TU0..*string_revinclude values supported by the server

..... searchParam C0..*BackboneElementSearch parameters supported by implementation

...... name C1..1stringName for parameter in search url
...... definition 0..1canonical(SearchParameter)Source of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: 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 T0..1markdownSpecific details about operation behavior
.... interaction 0..*BackboneElementWhat operations are supported?

..... code 1..1codetransaction | batch | search-system | history-system
Binding: System Restful Interaction (Required)
..... documentation T0..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 ΣCTU0..*BackboneElementIf messaging is supported

.... endpoint C0..*BackboneElementWhere messages should be sent

..... protocol 1..1Codinghttp | ftp | mllp +
Binding: Message Transport (Extensible)
..... address 1..1urlNetwork address or identifier of the end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation T0..1markdownMessaging interface behavior details
.... supportedMessage Σ0..*BackboneElementMessages supported by this system

..... mode Σ1..1codesender | receiver
Binding: Event Capability Mode (Required)
..... definition Σ1..1canonical(MessageDefinition)Message supported by this system
... document ΣCTU0..*BackboneElementDocument definition

.... mode ΣC1..1codeproducer | consumer
Binding: Document Mode (Required)
.... documentation T0..1markdownDescription of document support
.... profile ΣC1..1canonical(StructureDefinition)Constraint on the resources used in the document

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

CapabilityStatement (DomainResource) +CanonicalResourceAn 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 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]A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]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]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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] « This element has or is affected by some invariantsC »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 last significantly changed. 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 responsible for the release and ongoing maintenance of 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] « This element has or is affected by some invariantsC »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)JurisdictionValueSet+ »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]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [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! » « This element has or is affected by some invariantsC »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)MimeTypes! »A list of the patch formats supported by this implementation using their content typespatchFormat : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeTypes! »A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` headeracceptLanguage : code [0..*] « null (Strength=Required)AllLanguages! »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 : markdown [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! » « This element has or is affected by some invariantsC »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! » « This element has or is affected by some invariantsC »A system-wide profile that is applied across *all* instances of the resource supported by the system. For example, if declared on Observation, this profile is the "superset" of capabilities for laboratory *and* vitals *and* other domains. See further discussion in [Using Profiles](profiling.html#profile-uses)profile : canonical [0..1] « StructureDefinition »A list of profiles representing different use cases the system hosts/produces. A supported profile is a statement about the functionality of the data and services provided by the server (or the client) for supported use cases. For example, a system can define and declare multiple Observation profiles for laboratory observations, vital sign observations, etc. By declaring supported profiles, systems provide a way to determine whether individual resources are conformant. 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 flag that indicates that the server supports conditional patchconditionalPatch : 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 label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same codename : string [1..1] « This element has or is affected by some invariantsC »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 name is prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. This SHOULD be the same as the OperationDefinition.code of the defining OperationDefinition. However, it can sometimes differ if necessary to disambiguate when a server supports multiple OperationDefinition that happen to share the same codename : 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! » « This element has or is affected by some invariantsC »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 » « This element has or is affected by some invariantsC »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 implementation. This is only for searches executed against the system-level endpointsearchParam[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) -->
 <identifier><!-- 0..* Identifier Additional identifier for the CapabilityStatement (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the capability statement -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 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/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 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 -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <kind value="[code]"/><!-- I 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>  <!-- I 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>  <!-- I 0..1 If this describes a specific instance -->
  <description value="[markdown]"/><!-- 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 -->
 <acceptLanguage value="[code]"/><!-- 0..* Languages supported -->
 <implementationGuide><!-- 0..* canonical(ImplementationGuide) Implementation guides supported --></implementationGuide>
 <rest>  <!-- I 0..* If the endpoint is a RESTful one -->
  <mode value="[code]"/><!-- I 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>  <!-- I 0..* Resource served on the REST interface -->
   <type value="[code]"/><!-- I 1..1 A resource type that is supported -->
   <profile><!-- 0..1 canonical(StructureDefinition) System-wide profile --></profile>
   <supportedProfile><!-- 0..* canonical(StructureDefinition) Use-case specific profiles --></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 -->
   <conditionalPatch value="[boolean]"/><!-- 0..1 If allows/uses conditional patch -->
   <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>  <!-- I 0..* Search parameters supported by implementation -->
    <name value="[string]"/><!-- I 1..1 Name for parameter in search url -->
    <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>  <!-- I 0..* If messaging is supported -->
  <endpoint>  <!-- I 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>  <!-- I 0..* Document definition -->
  <mode value="[code]"/><!-- I 1..1 producer | consumer -->
  <documentation value="[markdown]"/><!-- 0..1 Description of document support -->
  <profile><!-- I 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)
  "identifier" : [{ Identifier }], // Additional identifier for the CapabilityStatement (business identifier)
  "version" : "<string>", // Business version of the capability statement
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I 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/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // I 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
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "kind" : "<code>", // I 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" : { // I 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" : { // I If this describes a specific instance
    "description" : "<markdown>", // 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
  "acceptLanguage" : ["<code>"], // Languages supported
  "implementationGuide" : ["<canonical(ImplementationGuide)>"], // Implementation guides supported
  "rest" : [{ // I If the endpoint is a RESTful one
    "mode" : "<code>", // I 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" : [{ // I Resource served on the REST interface
      "type" : "<code>", // I R!  A resource type that is supported
      "profile" : "<canonical(StructureDefinition)>", // System-wide profile
      "supportedProfile" : ["<canonical(StructureDefinition)>"], // Use-case specific profiles
      "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
      "conditionalPatch" : <boolean>, // If allows/uses conditional patch
      "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" : [{ // I Search parameters supported by implementation
        "name" : "<string>", // I R!  Name for parameter in search url
        "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" : [{ // I If messaging is supported
    "endpoint" : [{ // I 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" : [{ // I Document definition
    "mode" : "<code>", // I R!  producer | consumer
    "documentation" : "<markdown>", // Description of document support
    "profile" : "<canonical(StructureDefinition)>" // I 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:url [ uri ] ; # 0..1 Canonical identifier for this capability statement, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the CapabilityStatement (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the capability statement
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this capability statement (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this capability statement (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 1..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 I Natural language description of the capability statement
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for capability statement (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this capability statement is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:kind [ code ] ; # 1..1 I instance | capability | requirements
  fhir:instantiates  ( [ canonical(CapabilityStatement) ] ... ) ; # 0..* Canonical URL of another capability statement this implements
  fhir:imports  ( [ canonical(CapabilityStatement) ] ... ) ; # 0..* Canonical URL of another capability statement this adds to
  fhir:software [ # 0..1 I Software that is covered by this capability statement
    fhir:name [ string ] ; # 1..1 A name the software is known by
    fhir:version [ string ] ; # 0..1 Version covered by this statement
    fhir:releaseDate [ dateTime ] ; # 0..1 Date this version was released
  ] ;
  fhir:implementation [ # 0..1 I If this describes a specific instance
    fhir:description [ markdown ] ; # 1..1 Describes this specific instance
    fhir:url [ url ] ; # 0..1 Base URL for the installation
    fhir:custodian [ Reference(Organization) ] ; # 0..1 Organization that manages the data
  ] ;
  fhir:fhirVersion [ code ] ; # 1..1 FHIR Version the system supports
  fhir:format  ( [ code ] ... ) ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:patchFormat  ( [ code ] ... ) ; # 0..* Patch formats supported
  fhir:acceptLanguage  ( [ code ] ... ) ; # 0..* Languages supported
  fhir:implementationGuide  ( [ canonical(ImplementationGuide) ] ... ) ; # 0..* Implementation guides supported
  fhir:rest ( [ # 0..* I If the endpoint is a RESTful one
    fhir:mode [ code ] ; # 1..1 I client | server
    fhir:documentation [ markdown ] ; # 0..1 General description of implementation
    fhir:security [ # 0..1 Information about security of implementation
      fhir:cors [ boolean ] ; # 0..1 Adds CORS Headers (http://enable-cors.org/)
      fhir:service  ( [ CodeableConcept ] ... ) ; # 0..* OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
      fhir:description [ markdown ] ; # 0..1 General description of how security works
    ] ;
    fhir:resource ( [ # 0..* I Resource served on the REST interface
      fhir:type [ code ] ; # 1..1 I A resource type that is supported
      fhir:profile [ canonical(StructureDefinition) ] ; # 0..1 System-wide profile
      fhir:supportedProfile  ( [ canonical(StructureDefinition) ] ... ) ; # 0..* Use-case specific profiles
      fhir:documentation [ markdown ] ; # 0..1 Additional information about the use of the resource type
      fhir:interaction ( [ # 0..* What operations are supported?
        fhir:code [ code ] ; # 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type
        fhir:documentation [ markdown ] ; # 0..1 Anything special about operation behavior
      ] ... ) ;
      fhir:versioning [ code ] ; # 0..1 no-version | versioned | versioned-update
      fhir:readHistory [ boolean ] ; # 0..1 Whether vRead can return past versions
      fhir:updateCreate [ boolean ] ; # 0..1 If update can commit to a new identity
      fhir:conditionalCreate [ boolean ] ; # 0..1 If allows/uses conditional create
      fhir:conditionalRead [ code ] ; # 0..1 not-supported | modified-since | not-match | full-support
      fhir:conditionalUpdate [ boolean ] ; # 0..1 If allows/uses conditional update
      fhir:conditionalPatch [ boolean ] ; # 0..1 If allows/uses conditional patch
      fhir:conditionalDelete [ code ] ; # 0..1 not-supported | single | multiple - how conditional delete is supported
      fhir:referencePolicy  ( [ code ] ... ) ; # 0..* literal | logical | resolves | enforced | local
      fhir:searchInclude  ( [ string ] ... ) ; # 0..* _include values supported by the server
      fhir:searchRevInclude  ( [ string ] ... ) ; # 0..* _revinclude values supported by the server
      fhir:searchParam ( [ # 0..* I Search parameters supported by implementation
        fhir:name [ string ] ; # 1..1 I Name for parameter in search url
        fhir:definition [ canonical(SearchParameter) ] ; # 0..1 Source of definition for parameter
        fhir:type [ code ] ; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
        fhir:documentation [ markdown ] ; # 0..1 Server-specific usage
      ] ... ) ;
      fhir:operation ( [ # 0..* Definition of a resource operation
        fhir:name [ string ] ; # 1..1 Name by which the operation/query is invoked
        fhir:definition [ canonical(OperationDefinition) ] ; # 1..1 The defined operation/query
        fhir:documentation [ markdown ] ; # 0..1 Specific details about operation behavior
      ] ... ) ;
    ] ... ) ;
    fhir:interaction ( [ # 0..* What operations are supported?
      fhir:code [ code ] ; # 1..1 transaction | batch | search-system | history-system
      fhir:documentation [ markdown ] ; # 0..1 Anything special about operation behavior
    ] ... ) ;
    fhir:searchParam  ( [ See CapabilityStatement.rest.resource.searchParam ] ... ) ; # 0..* Search parameters for searching all resources
    fhir:operation  ( [ See CapabilityStatement.rest.resource.operation ] ... ) ; # 0..* Definition of a system level operation
    fhir:compartment  ( [ canonical(CompartmentDefinition) ] ... ) ; # 0..* Compartments served/used by system
  ] ... ) ;
  fhir:messaging ( [ # 0..* I If messaging is supported
    fhir:endpoint ( [ # 0..* I Where messages should be sent
      fhir:protocol [ Coding ] ; # 1..1 http | ftp | mllp +
      fhir:address [ url ] ; # 1..1 Network address or identifier of the end-point
    ] ... ) ;
    fhir:reliableCache [ unsignedInt ] ; # 0..1 Reliable Message Cache Length (min)
    fhir:documentation [ markdown ] ; # 0..1 Messaging interface behavior details
    fhir:supportedMessage ( [ # 0..* Messages supported by this system
      fhir:mode [ code ] ; # 1..1 sender | receiver
      fhir:definition [ canonical(MessageDefinition) ] ; # 1..1 Message supported by this system
    ] ... ) ;
  ] ... ) ;
  fhir:document ( [ # 0..* I Document definition
    fhir:mode [ code ] ; # 1..1 I producer | consumer
    fhir:documentation [ markdown ] ; # 0..1 Description of document support
    fhir:profile [ canonical(StructureDefinition) ] ; # 1..1 I Constraint on the resources used in the document
  ] ... ) ;
]

Changes from R4 and R4B

CapabilityStatement
CapabilityStatement.identifier
  • Added Element
CapabilityStatement.versionAlgorithm[x]
  • Added Element
CapabilityStatement.copyrightLabel
  • Added Element
CapabilityStatement.implementation.description
  • Type changed from string to markdown
CapabilityStatement.fhirVersion
  • Add codes 0.0, 0.4, 0.5, 1.0, 1.1, 1.4, 1.6, 1.8, 3.0, 3.0.2, 3.3, 3.5, 4.0, 4.0.1, 4.1, 4.1.0, 4.2, 4.2.0, 4.3, 4.3.0, 4.3.0-cibuild, 4.3.0-snapshot1, 4.4, 4.4.0, 4.5, 4.5.0, 4.6, 4.6.0, 5.0, 5.0.0, 5.0.0-cibuild, 5.0.0-snapshot1, 5.0.0-snapshot2, 5.0.0-ballot, 5.0.0-snapshot3, 5.0.0-draft-final
CapabilityStatement.acceptLanguage
  • Added Element
CapabilityStatement.rest.security.service
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/restful-security-service" to "http://hl7.org/fhir/restful-security-service"
CapabilityStatement.rest.resource.type
  • Remove codes CatalogEntry, DeviceUseStatement, DocumentManifest, DomainResource, EffectEvidenceSynthesis, Media, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, RequestGroup, ResearchDefinition, ResearchElementDefinition, Resource, RiskEvidenceSynthesis, SubstanceSpecification
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport
CapabilityStatement.rest.resource.conditionalPatch
  • Added Element
CapabilityStatement.messaging.endpoint.protocol
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/message-transport" to "http://hl7.org/fhir/message-transport"

Changes from R4 and R4B

CapabilityStatement
CapabilityStatement.identifier
  • Added Element
CapabilityStatement.versionAlgorithm[x]
  • Added Element
CapabilityStatement.copyrightLabel
  • Added Element
CapabilityStatement.implementation.description
  • Type changed from string to markdown
CapabilityStatement.fhirVersion
  • Add codes 0.0, 0.4, 0.5, 1.0, 1.1, 1.4, 1.6, 1.8, 3.0, 3.0.2, 3.3, 3.5, 4.0, 4.0.1, 4.1, 4.1.0, 4.2, 4.2.0, 4.3, 4.3.0, 4.3.0-cibuild, 4.3.0-snapshot1, 4.4, 4.4.0, 4.5, 4.5.0, 4.6, 4.6.0, 5.0, 5.0.0, 5.0.0-cibuild, 5.0.0-snapshot1, 5.0.0-snapshot2, 5.0.0-ballot, 5.0.0-snapshot3, 5.0.0-draft-final
CapabilityStatement.acceptLanguage
  • Added Element
CapabilityStatement.rest.security.service
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/restful-security-service" to "http://hl7.org/fhir/restful-security-service"
CapabilityStatement.rest.resource.type
  • Remove codes CatalogEntry, DeviceUseStatement, DocumentManifest, DomainResource, EffectEvidenceSynthesis, Media, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, RequestGroup, ResearchDefinition, ResearchElementDefinition, Resource, RiskEvidenceSynthesis, SubstanceSpecification
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport
CapabilityStatement.rest.resource.conditionalPatch
  • Added Element
CapabilityStatement.messaging.endpoint.protocol
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/message-transport" to "http://hl7.org/fhir/message-transport"

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

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 only permitted when a capability statement is for an implementation.
+ Rule: There should only be one CapabilityStatement.rest per mode.
+ 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
Interfaces Implemented: CanonicalResource
... url ΣC0..1uriCanonical identifier for this capability statement, represented as a URI (globally unique)
+ Warning: URL should not contain | or # - these characters make processing canonical references problematic
... identifier ΣTU0..*IdentifierAdditional identifier for the CapabilityStatement (business identifier)

... version Σ0..1stringBusiness version of the capability statement
... versionAlgorithm[x] ΣTU0..1How to compare versions
Binding: Version Algorithm (Extensible)
.... versionAlgorithmStringstring
.... versionAlgorithmCodingCoding
... name ΣC0..1stringName for this capability statement (computer friendly)
... title ΣT0..1stringName for this capability statement (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
Binding: PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ1..1dateTimeDate last changed
... publisher ΣT0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher

... description TC0..1markdownNatural language description of the capability statement
... useContext ΣTU0..*UsageContextThe context that the content is intended to support

... jurisdiction ΣXD0..*CodeableConceptIntended jurisdiction for capability statement (if applicable)
Binding: Jurisdiction ValueSet (Extensible)

... purpose T0..1markdownWhy this capability statement is defined
... copyright T0..1markdownUse and/or publishing restrictions
... copyrightLabel TTU0..1stringCopyright holder and year(s)
... kind ΣC1..1codeinstance | capability | requirements
Binding: Capability Statement Kind (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 ΣC0..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 ΣC0..1BackboneElementIf this describes a specific instance
.... description Σ1..1markdownDescribes 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
Binding: FHIRVersion (Required)
... format Σ1..*codeformats supported (xml | json | ttl | mime type)
Binding: Mime Types (Required)
Additional BindingsPurpose
Capability Format TypeStarter Set


... patchFormat Σ0..*codePatch formats supported
Binding: Mime Types (Required)

... acceptLanguage ΣTU0..*codeLanguages supported
Binding: All Languages (Required)
Additional BindingsPurpose
Common LanguagesStarter Set


... implementationGuide Σ0..*canonical(ImplementationGuide)Implementation guides supported

... rest ΣC0..*BackboneElementIf the endpoint is a RESTful one
+ Rule: A given resource can only be described once per RESTful mode.

.... mode ΣC1..1codeclient | server
Binding: Restful Capability Mode (Required)
.... documentation T0..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
Binding: Restful Security Service (Extensible)

..... description T0..1markdownGeneral description of how security works
.... resource ΣC0..*BackboneElementResource served on the REST interface
+ Rule: Search parameter names must be unique in the context of a resource.

..... type ΣC1..1codeA resource type that is supported
Binding: Resource Types (Required)
..... profile Σ0..1canonical(StructureDefinition)System-wide profile
..... supportedProfile ΣTU0..*canonical(StructureDefinition)Use-case specific profiles

..... documentation T0..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
Binding: Type Restful Interaction (Required)
...... documentation T0..1markdownAnything special about operation behavior
..... versioning TU0..1codeno-version | versioned | versioned-update
Binding: Resource Version Policy (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
Binding: Conditional Read Status (Required)
..... conditionalUpdate TU0..1booleanIf allows/uses conditional update
..... conditionalPatch TU0..1booleanIf allows/uses conditional patch
..... conditionalDelete TU0..1codenot-supported | single | multiple - how conditional delete is supported
Binding: Conditional Delete Status (Required)
..... referencePolicy TU0..*codeliteral | logical | resolves | enforced | local
Binding: Reference Handling Policy (Required)

..... searchInclude TU0..*string_include values supported by the server

..... searchRevInclude TU0..*string_revinclude values supported by the server

..... searchParam C0..*BackboneElementSearch parameters supported by implementation

...... name C1..1stringName for parameter in search url
...... definition 0..1canonical(SearchParameter)Source of definition for parameter
...... type 1..1codenumber | date | string | token | reference | composite | quantity | uri | special
Binding: 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 T0..1markdownSpecific details about operation behavior
.... interaction 0..*BackboneElementWhat operations are supported?

..... code 1..1codetransaction | batch | search-system | history-system
Binding: System Restful Interaction (Required)
..... documentation T0..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 ΣCTU0..*BackboneElementIf messaging is supported

.... endpoint C0..*BackboneElementWhere messages should be sent

..... protocol 1..1Codinghttp | ftp | mllp +
Binding: Message Transport (Extensible)
..... address 1..1urlNetwork address or identifier of the end-point
.... reliableCache 0..1unsignedIntReliable Message Cache Length (min)
.... documentation T0..1markdownMessaging interface behavior details
.... supportedMessage Σ0..*BackboneElementMessages supported by this system

..... mode Σ1..1codesender | receiver
Binding: Event Capability Mode (Required)
..... definition Σ1..1canonical(MessageDefinition)Message supported by this system
... document ΣCTU0..*BackboneElementDocument definition

.... mode ΣC1..1codeproducer | consumer
Binding: Document Mode (Required)
.... documentation T0..1markdownDescription of document support
.... profile ΣC1..1canonical(StructureDefinition)Constraint on the resources used in the document

doco Documentation for this format icon

See the Extensions for this resource

UML Diagram (Legend)

CapabilityStatement (DomainResource) +CanonicalResourceAn 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 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]A formal identifier that is used to identify this CapabilityStatement when it is represented in other formats, or referenced in a specification, model, design or an instanceidentifier : Identifier [0..*]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]Indicates the mechanism used to compare versions to determine which is more currentversionAlgorithm[x] : DataType [0..1] « string|Coding; null (Strength=Extensible) VersionAlgorithm+ »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] « This element has or is affected by some invariantsC »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 last significantly changed. 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 responsible for the release and ongoing maintenance of 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] « This element has or is affected by some invariantsC »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)JurisdictionValueSet+ »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]A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved')copyrightLabel : string [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! » « This element has or is affected by some invariantsC »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)MimeTypes! »A list of the patch formats supported by this implementation using their content typespatchFormat : code [0..*] « The mime type of an attachment. Any valid mime type is allowed. (Strength=Required)MimeTypes! »A list of the languages supported by this implementation that are usefully supported in the ```Accept-Language``` headeracceptLanguage : code [0..*] « null (Strength=Required)AllLanguages! »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 : markdown [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! » « This element has or is affected by some invariantsC »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! » « This element has or is affected by some invariantsC »A system-wide profile that is applied across *all* instances of the resource supported by the system. For example, if declared on Observation, this profile is the "superset" of capabilities for laboratory *and* vitals *and* other domains. See further discussion in [Using Profiles](profiling.html#profile-uses)profile : canonical [0..1] « StructureDefinition »A list of profiles representing different use cases the system hosts/produces. A supported profile is a statement about the functionality of the data and services provided by the server (or the client) for supported use cases. For example, a system can define and declare multiple Observation profiles for laboratory observations, vital sign observations, etc. By declaring supported profiles, systems provide a way to determine whether individual resources are conformant. 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 flag that indicates that the server supports conditional patchconditionalPatch : 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 label used for the search parameter in this particular system's API - i.e. the 'name' portion of the name-value pair that will appear as part of the search URL. This SHOULD be the same as the SearchParameter.code of the defining SearchParameter. However, it can sometimes differ if necessary to disambiguate when a server supports multiple SearchParameters that happen to share the same codename : string [1..1] « This element has or is affected by some invariantsC »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 name is prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called. This SHOULD be the same as the OperationDefinition.code of the defining OperationDefinition. However, it can sometimes differ if necessary to disambiguate when a server supports multiple OperationDefinition that happen to share the same codename : 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! » « This element has or is affected by some invariantsC »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 » « This element has or is affected by some invariantsC »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 implementation. This is only for searches executed against the system-level endpointsearchParam[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) -->
 <identifier><!-- 0..* Identifier Additional identifier for the CapabilityStatement (business identifier) --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the capability statement -->
 <versionAlgorithm[x]><!-- 0..1 string|Coding How to compare versions --></versionAlgorithm[x]>
 <name value="[string]"/><!-- I 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/steward (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- I 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 -->
 <copyrightLabel value="[string]"/><!-- 0..1 Copyright holder and year(s) -->
 <kind value="[code]"/><!-- I 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>  <!-- I 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>  <!-- I 0..1 If this describes a specific instance -->
  <description value="[markdown]"/><!-- 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 -->
 <acceptLanguage value="[code]"/><!-- 0..* Languages supported -->
 <implementationGuide><!-- 0..* canonical(ImplementationGuide) Implementation guides supported --></implementationGuide>
 <rest>  <!-- I 0..* If the endpoint is a RESTful one -->
  <mode value="[code]"/><!-- I 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>  <!-- I 0..* Resource served on the REST interface -->
   <type value="[code]"/><!-- I 1..1 A resource type that is supported -->
   <profile><!-- 0..1 canonical(StructureDefinition) System-wide profile --></profile>
   <supportedProfile><!-- 0..* canonical(StructureDefinition) Use-case specific profiles --></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 -->
   <conditionalPatch value="[boolean]"/><!-- 0..1 If allows/uses conditional patch -->
   <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>  <!-- I 0..* Search parameters supported by implementation -->
    <name value="[string]"/><!-- I 1..1 Name for parameter in search url -->
    <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>  <!-- I 0..* If messaging is supported -->
  <endpoint>  <!-- I 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>  <!-- I 0..* Document definition -->
  <mode value="[code]"/><!-- I 1..1 producer | consumer -->
  <documentation value="[markdown]"/><!-- 0..1 Description of document support -->
  <profile><!-- I 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)
  "identifier" : [{ Identifier }], // Additional identifier for the CapabilityStatement (business identifier)
  "version" : "<string>", // Business version of the capability statement
  // versionAlgorithm[x]: How to compare versions. One of these 2:
  "versionAlgorithmString" : "<string>",
  "versionAlgorithmCoding" : { Coding },
  "name" : "<string>", // I 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/steward (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // I 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
  "copyrightLabel" : "<string>", // Copyright holder and year(s)
  "kind" : "<code>", // I 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" : { // I 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" : { // I If this describes a specific instance
    "description" : "<markdown>", // 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
  "acceptLanguage" : ["<code>"], // Languages supported
  "implementationGuide" : ["<canonical(ImplementationGuide)>"], // Implementation guides supported
  "rest" : [{ // I If the endpoint is a RESTful one
    "mode" : "<code>", // I 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" : [{ // I Resource served on the REST interface
      "type" : "<code>", // I R!  A resource type that is supported
      "profile" : "<canonical(StructureDefinition)>", // System-wide profile
      "supportedProfile" : ["<canonical(StructureDefinition)>"], // Use-case specific profiles
      "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
      "conditionalPatch" : <boolean>, // If allows/uses conditional patch
      "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" : [{ // I Search parameters supported by implementation
        "name" : "<string>", // I R!  Name for parameter in search url
        "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" : [{ // I If messaging is supported
    "endpoint" : [{ // I 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" : [{ // I Document definition
    "mode" : "<code>", // I R!  producer | consumer
    "documentation" : "<markdown>", // Description of document support
    "profile" : "<canonical(StructureDefinition)>" // I 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:url [ uri ] ; # 0..1 Canonical identifier for this capability statement, represented as a URI (globally unique)
  fhir:identifier  ( [ Identifier ] ... ) ; # 0..* Additional identifier for the CapabilityStatement (business identifier)
  fhir:version [ string ] ; # 0..1 Business version of the capability statement
  # versionAlgorithm[x] : 0..1 How to compare versions. One of these 2
    fhir:versionAlgorithm [  a fhir:string ; string ]
    fhir:versionAlgorithm [  a fhir:Coding ; Coding ]
  fhir:name [ string ] ; # 0..1 I Name for this capability statement (computer friendly)
  fhir:title [ string ] ; # 0..1 Name for this capability statement (human friendly)
  fhir:status [ code ] ; # 1..1 draft | active | retired | unknown
  fhir:experimental [ boolean ] ; # 0..1 For testing purposes, not real usage
  fhir:date [ dateTime ] ; # 1..1 Date last changed
  fhir:publisher [ string ] ; # 0..1 Name of the publisher/steward (organization or individual)
  fhir:contact  ( [ ContactDetail ] ... ) ; # 0..* Contact details for the publisher
  fhir:description [ markdown ] ; # 0..1 I Natural language description of the capability statement
  fhir:useContext  ( [ UsageContext ] ... ) ; # 0..* The context that the content is intended to support
  fhir:jurisdiction  ( [ CodeableConcept ] ... ) ; # 0..* Intended jurisdiction for capability statement (if applicable)
  fhir:purpose [ markdown ] ; # 0..1 Why this capability statement is defined
  fhir:copyright [ markdown ] ; # 0..1 Use and/or publishing restrictions
  fhir:copyrightLabel [ string ] ; # 0..1 Copyright holder and year(s)
  fhir:kind [ code ] ; # 1..1 I instance | capability | requirements
  fhir:instantiates  ( [ canonical(CapabilityStatement) ] ... ) ; # 0..* Canonical URL of another capability statement this implements
  fhir:imports  ( [ canonical(CapabilityStatement) ] ... ) ; # 0..* Canonical URL of another capability statement this adds to
  fhir:software [ # 0..1 I Software that is covered by this capability statement
    fhir:name [ string ] ; # 1..1 A name the software is known by
    fhir:version [ string ] ; # 0..1 Version covered by this statement
    fhir:releaseDate [ dateTime ] ; # 0..1 Date this version was released
  ] ;
  fhir:implementation [ # 0..1 I If this describes a specific instance
    fhir:description [ markdown ] ; # 1..1 Describes this specific instance
    fhir:url [ url ] ; # 0..1 Base URL for the installation
    fhir:custodian [ Reference(Organization) ] ; # 0..1 Organization that manages the data
  ] ;
  fhir:fhirVersion [ code ] ; # 1..1 FHIR Version the system supports
  fhir:format  ( [ code ] ... ) ; # 1..* formats supported (xml | json | ttl | mime type)
  fhir:patchFormat  ( [ code ] ... ) ; # 0..* Patch formats supported
  fhir:acceptLanguage  ( [ code ] ... ) ; # 0..* Languages supported
  fhir:implementationGuide  ( [ canonical(ImplementationGuide) ] ... ) ; # 0..* Implementation guides supported
  fhir:rest ( [ # 0..* I If the endpoint is a RESTful one
    fhir:mode [ code ] ; # 1..1 I client | server
    fhir:documentation [ markdown ] ; # 0..1 General description of implementation
    fhir:security [ # 0..1 Information about security of implementation
      fhir:cors [ boolean ] ; # 0..1 Adds CORS Headers (http://enable-cors.org/)
      fhir:service  ( [ CodeableConcept ] ... ) ; # 0..* OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
      fhir:description [ markdown ] ; # 0..1 General description of how security works
    ] ;
    fhir:resource ( [ # 0..* I Resource served on the REST interface
      fhir:type [ code ] ; # 1..1 I A resource type that is supported
      fhir:profile [ canonical(StructureDefinition) ] ; # 0..1 System-wide profile
      fhir:supportedProfile  ( [ canonical(StructureDefinition) ] ... ) ; # 0..* Use-case specific profiles
      fhir:documentation [ markdown ] ; # 0..1 Additional information about the use of the resource type
      fhir:interaction ( [ # 0..* What operations are supported?
        fhir:code [ code ] ; # 1..1 read | vread | update | patch | delete | history-instance | history-type | create | search-type
        fhir:documentation [ markdown ] ; # 0..1 Anything special about operation behavior
      ] ... ) ;
      fhir:versioning [ code ] ; # 0..1 no-version | versioned | versioned-update
      fhir:readHistory [ boolean ] ; # 0..1 Whether vRead can return past versions
      fhir:updateCreate [ boolean ] ; # 0..1 If update can commit to a new identity
      fhir:conditionalCreate [ boolean ] ; # 0..1 If allows/uses conditional create
      fhir:conditionalRead [ code ] ; # 0..1 not-supported | modified-since | not-match | full-support
      fhir:conditionalUpdate [ boolean ] ; # 0..1 If allows/uses conditional update
      fhir:conditionalPatch [ boolean ] ; # 0..1 If allows/uses conditional patch
      fhir:conditionalDelete [ code ] ; # 0..1 not-supported | single | multiple - how conditional delete is supported
      fhir:referencePolicy  ( [ code ] ... ) ; # 0..* literal | logical | resolves | enforced | local
      fhir:searchInclude  ( [ string ] ... ) ; # 0..* _include values supported by the server
      fhir:searchRevInclude  ( [ string ] ... ) ; # 0..* _revinclude values supported by the server
      fhir:searchParam ( [ # 0..* I Search parameters supported by implementation
        fhir:name [ string ] ; # 1..1 I Name for parameter in search url
        fhir:definition [ canonical(SearchParameter) ] ; # 0..1 Source of definition for parameter
        fhir:type [ code ] ; # 1..1 number | date | string | token | reference | composite | quantity | uri | special
        fhir:documentation [ markdown ] ; # 0..1 Server-specific usage
      ] ... ) ;
      fhir:operation ( [ # 0..* Definition of a resource operation
        fhir:name [ string ] ; # 1..1 Name by which the operation/query is invoked
        fhir:definition [ canonical(OperationDefinition) ] ; # 1..1 The defined operation/query
        fhir:documentation [ markdown ] ; # 0..1 Specific details about operation behavior
      ] ... ) ;
    ] ... ) ;
    fhir:interaction ( [ # 0..* What operations are supported?
      fhir:code [ code ] ; # 1..1 transaction | batch | search-system | history-system
      fhir:documentation [ markdown ] ; # 0..1 Anything special about operation behavior
    ] ... ) ;
    fhir:searchParam  ( [ See CapabilityStatement.rest.resource.searchParam ] ... ) ; # 0..* Search parameters for searching all resources
    fhir:operation  ( [ See CapabilityStatement.rest.resource.operation ] ... ) ; # 0..* Definition of a system level operation
    fhir:compartment  ( [ canonical(CompartmentDefinition) ] ... ) ; # 0..* Compartments served/used by system
  ] ... ) ;
  fhir:messaging ( [ # 0..* I If messaging is supported
    fhir:endpoint ( [ # 0..* I Where messages should be sent
      fhir:protocol [ Coding ] ; # 1..1 http | ftp | mllp +
      fhir:address [ url ] ; # 1..1 Network address or identifier of the end-point
    ] ... ) ;
    fhir:reliableCache [ unsignedInt ] ; # 0..1 Reliable Message Cache Length (min)
    fhir:documentation [ markdown ] ; # 0..1 Messaging interface behavior details
    fhir:supportedMessage ( [ # 0..* Messages supported by this system
      fhir:mode [ code ] ; # 1..1 sender | receiver
      fhir:definition [ canonical(MessageDefinition) ] ; # 1..1 Message supported by this system
    ] ... ) ;
  ] ... ) ;
  fhir:document ( [ # 0..* I Document definition
    fhir:mode [ code ] ; # 1..1 I producer | consumer
    fhir:documentation [ markdown ] ; # 0..1 Description of document support
    fhir:profile [ canonical(StructureDefinition) ] ; # 1..1 I Constraint on the resources used in the document
  ] ... ) ;
]

Changes from R4 and R4B

CapabilityStatement
CapabilityStatement.identifier
  • Added Element
CapabilityStatement.versionAlgorithm[x]
  • Added Element
CapabilityStatement.copyrightLabel
  • Added Element
CapabilityStatement.implementation.description
  • Type changed from string to markdown
CapabilityStatement.fhirVersion
  • Add codes 0.0, 0.4, 0.5, 1.0, 1.1, 1.4, 1.6, 1.8, 3.0, 3.0.2, 3.3, 3.5, 4.0, 4.0.1, 4.1, 4.1.0, 4.2, 4.2.0, 4.3, 4.3.0, 4.3.0-cibuild, 4.3.0-snapshot1, 4.4, 4.4.0, 4.5, 4.5.0, 4.6, 4.6.0, 5.0, 5.0.0, 5.0.0-cibuild, 5.0.0-snapshot1, 5.0.0-snapshot2, 5.0.0-ballot, 5.0.0-snapshot3, 5.0.0-draft-final
CapabilityStatement.acceptLanguage
  • Added Element
CapabilityStatement.rest.security.service
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/restful-security-service" to "http://hl7.org/fhir/restful-security-service"
CapabilityStatement.rest.resource.type
  • Remove codes CatalogEntry, DeviceUseStatement, DocumentManifest, DomainResource, EffectEvidenceSynthesis, Media, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, RequestGroup, ResearchDefinition, ResearchElementDefinition, Resource, RiskEvidenceSynthesis, SubstanceSpecification
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport
CapabilityStatement.rest.resource.conditionalPatch
  • Added Element
CapabilityStatement.messaging.endpoint.protocol
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/message-transport" to "http://hl7.org/fhir/message-transport"

Changes from R4 and R4B

CapabilityStatement
CapabilityStatement.identifier
  • Added Element
CapabilityStatement.versionAlgorithm[x]
  • Added Element
CapabilityStatement.copyrightLabel
  • Added Element
CapabilityStatement.implementation.description
  • Type changed from string to markdown
CapabilityStatement.fhirVersion
  • Add codes 0.0, 0.4, 0.5, 1.0, 1.1, 1.4, 1.6, 1.8, 3.0, 3.0.2, 3.3, 3.5, 4.0, 4.0.1, 4.1, 4.1.0, 4.2, 4.2.0, 4.3, 4.3.0, 4.3.0-cibuild, 4.3.0-snapshot1, 4.4, 4.4.0, 4.5, 4.5.0, 4.6, 4.6.0, 5.0, 5.0.0, 5.0.0-cibuild, 5.0.0-snapshot1, 5.0.0-snapshot2, 5.0.0-ballot, 5.0.0-snapshot3, 5.0.0-draft-final
CapabilityStatement.acceptLanguage
  • Added Element
CapabilityStatement.rest.security.service
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/restful-security-service" to "http://hl7.org/fhir/restful-security-service"
CapabilityStatement.rest.resource.type
  • Remove codes CatalogEntry, DeviceUseStatement, DocumentManifest, DomainResource, EffectEvidenceSynthesis, Media, MedicinalProduct, MedicinalProductAuthorization, MedicinalProductContraindication, MedicinalProductIndication, MedicinalProductIngredient, MedicinalProductInteraction, MedicinalProductManufactured, MedicinalProductPackaged, MedicinalProductPharmaceutical, MedicinalProductUndesirableEffect, RequestGroup, ResearchDefinition, ResearchElementDefinition, Resource, RiskEvidenceSynthesis, SubstanceSpecification
  • Add codes ActorDefinition, AdministrableProductDefinition, ArtifactAssessment, BiologicallyDerivedProductDispense, Citation, ClinicalUseDefinition, ConditionDefinition, DeviceAssociation, DeviceDispense, DeviceUsage, EncounterHistory, EvidenceReport, FormularyItem, GenomicStudy, ImagingSelection, Ingredient, InventoryItem, InventoryReport, ManufacturedItemDefinition, MedicinalProductDefinition, NutritionIntake, NutritionProduct, PackagedProductDefinition, Permission, RegulatedAuthorization, RequestOrchestration, Requirements, SubscriptionStatus, SubscriptionTopic, SubstanceDefinition, TestPlan, Transport
CapabilityStatement.rest.resource.conditionalPatch
  • Added Element
CapabilityStatement.messaging.endpoint.protocol
  • Change code system for extensibly bound codes from "http://terminology.hl7.org/CodeSystem/message-transport" to "http://hl7.org/fhir/message-transport"

See the Full Difference for further information

This analysis is available for R4 as XML or JSON and for R4B as XML or JSON.

See R4 <--> R5 Conversion Maps (status = See Conversions Summary.)

 

Additional definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) , the spreadsheet version & the dependency analysis

5.3.4.1 Terminology Bindings

PathValueSetTypeDocumentation
CapabilityStatement.versionAlgorithm[x] VersionAlgorithm Extensible

Indicates the mechanism used to compare versions to determine which is more current.
CapabilityStatement.status PublicationStatus Required

The lifecycle status of an artifact.
CapabilityStatement.jurisdiction JurisdictionValueSet Extensible

This value set defines a base set of codes for country, country subdivision and region for indicating where a resource is intended to be used.

Note: The codes for countries and country subdivisions are taken from ISO 3166 icon while the codes for "supra-national" regions are from UN Standard country or area codes for statistical use (M49) icon.
CapabilityStatement.kind CapabilityStatementKind Required

How a capability statement is intended to be used.
CapabilityStatement.fhirVersion FHIRVersion Required

All published FHIR Versions.
CapabilityStatement.format MimeTypes (a valid code from urn:ietf:bcp:13)Required

This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)
  Capability Format Type starter
CapabilityStatement.patchFormat MimeTypes (a valid code from urn:ietf:bcp:13)Required

This value set includes all possible codes from BCP-13 (see http://tools.ietf.org/html/bcp13)
CapabilityStatement.acceptLanguage AllLanguages (a valid code from Tags for the Identification of Languages icon)Required

This value set includes all possible codes from BCP-47 (see http://tools.ietf.org/html/bcp47)
  Common Languages starter
CapabilityStatement.rest.mode RestfulCapabilityMode Required

The mode of a RESTful capability statement.
CapabilityStatement.rest.security.service RestfulSecurityService Extensible

Types of security services used with FHIR.
CapabilityStatement.rest.resource.type ResourceType Required

Concrete FHIR Resource Types
CapabilityStatement.rest.resource.interaction.code TypeRestfulInteraction Required

Operations supported by REST at the type or instance level.
CapabilityStatement.rest.resource.versioning ResourceVersionPolicy Required

How the system supports versioning for a resource.
CapabilityStatement.rest.resource.conditionalRead ConditionalReadStatus Required

A code that indicates how the server supports conditional read.
CapabilityStatement.rest.resource.conditionalDelete ConditionalDeleteStatus Required

A code that indicates how the server supports conditional delete.
CapabilityStatement.rest.resource.referencePolicy ReferenceHandlingPolicy Required

A set of flags that defines how references are supported.
CapabilityStatement.rest.resource.searchParam.type SearchParamType Required

Data types allowed to be used for search parameters.
CapabilityStatement.rest.interaction.code SystemRestfulInteraction Required

Operations supported by REST at the system level.
CapabilityStatement.messaging.endpoint.protocol MessageTransport Extensible

The protocol used for message transport.
CapabilityStatement.messaging.supportedMessage.mode EventCapabilityMode Required

The mode of a message capability statement.
CapabilityStatement.document.mode DocumentMode Required

Whether the application produces or consumes documents.

5.3.4.2 Constraints

UniqueKeyLevelLocationDescriptionExpression
img cnl-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_]){1,254}$')
img cnl-1Warning CapabilityStatement.urlURL should not contain | or # - these characters make processing canonical references problematicexists() implies matches('^[^|# ]+$')
img 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()
img cpb-2Rule (base)A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
img cpb-3Rule (base)Messaging end-point is only permitted when a capability statement is for an implementation.messaging.endpoint.empty() or kind = 'instance'
img cpb-4Rule (base)There should only be one CapabilityStatement.rest per mode.rest.mode.isDistinct()
img cpb-7Rule (base)The set of documents must be unique by the combination of profile and mode.document.select(profile&mode).isDistinct()
img cpb-9Rule CapabilityStatement.restA given resource can only be described once per RESTful mode.resource.select(type).isDistinct()
img cpb-12Rule CapabilityStatement.rest.resourceSearch parameter names must be unique in the context of a resource.searchParam.select(name).isDistinct()
img cpb-14Rule (base)If kind = instance, implementation must be present and software may be present(kind != 'instance') or implementation.exists()
img cpb-15Rule (base)If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
img cpb-16Rule (base)If kind = requirements, implementation and software must be absent(kind!='requirements') or (implementation.exists().not() and software.exists().not())

5.3.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 in the capabilities interaction 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 CapabilityStatement 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.3.5.1 Supporting Search

One of the most important parts of the CapabilityStatement is indicating what search functionality a server supports or a client uses. The search can specify the following things:

  • What resource types search is supported on, or used on
  • What search parameters are supported, and what their names are on this server (the server can use alternative names). Note that clients can also choose to use alternative names for search parameters, but there is no expectation that servers will adapt for the client in this regard
  • Servers can define their own search parameters that are not sourced from elsewhere, and often to define searches on extensions (see example)
  • What include and reverse includes a server supports, or a client uses
  • The Capability Statement does not support saying anything about modifiers or chaining directly, but these kind of statements can be made in the referenced search parameter resources (using SearchParameter.derivedFrom to establish traceability to the original definition of the search parameter)
  • Systems can also make statements about their use or support for system wide search (not associated with a particular resource type)

Note to Implementers: It is useful to support discovery of which reverse chaining values a server supports. Clients should not assume that servers support reverse chaining everywhere they support forward chaining. This will require a new field somewhere (e.g., in CapabilityStatement or in SearchParameter). Will review with FHIR-I, re: the best place to put this.

The most important use of support for reverse (or forward!) chaining might be in establishing conformance requirements for a server, rather than in supporting "live" discovery of a server's capabilities. (The latter could simply be tested by a client, rather than relying on possibly-incomplete or possibly-incorrect discovery data.)

Open question #1 would we want a way for servers to advertise which specific pairs of (searched resource + reverse chained search params) it support. For example, a server might need to say that the following is supported: 

GET [base]/Patient?_has:Observation:subject:code=1234-5

... even though the following is not: 

GET [base]/Group?_has:Observation:subject:code=1234-5

Open question #2: concern is that the possibility space is so broad that it might not be worth capturing all of this in such detail. Where to draw the line?

Note to Implementers: There is no way for a server to communicate how it supports search at this time. FHIR-I plans to address this and other search issues for R6.

5.3.5.2 Supporting Profiles

A CapabilityStatement declares two different kinds of profiles for the functionality it describes. For a discussion of the use of these two types of resources, see two uses for profiles.

5.3.6 Search Parameters

Search parameters for this resource. See also the full list of search parameters for this resource, and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the capability statement(CapabilityStatement.useContext.value.ofType(CodeableConcept))30 Resources
context-quantityquantityA quantity- or range-valued use context assigned to the capability statement(CapabilityStatement.useContext.value.ofType(Quantity)) | (CapabilityStatement.useContext.value.ofType(Range))30 Resources
context-type TUtokenA type of use context assigned to the capability statementCapabilityStatement.useContext.code30 Resources
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.ofType(Quantity) | value.ofType(Range)		30 Resources
context-type-value TUcompositeA use context type and value assigned to the capability statementOn CapabilityStatement.useContext:
  context-type: code
  context: value.ofType(CodeableConcept)		30 Resources
datedateThe capability statement publication dateCapabilityStatement.date30 Resources
descriptionstringThe description of the capability statementCapabilityStatement.description28 Resources
fhirversiontokenThe version of FHIRCapabilityStatement.fhirVersion
formattokenformats supported (xml | json | ttl | mime type)CapabilityStatement.format
guidereferenceImplementation guides supportedCapabilityStatement.implementationGuide
(ImplementationGuide)
identifiertokenExternal identifier for the capability statementCapabilityStatement.identifier34 Resources
jurisdictiontokenIntended jurisdiction for the capability statementCapabilityStatement.jurisdiction26 Resources
modetokenMode - restful (server/client) or messaging (sender/receiver)CapabilityStatement.rest.mode
namestringComputationally friendly name of the capability statementCapabilityStatement.name26 Resources
publisherstringName of the publisher of the capability statementCapabilityStatement.publisher30 Resources
resourcetokenName of a resource mentioned in a capability statementCapabilityStatement.rest.resource.type
resource-profilereferenceA profile id invoked in a capability statementCapabilityStatement.rest.resource.profile
(StructureDefinition)
security-servicetokenOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | CertificatesCapabilityStatement.rest.security.service
softwarestringPart of the name of a software applicationCapabilityStatement.software.name
statustokenThe current status of the capability statementCapabilityStatement.status35 Resources
supported-profile TUreferenceProfiles for use cases supportedCapabilityStatement.rest.resource.supportedProfile
(StructureDefinition)
titlestringThe human-friendly name of the capability statementCapabilityStatement.title27 Resources
urluriThe uri that identifies the capability statementCapabilityStatement.url34 Resources
versiontokenThe business version of the capability statementCapabilityStatement.version30 Resources