Capability Statement
The CapabilityStatement resource is a statement of the kinds of resources and operations provided and/or consumed by an application.
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
Aidbox
CapabilityStatement
updates automatically after meta resources change. No interaction needed to apply changes to CapabilityStatement
.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:GET [base]/metadata{?mode=[mode]}{&_format=[mime-type]}
GET <server-domain>/fhir/metadata
get
<your-domain>/fhir/metadata
Get metadata
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 | A TerminologyCapabilities resource that provides further information about terminologies are supported by the server |
Servers MAY ignore the mode parameter and return a CapabilityStatement resource.
You can reconfigure specific parts of CapabilityStatement by creating
AidboxConfig/box
resource:PUT /AidboxConfig/box
metadata:
# override name and title of CapabilityStatement
name: MyFHIRServer
title: My FHIR server
description: Description of my FHIR server
# override CapabilityStatement.rest.service
service:
- coding:
- {system: 'http://hl7.org/fhir/restful-security-service', code: SMART-on-FHIR}
text: Very smart!!!
# override CapabilityStatement.rest.security
security:
extension:
- url: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
extension:
- {url: token, valueUri: 'https://myserver.com/connect/token'}
- {url: authorize, valueUri: 'https://myserver.com/connect/token'}
If you want more control over CapabilityStatement, please contact us in the community chat!
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
Get Aidbox native metadata
Capability statements can become quite large; servers are encouraged to support the
_summary
and _elements
parameters on the capabilities interaction, though this is not required. In addition, servers are encouraged to implement the $subset and $implements operations to make it easy for a client to check conformance.Last modified 9mo ago