Capability Statement
This page provides a set of capabilities (behaviors) of a FHIR Server or Client for a particular version of FHIR that may be used as a statement of actual server functionality as stated below:
- resources (e.g. Patient) supported
- search parameters supported by each resource
- operations (aka API) supported by system
REST Capabilities Server
| Mode | Server |
|---|---|
| Documentation | All the functionality defined in FHIR |
| Transaction | Supported Implemented per the specification (or Insert other doco here) |
| Batch | Supported Implemented per the specification (or Insert other doco here) |
| History-system | Supported Implemented per the specification (or Insert other doco here) |
| Search-system | Supported Implemented per the specification (or Insert other doco here) |
Security
| Cors | True |
|---|---|
| Service | See http://docs.smarthealthit.org/ |
| Description | This is the Capability Statement to declare that the server supports SMART-on-FHIR. See the SMART-on-FHIR docs for the extension that would go with such a server |
Resource Interactions
| Resource Type | Profile | Supported Profiles | Read | Vread | Update | Delete | HistoryInstance | HistoryType | Create | SearchType | ConditionalCreate | ConditionalUpdate | ConditionalDelete |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| DocumentReference | DocumentReference | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Multiple | |
| Composition | Composition | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Multiple | |
| Binary | Binary | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | Multiple |
Global Search Parameters
| Name | Type | Documentation | Level |
|---|---|---|---|
| _text | special | Search on the narrative of the resource | Supported |
| _id | string | some doco | Supported |
| _list | token | Retrieval of resources that are referenced by a List resource | Supported |
| _has | composite | Provides support for reverse chaining | Supported |
| _type | token | Type of resource (when doing cross-resource search | Supported |
| _sort | token | How to sort the resources when returning | Supported |
| _count | number | How many resources to return | Supported |
| _include | token | Control over returning additional resources (see spec) | Supported |
| _revinclude | token | Control over returning additional resources (see spec) | Supported |
| _summary | token | What kind of information to return | Supported |
| _elements | string | What kind of information to return | Supported |
| _contained | token | Managing search into contained resources | Supported |
| _containedType | token | Managing search into contained resources | Supported |
| _language | token | Language of the resource content | Supported |
| _query | special | A custom search profile that describes a specific defined query operation | Supported |
| _in | reference | Allows for the retrieval of resources that are active members of a CareTeam, Group, or List | Supported |
| _lastUpdated | date | When the resource version last changed | Supported |
| _security | token | Security Labels applied to this resource | Supported |
| _filter | special | Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details | Supported |
| _profile | reference | Profiles this resource claims to conform to | Supported |
| _tag | token | Tags applied to this resource | Supported |
| _source | uri | Identifies where the resource comes from | Supported |
| _content | special | Search on the entire content of the resource | Supported |
Operations per resource type
DocumentReference
| Operation | Reference | Level |
|---|---|---|
| get-document-list | GetDocumentList | Supported |
Composition
No operations are stated for this resource type
Binary
No operations are stated for this resource type