FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

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

Detailed Descriptions for the elements in the CapabilityStatement resource.

CapabilityStatement
Element IdCapabilityStatement
Definition

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.

Short DisplayA statement of system capabilities
Cardinality0..*
TypeCanonicalResource
Summaryfalse
Comments

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

Invariants
Defined on this element
cnl-0Warning 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}')
cpb-1Rule A Capability Statement SHALL have at least one of REST, messaging or document element.rest.exists() or messaging.exists() or document.exists()
cpb-2Rule A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
cpb-3Rule Messaging end-point is only permitted when a capability statement is for an implementation.messaging.endpoint.empty() or kind = 'instance'
cpb-4Rule There should only be one CapabilityStatement.rest per mode.rest.mode.isDistinct()
cpb-7Rule The set of documents must be unique by the combination of profile and mode.document.select(profile&mode).isDistinct()
cpb-14Rule If kind = instance, implementation must be present and software may be present(kind != 'instance') or implementation.exists()
cpb-15Rule If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
cpb-16Rule If kind = requirements, implementation and software must be absent(kind!='requirements') or (implementation.exists().not() and software.exists().not())
CapabilityStatement.url
Element IdCapabilityStatement.url
Definition

An absolute URI that is used to identify this capability statement when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which 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 servers.

Short DisplayCanonical identifier for this capability statement, represented as a URI (globally unique)
Cardinality0..1
Typeuri
Requirements

Allows the capability statement to be referenced by a single globally unique identifier.

Summarytrue
Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Defined on this element
cnl-1Warning URL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
CapabilityStatement.version
Element IdCapabilityStatement.version
Definition

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

Short DisplayBusiness version of the capability statement
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

There may be different capability statement instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the capability statement with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

CapabilityStatement.versionAlgorithm[x]
Element IdCapabilityStatement.versionAlgorithm[x]
Definition

Indicates the mechanism used to compare versions to determine which is more current.

Short DisplayHow to compare versions
Cardinality0..1
Terminology BindingVersion Algorithm (Extensible)
Typestring|Coding
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Summarytrue
Comments

If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

CapabilityStatement.name
Element IdCapabilityStatement.name
Definition

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

Short DisplayName for this capability statement (computer friendly)
Cardinality0..1
Typestring
Requirements

Support human navigation and code generation.

Summarytrue
Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Affect this element
cnl-0Warning 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}')
CapabilityStatement.title
Element IdCapabilityStatement.title
Definition

A short, descriptive, user-friendly title for the capability statement.

Short DisplayName for this capability statement (human friendly)
Cardinality0..1
Typestring
Summarytrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

CapabilityStatement.status
Element IdCapabilityStatement.status
Definition

The status of this capability statement. Enables tracking the life-cycle of the content.

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingPublicationStatus (Required)
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Summarytrue
Comments

Allows filtering of capability statements that are appropriate for use versus not.This is not intended for use with actual capability statements, but where capability statements are used to describe possible or desired systems.

CapabilityStatement.experimental
Element IdCapabilityStatement.experimental
Definition

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

Short DisplayFor testing purposes, not real usage
Cardinality0..1
Typeboolean
Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level capability statement.

Summarytrue
Comments

Allows filtering of capability statements that are appropriate for use versus not.

CapabilityStatement.date
Element IdCapabilityStatement.date
Definition

The date (and optionally time) when the capability statement was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the capability statement changes.

Short DisplayDate last changed
Cardinality1..1
TypedateTime
Alternate NamesRevision Date
Summarytrue
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the capability statement. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

CapabilityStatement.publisher
Element IdCapabilityStatement.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the capability statement.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the capability statement. May also allow for contact.

Summarytrue
Comments

Usually an organization but may be an individual. The publisher (or steward) of the capability statement is the organization or individual primarily responsible for the maintenance and upkeep of the capability statement. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the capability statement. This item SHOULD be populated unless the information is available from context.

