Capability Statement

Overview
Using GET /metadata you can access FHIR capabilities 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
SearchParmeter
Entity
Aidbox CapabilityStatement updates automatically after meta resources change. No interaction needed to apply changes to CapabilityStatement.
Read more about conformance rules http://build.fhir.org/conformance-rules.html and the CapabilityStatement resource itself http://build.fhir.org/capabilitystatement.html.
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:
1
GET [base]/metadata{?mode=[mode]}{&_format=[mime-type]}
Copied!
You can get Capability Statement of your Aidbox with the command:
1
GET <server-domain>/fhir/metadata
Copied!
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)
A Capability Statement that specifies which resource types and interactions are supported
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.  
Configure CapabilityStatement
You can reconfigure specific parts of CapabilityStatement by creating AidboxConfig/box resource:
1
PUT /AidboxConfig/box
2
​
3
metadata:
4
  # override name and title of CapabilityStatement
5
  name: MyFHIRServer
6
  title: My FHIR server
7
  # override CapabilityStatement.rest.service
8
  service:
9
  - coding:
10
    - {system: 'http://hl7.org/fhir/restful-security-service', code: SMART-on-FHIR}
11
    text: Very smart!!!
12
  # override CapabilityStatement.rest.security
13
  security:
14
    extension:
15
    - url: http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris
16
      extension:
17
      - {url: token, valueUri: 'https://myserver.com/connect/token'}
18
      - {url: authorize, valueUri: 'https://myserver.com/connect/token'}
Copied!
If you want more control over CapabilityStatement, please contact us in the community chat!
To get metadata in the internal Aidbox format, use /$metadata?_format=yaml​
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.

API - Previous

FHIR API

$validate

Last modified 1mo ago

Copy link

Contents

Get Aidbox native metadata