CRUD

Common operations create, read, update, and delete.

This part of documentation describes how to create, read, update, and delete resources. Also, it covers some advanced topics like conditional create, update, and delete. Aidbox REST API slightly differs from canonical FHIR REST API. There is the article which describes those differences.

All sample requests can be run from the Postman collection:Run in Postman

Introduction

A resource is an object with a type, associated data, relationships to other resources, and a set of methods that operate on it (information about it can be found in FHIR specification or through Aidbox metadata). In most cases a resource represented as a JSON/XML/YAML document.

Each resource has its own resource type, this type defines a set of data which can be stored with this resource, and possible relationships with other resources.

Attribute is a part of the resource definition which describes what fields can or must be present in the resource document, type of such fields, and their cardinality.

Every resource type has the same set of interactions available. These interactions are described below.

Each interaction can fail with:

  • 403 Forbidden — client is not authorized to perform the interaction