CapabilityStatement.contact
Element IdCapabilityStatement.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Summarytrue
Comments

May be a web site, an email address, a telephone number, etc.

CapabilityStatement.description
Element IdCapabilityStatement.description
Definition

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

Short DisplayNatural language description of the capability statement
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This description can be used to capture details such as comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the capability statement as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the capability statement is presumed to be the predominant language in the place the capability statement was created).This does not need to be populated if the description is adequately implied by the software or implementation details.

Invariants
Affect this element
cpb-2Rule A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
CapabilityStatement.useContext
Element IdCapabilityStatement.useContext
Definition

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

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Summarytrue
Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

CapabilityStatement.jurisdiction
Element IdCapabilityStatement.jurisdiction
Definition

A legal or geographic region in which the capability statement is intended to be used.

Short DisplayIntended jurisdiction for capability statement (if applicable)
Cardinality0..*
Terminology BindingJurisdiction ValueSet (Extensible)
TypeCodeableConcept
Summarytrue
Comments

It may be possible for the capability statement to be used in jurisdictions other than those for which it was originally designed or intended.

CapabilityStatement.purpose
Element IdCapabilityStatement.purpose
Definition

Explanation of why this capability statement is needed and why it has been designed as it has.

Short DisplayWhy this capability statement is defined
Cardinality0..1
Typemarkdown
Summaryfalse
Comments

This element does not describe the usage of the capability statement. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this capability statement.

CapabilityStatement.copyright
Element IdCapabilityStatement.copyright
Definition

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

Short DisplayUse and/or publishing restrictions
Cardinality0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the capability statement and/or its content.

Alternate NamesLicense; Restrictions
Summaryfalse
Comments

...

CapabilityStatement.copyrightLabel
Element IdCapabilityStatement.copyrightLabel
Definition

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').

Short DisplayCopyright holder and year(s)
Cardinality0..1
Typestring
Requirements

Defines the content expected to be rendered in all representations of the artifact.

Summaryfalse
Comments

The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

CapabilityStatement.kind
Element IdCapabilityStatement.kind
Definition

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

Short Displayinstance | capability | requirements
Cardinality1..1
Terminology BindingCapabilityStatementKind (Required)
Typecode
Requirements

Allow searching the 3 modes.

Summarytrue
Invariants
Affect this element
cpb-15Rule If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
CapabilityStatement.instantiates
Element IdCapabilityStatement.instantiates
Definition

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

Short DisplayCanonical URL of another capability statement this implements
Cardinality0..*
Typecanonical(CapabilityStatement)
Summarytrue
Comments

HL7 defines the following Services: Terminology Service.

Many Implementation Guides icon define additional services.

CapabilityStatement.imports
Element IdCapabilityStatement.imports
Definition

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

Short DisplayCanonical URL of another capability statement this adds to
Cardinality0..*
Typecanonical(CapabilityStatement)
Summarytrue
Comments

the contents of any directly or indirectly imported CapabilityStatements SHALL NOT overlap, i.e. they cannot refer to the same rest/resource, operations/name, searchparam/name, interaction/code, messaging/endpoint, document/mode pair.

A capability statement that imports another CapabilityStatement automatically instantiates it too (though this is often not a very useful statement for the kinds of CapabilityStatements that are suitable for importing).

CapabilityStatement.software
Element IdCapabilityStatement.software
Definition

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

Short DisplaySoftware that is covered by this capability statement
Cardinality0..1
Summarytrue
Invariants
Affect this element
cpb-2Rule A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
CapabilityStatement.software.name
Element IdCapabilityStatement.software.name
Definition

Name the software is known by.

Short DisplayA name the software is known by
Cardinality1..1
Typestring
Summarytrue
CapabilityStatement.software.version
Element IdCapabilityStatement.software.version
Definition

The version identifier for the software covered by this statement.

Short DisplayVersion covered by this statement
NoteThis is a business versionId, not a resource version id (see discussion)
Cardinality0..1
Typestring
Summarytrue
Comments

