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.
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.
If the element is present, it must have either a @value, an @id, or extensions
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.
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.
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.
A short, descriptive, user-friendly title for the capability statement.
The status of this capability statement. Enables tracking the life-cycle of the content.
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.
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.
The name of the organization or individual that published the capability statement.
Contact details to assist a user in finding and communicating with the publisher.
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.
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.
A legal or geographic region in which the capability statement is intended to be used.
Explanation of why this capability statement is needed and why it has been designed as it has.
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.
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).
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.
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.
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.
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.
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.
A list of the formats supported by this implementation using their content types.
A list of the patch formats supported by this implementation using their content types.
A list of implementation guides that the server does (or should) support in their entirety.
A definition of the restful capabilities of the solution, if any.
A description of the messaging capabilities of the solution.
A document 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.
Name the software is known by.
The version identifier for the software covered by this statement.
Date this version of the software was released.
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.
Information about the specific installation that this capability statement relates to.
An absolute base URL for the implementation. This forms the base for REST interfaces as well as the mailbox and document interfaces.
The organization responsible for the management of the instance and oversight of the data on the server at the specified URL.
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.
Identifies whether this portion of the statement is describing the ability to initiate or receive restful operations.
Information about the system's restful capabilities that apply across all applications, such as security.
Information about security implementation from an interface perspective - what a client needs to know.
A specification of the restful capabilities of the solution for a specific resource type.
A specification of restful operations supported by the system.
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.
Definition of an operation or a named query together with its parameters and their meaning and type.
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 .
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.
Server adds CORS headers when responding to requests - this enables Javascript applications to use the server.
Types of security services that are supported/required by the system.
General description of how security works.
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.
A type of resource exposed via the restful interface.
A specification of the profile that describes the solution's overall support for the resource, including any constraints on cardinality, bindings, lengths or other limitations. See further discussion in [Using Profiles](profiling.html#profile-uses).
A list of profiles that represent different use cases supported by the system. For a server, "supported by the system" means the system hosts/produces a set of resources that are conformant to a particular profile, and allows clients that use its services to search using this profile and to find appropriate data. For a client, it means the system will search by this profile and process data according to the guidance implicit in the profile. See further discussion in [Using Profiles](profiling.html#profile-uses).
Additional information about the resource type used by the system.
Identifies a restful operation supported by the solution.
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.
A flag for whether the server is able to return past versions as part of the vRead operation.
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.
A flag that indicates that the server supports conditional create.
A code that indicates how the server supports conditional read.
A flag that indicates that the server supports conditional update.
A code that indicates how the server supports conditional delete.
A set of flags that defines how references are supported.
A list of _include values supported by the server.
A list of _revinclude (reverse include) values supported by the server.
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.
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.
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.
Coded identifier of the operation, supported by the system resource.
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'.
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.
The name of the search parameter used in the interface.
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.
The type of value a search parameter refers to, and how the content is interpreted.
This allows documentation of any distinct behaviors about how the search parameter is used. For example, text matching algorithms.
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.
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.
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.
Documentation that describes anything special about the operation behavior, possibly detailing different behavior for system, type and instance-level invocation of the operation.
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.
A coded identifier of the operation, supported by the system.
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.
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.
An endpoint (network accessible address) to which messages and/or replies are to be sent.
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).
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.
References to message definitions for messages this system can send or receive.
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.
A list of the messaging transport protocol(s) identifiers, supported by this endpoint.
The network address of the endpoint. For solutions that do not use network addresses for routing, it can be just an identifier.
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.
The mode of this event declaration - whether application is sender or receiver.
Points to a message definition that identifies the messaging event, message structure, allowed responses, etc.
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.
Mode of this document declaration - whether an application is a producer or consumer.
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.
A profile on the document Bundle that constrains which resources are present, and their contents.
Instance
Capability
Requirements
How a capability statement is intended to be used.
If the element is present, it must have either a @value, an @id, or extensions
Sender
Receiver
The mode of a message capability statement.
If the element is present, it must have either a @value, an @id, or extensions
No VersionId Support
Versioned
VersionId tracked fully
How the system supports versioning for a resource.
If the element is present, it must have either a @value, an @id, or extensions
Producer
Consumer
Whether the application produces or consumes documents.
If the element is present, it must have either a @value, an @id, or extensions
Client
Server
The mode of a RESTful capability statement.
If the element is present, it must have either a @value, an @id, or extensions
read
vread
update
patch
delete
history-instance
history-type
create
search-type
Operations supported by REST at the type or instance level.
If the element is present, it must have either a @value, an @id, or extensions
transaction
batch
search-system
history-system
Operations supported by REST at the system level.
If the element is present, it must have either a @value, an @id, or extensions
Not Supported
If-Modified-Since
If-None-Match
Full Support
A code that indicates how the server supports conditional read.
If the element is present, it must have either a @value, an @id, or extensions
Literal References
Logical References
Resolves References
Reference Integrity Enforced
Local References Only
A set of flags that defines how references are supported.
If the element is present, it must have either a @value, an @id, or extensions
Not Supported
Single Deletes Supported
Multiple Deletes Supported
A code that indicates how the server supports conditional delete.
If the element is present, it must have either a @value, an @id, or extensions