Current Build
FHIR Infrastructure 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 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.

Cardinality0..*
TypeDomainResource
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
cpb-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,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 required (and is only permitted) when a statement is for an implementation.messaging.endpoint.empty() or kind = 'instance'
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 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.

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.

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.

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

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.

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
inv-0Warning Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
CapabilityStatement.title
Element IdCapabilityStatement.title
Definition

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

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.

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.

Cardinality0..1
Typeboolean
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.

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 that published the capability statement.

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.

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.

Cardinality0..1
Typemarkdown
Comments

This description can be used to capture details such as why the capability statement was built, 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.

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.

Cardinality0..*
Terminology BindingJurisdiction (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.

Cardinality0..1
Typemarkdown
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.

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

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.

Cardinality0..*
Typecanonical(CapabilityStatement)
Summarytrue
Comments

HL7 defines the following Services: Terminology Service.

Many Implementation Guides 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.

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.

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.

Cardinality1..1
Typestring
Summarytrue
CapabilityStatement.software.version
Element IdCapabilityStatement.software.version
Definition

The version identifier for the software 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.

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.

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.

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.

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.

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.

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.

Cardinality1..*
Terminology BindingMimeType (Required)
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.

Cardinality0..*
Terminology BindingMimeType (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.implementationGuide
Element IdCapabilityStatement.implementationGuide
Definition

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

Cardinality0..*
Typecanonical(ImplementationGuide)
Summarytrue
CapabilityStatement.rest
Element IdCapabilityStatement.rest
Definition

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

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.

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.

Cardinality0..1
Typemarkdown
CapabilityStatement.rest.security
Element IdCapabilityStatement.rest.security
Definition

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

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.

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.

Cardinality0..*
Terminology BindingRestfulSecurityService (Extensible)
TypeCodeableConcept
Summarytrue
CapabilityStatement.rest.security.description
Element IdCapabilityStatement.rest.security.description
Definition

General description of how security works.

Cardinality0..1
Typemarkdown
CapabilityStatement.rest.resource
Element IdCapabilityStatement.rest.resource
Definition

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

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.

Cardinality1..1
Terminology BindingAny defined Resource Type name
Typecode
Summarytrue
CapabilityStatement.rest.resource.profile
Element IdCapabilityStatement.rest.resource.profile
Definition

A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in Using Profiles.

Cardinality0..1
Typecanonical(StructureDefinition)
Summarytrue
Comments

The profile applies to all resources of this type - i.e. it is the superset of what is supported by the system.

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

A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in Using Profiles.

Cardinality0..*
Typecanonical(StructureDefinition)
Summarytrue
Comments

Supported profiles are different than the profile that applies to a particular resource in .rest.resource.profile. The resource profile is a general statement of what features of the resource are supported overall by the system - the sum total of the facilities it supports. A supported profile is a deeper statement about the functionality of the data and services provided by the server (or used by the client). A typical case is a laboratory system that produces a set of different reports - this is the list of types of data that it publishes. A key aspect of declaring profiles here is the question of how the client converts knowledge that the server publishes this data into working with the data; the client can inspect individual resources to determine whether they conform to a particular profile, but how does it find the ones that do? It does so by searching using the _profile parameter, so any resources listed here must be valid values for the _profile resource (using the identifier in the target profile).

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

Additional information about the resource type used by the system.

Cardinality0..1
Typemarkdown
CapabilityStatement.rest.resource.interaction
Element IdCapabilityStatement.rest.resource.interaction
Definition

Identifies a restful operation supported by the solution.

Cardinality0..*
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.

Cardinality1..1
Terminology BindingTypeRestfulInteraction (Required)
Typecode
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'.

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.

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.

Cardinality0..1
Terminology BindingResourceVersionPolicy (Required)
Typecode
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.

Cardinality0..1
Typeboolean
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.

Cardinality0..1
Typeboolean
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.

Cardinality0..1
Typeboolean
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.

Cardinality0..1
Terminology BindingConditionalReadStatus (Required)
Typecode
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.

Cardinality0..1
Typeboolean
Comments

Conditional Update 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.

Cardinality0..1
Terminology BindingConditionalDeleteStatus (Required)
Typecode
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.

Cardinality0..*
Terminology BindingReferenceHandlingPolicy (Required)
Typecode
CapabilityStatement.rest.resource.searchInclude
Element IdCapabilityStatement.rest.resource.searchInclude
Definition

A list of _include values supported by the server.

Cardinality0..*
Typestring
Comments

If this list is empty, the server does not support includes.

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

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

Cardinality0..*
Typestring
Comments

If this list is empty, the server does not support reverse includes.

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.

Cardinality0..*
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 name of the search parameter used in the interface.

Cardinality1..1
Typestring
Comments

Parameter names cannot overlap with standard parameter names, and standard parameters cannot be redefined.

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.

Cardinality0..1
Typecanonical(SearchParameter)
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.

Cardinality1..1
Terminology BindingSearchParamType (Required)
Typecode
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.

Cardinality0..1
Typemarkdown
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.

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 is the name prefixed with $ and used in the URL. For a query, this is the name used in the _query parameter when the query is called.

Cardinality1..1
Typestring
Summarytrue
Comments

The name here SHOULD be the same as the name in the definition, unless there is a name clash and the name cannot be used. The name does not include the "$" portion that is always included in the URL.

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.

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.

Cardinality0..1
Typemarkdown
CapabilityStatement.rest.interaction
Element IdCapabilityStatement.rest.interaction
Definition

A specification of restful operations supported by the system.

Cardinality0..*
CapabilityStatement.rest.interaction.code
Element IdCapabilityStatement.rest.interaction.code
Definition

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

Cardinality1..1
Terminology BindingSystemRestfulInteraction (Required)
Typecode
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.

Cardinality0..1
Typemarkdown
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.

Cardinality0..*
TypeSee CapabilityStatement.rest.resource.searchParam
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.

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 .

Cardinality0..*
Typecanonical(CompartmentDefinition)
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.

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.

Cardinality0..*
Alternate Names3
CapabilityStatement.messaging.endpoint.protocol
Element IdCapabilityStatement.messaging.endpoint.protocol
Definition

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

Cardinality1..1
Terminology BindingMessageTransport (Extensible)
TypeCoding
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.

Cardinality1..1
Typeurl
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).

Cardinality0..1
TypeunsignedInt
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.

Cardinality0..1
Typemarkdown
CapabilityStatement.messaging.supportedMessage
Element IdCapabilityStatement.messaging.supportedMessage
Definition

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

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.

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.

Cardinality1..1
Typecanonical(MessageDefinition)
Summarytrue
CapabilityStatement.document
Element IdCapabilityStatement.document
Definition

A document 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.

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.

Cardinality0..1
Typemarkdown
CapabilityStatement.document.profile
Element IdCapabilityStatement.document.profile
Definition

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

Cardinality1..1
Typecanonical(StructureDefinition)
Summarytrue
Comments

The profile is actually on the Bundle.