If possible, a version should be specified, as statements are likely to be different for different versions of software.

CapabilityStatement.software.releaseDate
Element IdCapabilityStatement.software.releaseDate
Definition

Date this version of the software was released.

Short DisplayDate this version was released
Cardinality0..1
TypedateTime
Summarytrue
CapabilityStatement.implementation
Element IdCapabilityStatement.implementation
Definition

Identifies a specific implementation instance that is described by the capability statement - i.e. a particular installation, rather than the capabilities of a software program.

Short DisplayIf this describes a specific instance
Cardinality0..1
Summarytrue
Invariants
Affect this element
cpb-2Rule A Capability Statement SHALL have at least one of description, software, or implementation element.(description.count() + software.count() + implementation.count()) > 0
cpb-15Rule If kind = capability, implementation must be absent, software must be present(kind != 'capability') or (implementation.exists().not() and software.exists())
CapabilityStatement.implementation.description
Element IdCapabilityStatement.implementation.description
Definition

Information about the specific installation that this capability statement relates to.

Short DisplayDescribes this specific instance
Cardinality1..1
Typestring
Summarytrue
CapabilityStatement.implementation.url
Element IdCapabilityStatement.implementation.url
Definition

An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.

Short DisplayBase URL for the installation
Cardinality0..1
Typeurl
Summarytrue
CapabilityStatement.implementation.custodian
Element IdCapabilityStatement.implementation.custodian
Definition

The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.

Short DisplayOrganization that manages the data
Cardinality0..1
TypeReference(Organization)
Summarytrue
CapabilityStatement.fhirVersion
Element IdCapabilityStatement.fhirVersion
Definition

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

Short DisplayFHIR Version the system supports
Cardinality1..1
Terminology BindingFHIRVersion (Required)
Typecode
Summarytrue
Comments

Servers may implement multiple versions (see Managing Multiple Versions, and the $versions operation). If they do, and the CapabilityStatement is requested from the server, then this fhirVersion will be either the version requested, or the server's default version.

CapabilityStatement.format
Element IdCapabilityStatement.format
Definition

A list of the formats supported by this implementation using their content types.

Short Displayformats supported (xml | json | ttl | mime type)
Cardinality1..*
Terminology BindingCapability Format Type (Extensible but limited to Mime Types)
Typecode
Summarytrue
Comments

"xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here.

CapabilityStatement.patchFormat
Element IdCapabilityStatement.patchFormat
Definition

A list of the patch formats supported by this implementation using their content types.

Short DisplayPatch formats supported
Cardinality0..*
Terminology BindingMime Types (Required)
Typecode
Summarytrue
Comments

At present, the patch mime types application/json-patch+json and application/xml-patch+xml are legal. Generally, if a server supports PATCH, it would be expected to support the patch formats and match the formats it supports, but this is not always possible or necessary.

CapabilityStatement.acceptLanguage
Element IdCapabilityStatement.acceptLanguage
Definition

A list of the languages supported by this implementation that are usefully supported in the Accept-Language header.

Short DisplayLanguages supported
Cardinality0..*
Terminology BindingCommon Languages (Preferred but limited to All Languages)
Typecode
Summarytrue
Comments

In general, if a server gets a request with an Accept-Language that it doesn't support, it should still reutrn the resource, just in it's default language for the resource.

CapabilityStatement.implementationGuide
Element IdCapabilityStatement.implementationGuide
Definition

A list of implementation guides that the server does (or should) support in their entirety.

Short DisplayImplementation guides supported
Cardinality0..*
Typecanonical(ImplementationGuide)
Summarytrue
Comments

Note: this is primarily only relevant in terms of ImplementationGuides that don't define specific CapabilityStatements declaring the expectation of distinct roles. (E.g. generic IGs that establish privacy policies.) If CapabilityStatements are defined by the IG, then it is better to use CapabilityStatement.instantiates to identify the specific role(s) supported.

