Capability Statement
The CapabilityStatement resource is a statement of the kinds of resources and operations provided and/or consumed by an application.
Last updated
Was this helpful?
The CapabilityStatement resource is a statement of the kinds of resources and operations provided and/or consumed by an application.
Last updated
Was this helpful?
Using GET /metadata
you can access interaction.
Response is a CapabilityStatement
generated from meta resources created in an Aidbox instance. The list of this meta resource types used for the response generation:
Operation
SearchParameter
Entity
Read more about and the itself.
Base URL for FHIR compatible API is <server-domain>/fhir/
.
The capabilities
interaction returns a capability statement describing the server's current operational functionality. The interaction is performed by the HTTP GET
command as shown:
You can get of your Aidbox with the command:
GET
<your-domain>/fhir/metadata
mode
string
full | normative | terminology
_format
string
json | yaml | edn
The information returned depends on the value of the mode
parameter:
Value
Description
full
(or mode not present)
normative
As above, but only the normative portions of the Capability Statement
terminology
Servers MAY ignore the mode parameter and return a CapabilityStatement resource.
You can reconfigure specific parts of CapabilityStatement by creating AidboxConfig/box
resource:
The profile property is set when zen profiling is enabled and the following conditions are met:
the corresponding resource is defined in zen profile
there is exactly one zen schema tagged with base-profile
for the corresponding resource
GET
<your-domain>/$metadata
_format
string
yaml | json | edn
path
string
Path to specific part of metadata (for example Entity.Patient)
A that specifies which resource types and interactions are supported
A resource that provides further information about terminologies are supported by the server
To get metadata in the internal Aidbox format, use
Capability statements can become quite large; servers are encouraged to support the and parameters on the capabilities interaction, though this is not required. In addition, servers are encouraged to implement the and operations to make it easy for a client to check conformance.