CapabilityStatement.rest
Element IdCapabilityStatement.rest
Definition

A definition of the restful capabilities of the solution, if any.

Short DisplayIf the endpoint is a RESTful one
Cardinality0..*
Summarytrue
Comments

Multiple repetitions allow definition of both client and/or server behaviors or possibly behaviors under different configuration settings (for software or requirements statements).

Invariants
Defined on this element
cpb-9Rule A given resource can only be described once per RESTful mode.resource.select(type).isDistinct()
Affect this element
cpb-1Rule A Capability Statement SHALL have at least one of REST, messaging or document element.rest.exists() or messaging.exists() or document.exists()
CapabilityStatement.rest.mode
Element IdCapabilityStatement.rest.mode
Definition

Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.

Short Displayclient | server
Cardinality1..1
Terminology BindingRestfulCapabilityMode (Required)
Typecode
Summarytrue
CapabilityStatement.rest.documentation
Element IdCapabilityStatement.rest.documentation
Definition

Information about the system's restful capabilities that apply across all applications, such as security.

Short DisplayGeneral description of implementation
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.rest.security
Element IdCapabilityStatement.rest.security
Definition

Information about security implementation from an interface perspective - what a client needs to know.

Short DisplayInformation about security of implementation
Cardinality0..1
Summarytrue
CapabilityStatement.rest.security.cors
Element IdCapabilityStatement.rest.security.cors
Definition

Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.

Short DisplayAdds CORS Headers (http://enable-cors.org/)
Cardinality0..1
Typeboolean
Summarytrue
Comments

The easiest CORS headers to add are Access-Control-Allow-Origin: * & Access-Control-Request-Method: GET, POST, PUT, DELETE. All servers SHOULD support CORS.

CapabilityStatement.rest.security.service
Element IdCapabilityStatement.rest.security.service
Definition

Types of security services that are supported/required by the system.

Short DisplayOAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates
Cardinality0..*
Terminology BindingRestfulSecurityService (Extensible)
TypeCodeableConcept
Summarytrue
CapabilityStatement.rest.security.description
Element IdCapabilityStatement.rest.security.description
Definition

General description of how security works.

Short DisplayGeneral description of how security works
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.rest.resource
Element IdCapabilityStatement.rest.resource
Definition

A specification of the restful capabilities of the solution for a specific resource type.

Short DisplayResource served on the REST interface
Cardinality0..*
Summarytrue
Comments

Max of one repetition per resource type.

Invariants
Defined on this element
cpb-12Rule Search parameter names must be unique in the context of a resource.searchParam.select(name).isDistinct()
CapabilityStatement.rest.resource.type
Element IdCapabilityStatement.rest.resource.type
Definition

A type of resource exposed via the restful interface.

Short DisplayA resource type that is supported
Cardinality1..1
Terminology BindingResource Types (Required)
Typecode
Summarytrue
CapabilityStatement.rest.resource.profile
Element IdCapabilityStatement.rest.resource.profile
Definition

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.

Short DisplaySystem-wide profile
Cardinality0..1
Typecanonical(StructureDefinition)
Summarytrue
Comments

All other profiles for this type that are listed in .rest.resource.supportedProfile must conform to this profile.

CapabilityStatement.rest.resource.supportedProfile
Element IdCapabilityStatement.rest.resource.supportedProfile
Definition

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.

Short DisplayUse-case specific profiles
Cardinality0..*
Typecanonical(StructureDefinition)
Summarytrue
Comments

Supported profiles must conform to the resource profile in the .rest.resource.profile element if it is present. The resource profile is a system-wide profile applied across all instances of the resource supported by the system. A supported profile is a statement about the functionality of the data and services provided by the server (or used by the client) for a particular set of use cases and will not necessarily apply to all data consumed or exposed by the server.

CapabilityStatement.rest.resource.documentation
Element IdCapabilityStatement.rest.resource.documentation
Definition

Additional information about the resource type used by the system.

Short DisplayAdditional information about the use of the resource type
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.rest.resource.interaction
Element IdCapabilityStatement.rest.resource.interaction
Definition

Identifies a restful operation supported by the solution.

Short DisplayWhat operations are supported?
Cardinality0..*
Summaryfalse
Comments

In general, a Resource will only appear in a CapabilityStatement if the server actually has some capabilities - e.g. there is at least one interaction supported. However interactions can be omitted to support summarization (_summary = true).

CapabilityStatement.rest.resource.interaction.code
Element IdCapabilityStatement.rest.resource.interaction.code
Definition

Coded identifier of the operation, supported by the system resource.

Short Displayread | vread | update | patch | delete | history-instance | history-type | create | search-type
Cardinality1..1
Terminology BindingTypeRestfulInteraction (Required)
Typecode
Summaryfalse
CapabilityStatement.rest.resource.interaction.documentation
Element IdCapabilityStatement.rest.resource.interaction.documentation
Definition

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

Short DisplayAnything special about operation behavior
Cardinality0..1
Typemarkdown
Requirements

REST allows a degree of variability in the implementation of RESTful solutions that is useful for exchange partners to be aware of.

Summaryfalse
CapabilityStatement.rest.resource.versioning
Element IdCapabilityStatement.rest.resource.versioning
Definition

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

Short Displayno-version | versioned | versioned-update
Cardinality0..1
Terminology BindingResourceVersionPolicy (Required)
Typecode
Summaryfalse
Comments

If a server supports versionIds correctly, it SHOULD support vread too, but is not required to do so.

CapabilityStatement.rest.resource.readHistory
Element IdCapabilityStatement.rest.resource.readHistory
Definition

A flag for whether the server is able to return past versions as part of the vRead operation.

Short DisplayWhether vRead can return past versions
Cardinality0..1
Typeboolean
Summaryfalse
Comments

It is useful to support the vRead operation for current operations, even if past versions aren't available.

CapabilityStatement.rest.resource.updateCreate
Element IdCapabilityStatement.rest.resource.updateCreate
Definition

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

Short DisplayIf update can commit to a new identity
Cardinality0..1
Typeboolean
Summaryfalse
Comments

Allowing the clients to create new identities on the server means that the system administrator needs to have confidence that the clients do not create clashing identities between them. Obviously, if there is only one client, this won't happen. While creating identities on the client means that the clients need to be managed, it's much more convenient for many scenarios if such management can be put in place.

CapabilityStatement.rest.resource.conditionalCreate
Element IdCapabilityStatement.rest.resource.conditionalCreate
Definition

A flag that indicates that the server supports conditional create.

Short DisplayIf allows/uses conditional create
Cardinality0..1
Typeboolean
Summaryfalse
Comments

Conditional Create is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalRead
Element IdCapabilityStatement.rest.resource.conditionalRead
Definition

A code that indicates how the server supports conditional read.

Short Displaynot-supported | modified-since | not-match | full-support
Cardinality0..1
Terminology BindingConditionalReadStatus (Required)
Typecode
Summaryfalse
Comments

Conditional Read is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalUpdate
Element IdCapabilityStatement.rest.resource.conditionalUpdate
Definition

A flag that indicates that the server supports conditional update.

Short DisplayIf allows/uses conditional update
Cardinality0..1
Typeboolean
Summaryfalse
Comments

Conditional Update is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalPatch
Element IdCapabilityStatement.rest.resource.conditionalPatch
Definition

A flag that indicates that the server supports conditional patch.

Short DisplayIf allows/uses conditional patch
Cardinality0..1
Typeboolean
Summaryfalse
Comments

Conditional Patch is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.conditionalDelete
Element IdCapabilityStatement.rest.resource.conditionalDelete
Definition

A code that indicates how the server supports conditional delete.

Short Displaynot-supported | single | multiple - how conditional delete is supported
Cardinality0..1
Terminology BindingConditionalDeleteStatus (Required)
Typecode
Summaryfalse
Comments

Conditional Delete is mainly appropriate for interface engine scripts converting from other formats, such as v2.

CapabilityStatement.rest.resource.referencePolicy
Element IdCapabilityStatement.rest.resource.referencePolicy
Definition

A set of flags that defines how references are supported.

Short Displayliteral | logical | resolves | enforced | local
Cardinality0..*
Terminology BindingReferenceHandlingPolicy (Required)
Typecode
Summaryfalse
CapabilityStatement.rest.resource.searchInclude
Element IdCapabilityStatement.rest.resource.searchInclude
Definition

A list of _include values supported by the server.

Short Display_include values supported by the server
Cardinality0..*
Typestring
Summaryfalse
Comments

Documenting _include icon support helps set conformance expectations for the desired system. Still, it is a level of detail that might not be exposed by production servers or clients when using CapabilityStatement to describe an actual implementation. If this list is empty, the server does not support includes. Support for iterative (a.k.a., recursive) _include is communicated by listing the iterative includes values supported by the server in the searchInclude element of the "root" resource type. For example, to support the following search:

GET [base]/CarePlan?_include=CarePlan:activity-reference:DeviceRequest&amp;_include:iterate=DeviceRequest:device

These values would be listed as part of capabilities for "CarePlan":

"searchInclude" : ["CarePlan:activity-reference:DeviceRequest","DeviceRequest:device"],

CapabilityStatement.rest.resource.searchRevInclude
Element IdCapabilityStatement.rest.resource.searchRevInclude
Definition

A list of _revinclude (reverse include) values supported by the server.

Short Display_revinclude values supported by the server
Cardinality0..*
Typestring
Summaryfalse
Comments

See CapabilityStatement.rest.resource.searchInclude comments.

CapabilityStatement.rest.resource.searchParam
Element IdCapabilityStatement.rest.resource.searchParam
Definition

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

Short DisplaySearch parameters supported by implementation
Cardinality0..*
Summaryfalse
Comments

The search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions.

CapabilityStatement.rest.resource.searchParam.name
Element IdCapabilityStatement.rest.resource.searchParam.name
Definition

The 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 code.

Short DisplayName for parameter in search url
Cardinality1..1
Typestring
Summaryfalse
Comments

Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined. There is no correspondence whatsoever between CapabilityStatement's searchParam.name and SearchParameter.name - the latter is used as a class name when generating code for the search parameter.

CapabilityStatement.rest.resource.searchParam.definition
Element IdCapabilityStatement.rest.resource.searchParam.definition
Definition

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). This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.

Short DisplaySource of definition for parameter
Cardinality0..1
Typecanonical(SearchParameter)
Summaryfalse
Comments

This SHOULD be present, and matches refers to a SearchParameter by its canonical URL. If systems wish to document their support for modifiers, comparators, target resource types, and chained parameters, they should do using a search parameter resource. This element SHALL be populated if the search parameter refers to a SearchParameter defined by the FHIR core specification or externally defined IGs.

CapabilityStatement.rest.resource.searchParam.type
Element IdCapabilityStatement.rest.resource.searchParam.type
Definition

The type of value a search parameter refers to, and how the content is interpreted.

Short Displaynumber | date | string | token | reference | composite | quantity | uri | special
Cardinality1..1
Terminology BindingSearchParamType (Required)
Typecode
Summaryfalse
Comments

While this can be looked up from the definition, it is included here as a convenience for systems that autogenerate a query interface based on the server capability statement. It SHALL be the same as the type in the search parameter definition.

CapabilityStatement.rest.resource.searchParam.documentation
Element IdCapabilityStatement.rest.resource.searchParam.documentation
Definition

This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.

Short DisplayServer-specific usage
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.rest.resource.operation
Element IdCapabilityStatement.rest.resource.operation
Definition

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

Short DisplayDefinition of a resource operation
Cardinality0..*
Summarytrue
Comments

Operations linked from CapabilityStatement.rest.resource.operation must have OperationDefinition.type = true or OperationDefinition.instance = true.

If an operation that is listed in multiple CapabilityStatement.rest.resource.operation (e.g. for different resource types), then clients should understand that the operation is only supported on the specified resource types, and that may be a subset of those listed in OperationDefinition.resource.

CapabilityStatement.rest.resource.operation.name
Element IdCapabilityStatement.rest.resource.operation.name
Definition

The 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 code.

Short DisplayName by which the operation/query is invoked
Cardinality1..1
Typestring
Summarytrue
Comments

The name here SHOULD be the same as the OperationDefinition.code in the referenced OperationDefinition, unless there is a name clash and the OperationDefinition.code cannot be used. The name does not include the "$" portion that is always included in the URL. There is no correspondence whatsoever between CapabilityStatement's operation.name and OperationDefinition.name - the latter is used as a class name when generating code for the operation. HL7 will never define operations that have conflicting names.

CapabilityStatement.rest.resource.operation.definition
Element IdCapabilityStatement.rest.resource.operation.definition
Definition

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 with a 'base' of the original OperationDefinition. The custom definition would describe the specific subset of functionality supported.

Short DisplayThe defined operation/query
Cardinality1..1
Typecanonical(OperationDefinition)
Summarytrue
Comments

This can be used to build an HTML form to invoke the operation, for instance.

CapabilityStatement.rest.resource.operation.documentation
Element IdCapabilityStatement.rest.resource.operation.documentation
Definition

Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.

Short DisplaySpecific details about operation behavior
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.rest.interaction
Element IdCapabilityStatement.rest.interaction
Definition

A specification of restful operations supported by the system.

Short DisplayWhat operations are supported?
Cardinality0..*
Summaryfalse
CapabilityStatement.rest.interaction.code
Element IdCapabilityStatement.rest.interaction.code
Definition

A coded identifier of the operation, supported by the system.

Short Displaytransaction | batch | search-system | history-system
Cardinality1..1
Terminology BindingSystemRestfulInteraction (Required)
Typecode
Summaryfalse
CapabilityStatement.rest.interaction.documentation
Element IdCapabilityStatement.rest.interaction.documentation
Definition

Guidance specific to the implementation of this operation, such as limitations on the kind of transactions allowed, or information about system wide search is implemented.

Short DisplayAnything special about operation behavior
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.rest.searchParam
Element IdCapabilityStatement.rest.searchParam
Definition

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

Short DisplaySearch parameters for searching all resources
Cardinality0..*
TypeSee CapabilityStatement.rest.resource.searchParam
Summaryfalse
Comments

Typically, the only search parameters supported for all searches are those that apply to all resources - tags, profiles, text search etc. These search parameters should include the control search parameters such as _sort, _count, etc. that also apply to this resource (though many will be listed at CapabilityStatement.rest.searchParam). The behavior of some search parameters may be further described by other code or extension elements, or narrative within the capability statement or linked SearchParameter definitions.

CapabilityStatement.rest.operation
Element IdCapabilityStatement.rest.operation
Definition

Definition of an operation or a named query together with its parameters and their meaning and type.

Short DisplayDefinition of a system level operation
Cardinality0..*
TypeSee CapabilityStatement.rest.resource.operation
Summarytrue
Comments

CapabilityStatement.rest.operation is for operations invoked at the system level, or for operations that are supported across multiple resource types. Operations linked from CapabilityStatement.rest.operation must have OperationDefinition.system = true, or more than one Operation.resource.

CapabilityStatement.rest.compartment
Element IdCapabilityStatement.rest.compartment
Definition

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 .

Short DisplayCompartments served/used by system
Cardinality0..*
Typecanonical(CompartmentDefinition)
Summaryfalse
Comments

At present, the only defined compartments are at CompartmentDefinition.

CapabilityStatement.messaging
Element IdCapabilityStatement.messaging
Definition

A description of the messaging capabilities of the solution.

Short DisplayIf messaging is supported
Cardinality0..*
Summarytrue
Comments

Multiple repetitions allow the documentation of multiple endpoints per solution.

Invariants
Affect this element
cpb-1Rule A Capability Statement SHALL have at least one of REST, messaging or document element.rest.exists() or messaging.exists() or document.exists()
CapabilityStatement.messaging.endpoint
Element IdCapabilityStatement.messaging.endpoint
Definition

An endpoint (network accessible address) to which messages and/or replies are to be sent.

Short DisplayWhere messages should be sent
Cardinality0..*
Alternate Names3
Summaryfalse
CapabilityStatement.messaging.endpoint.protocol
Element IdCapabilityStatement.messaging.endpoint.protocol
Definition

A list of the messaging transport protocol(s) identifiers, supported by this endpoint.

Short Displayhttp | ftp | mllp +
Cardinality1..1
Terminology BindingMessageTransport (Extensible)
TypeCoding
Summaryfalse
CapabilityStatement.messaging.endpoint.address
Element IdCapabilityStatement.messaging.endpoint.address
Definition

The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.

Short DisplayNetwork address or identifier of the end-point
Cardinality1..1
Typeurl
Summaryfalse
CapabilityStatement.messaging.reliableCache
Element IdCapabilityStatement.messaging.reliableCache
Definition

Length 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).

Short DisplayReliable Message Cache Length (min)
Cardinality0..1
TypeunsignedInt
Summaryfalse
Comments

If this value is missing then the application does not implement (receiver) or depend on (sender) reliable messaging.

CapabilityStatement.messaging.documentation
Element IdCapabilityStatement.messaging.documentation
Definition

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

Short DisplayMessaging interface behavior details
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.messaging.supportedMessage
Element IdCapabilityStatement.messaging.supportedMessage
Definition

References to message definitions for messages this system can send or receive.

Short DisplayMessages supported by this system
Cardinality0..*
Summarytrue
Comments

This is a proposed alternative to the messaging.event structure.

CapabilityStatement.messaging.supportedMessage.mode
Element IdCapabilityStatement.messaging.supportedMessage.mode
Definition

The mode of this event declaration - whether application is sender or receiver.

Short Displaysender | receiver
Cardinality1..1
Terminology BindingEventCapabilityMode (Required)
Typecode
Summarytrue
CapabilityStatement.messaging.supportedMessage.definition
Element IdCapabilityStatement.messaging.supportedMessage.definition
Definition

Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.

Short DisplayMessage supported by this system
Cardinality1..1
Typecanonical(MessageDefinition)
Summarytrue
CapabilityStatement.document
Element IdCapabilityStatement.document
Definition

A document definition.

Short DisplayDocument definition
Cardinality0..*
Summarytrue
Invariants
Affect this element
cpb-1Rule A Capability Statement SHALL have at least one of REST, messaging or document element.rest.exists() or messaging.exists() or document.exists()
CapabilityStatement.document.mode
Element IdCapabilityStatement.document.mode
Definition

Mode of this document declaration - whether an application is a producer or consumer.

Short Displayproducer | consumer
Cardinality1..1
Terminology BindingDocumentMode (Required)
Typecode
Summarytrue
CapabilityStatement.document.documentation
Element IdCapabilityStatement.document.documentation
Definition

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, etc.

Short DisplayDescription of document support
Cardinality0..1
Typemarkdown
Summaryfalse
CapabilityStatement.document.profile
Element IdCapabilityStatement.document.profile
Definition

A profile on the document Bundle that constrains which resources are present, and their contents.

Short DisplayConstraint on the resources used in the document
Cardinality1..1
Typecanonical(StructureDefinition)
Summarytrue
Comments

The profile is actually on the Bundle.