Create

FHIR format
Aidbox format
FHIR format
POST [base]/fhir/[type]
Aidbox format
POST [base]/[type]

FHIR API ignores id in POST requests, but Aidbox API respects id inside the request body and creates a resource with a specific id. This decision was made because we didn't find any reasons to ignore it and to make Aidbox API be closer to the SQL INSERT query. As a result, a new response code 409 Conflict appeared.

Response code

Text

Description

201

Created

Resource successfully created

400

Bad Request

Resource could not be parsed or fail basic FHIR validation rules

409

Conflict

Resource with such id already exists

422

Unprocessable

The proposed resource violated applicable FHIR profiles or server business rules

Conditional create

FHIR format
Aidbox format
FHIR format
POST [base]/fhir/[type]?[search parameters]
Aidbox format
POST [base]/[type]?[search parameters]

Instead of using the If-None-Exist header, Aidbox uses query parameters as in ordinary read operation. This is done to make all conditional operations to look the same (use search query parameters).

  • No matches: The server performs a create interaction (Aidbox version of create)

  • One Match: The server returns the found resource and 200 OK

  • Multiple matches: The server returns a 412 Precondition Failed error indicating the client's criteria were not selective enough

create

FHIR format
Aidbox format
FHIR format
POST [base]/fhir/[type]
Aidbox format
POST [base]/[type]

This is one of the most basic interactions which gives an ability to create resources. It uses the POST HTTP method accepting a resource type via path parameters and the resource as a body of the request. A response to this interaction may be one of the following:

Response code

Text

Description

201

Created

Resource successfully created

400

Bad Request

Resource could not be parsed or fail basic FHIR validation rules

409

Conflict

Resource with such id already exists

422

Unprocessable

The proposed resource violated applicable FHIR profiles or server business rules

A successful response (2xx) also contains a created resource as a body and additional headers Location, ETag, Last-Modified which contain the full path to a resource (base url, resource type and id of a newly created resource), additionally information about version (vid) and modification time of that resource.

Location: [base]/[type]/[id]/_history/[vid]
ETag: [vid]
Last-Modified: [modification-datetime]

An unsuccessful response (4xx) contains OperationOutcome resource which describes issues the server faced during the creation of this resource.

201 Created

Request (FHIR format)
Request (Aidbox format)
Response (FHIR format)
Response (Aidbox format)
Request (FHIR format)
POST /fhir/Patient
name: [{given: ["Bob"]}]
Request (Aidbox format)
POST /Patient
name: [{given: ["Bob"]}]
Response (FHIR format)

Status: 201

name:
- given:
- Bob
id: '17b69d79-3d9b-45f8-af79-75f958502763'
resourceType: Patient
meta:
lastUpdated: '2018-11-29T10:44:10.588Z'
versionId: '13'
extension:
- url: 'ex:createdAt'
valueInstant: '2018-11-29T10:44:10.588Z'
Response (Aidbox format)

Status: 201

name:
- given: [Bob]
id: 17b69d79-3d9b-45f8-af79-75f958502763
resourceType: Patient
meta:
lastUpdated: '2018-11-29T10:44:10.588Z'
createdAt: '2018-11-29T10:44:10.588Z'
versionId: '13'

422 Unprocessable entity

Request (FHIR format)
Request (Aidbox format)
Response (FHIR format)
Response (Aidbox format)
Request (FHIR format)
POST /fhir/Patient
name: "Bob"
Request (Aidbox format)
POST /Patient
name: "Bob"
Response (FHIR format)

Status: 422

resourceType: OperationOutcome
text:
status: generated
div: Invalid resource
issue:
- severity: fatal
code: invalid
expression:
- Patient.name
diagnostics: expected array
Response (Aidbox format)
resourceType: OperationOutcome
text:
status: generated
div: Invalid resource
issue:
- severity: fatal
code: invalid
expression:
- Patient.name
diagnostics: expected array

Aidbox REST API doesn't ignoreid and treats it as all other attributes in contrast to FHIR API. Read more about differences here.

Conditional Create

FHIR format
Aidbox format
FHIR format
POST [base]/fhir/[type]?[search parameters]
Aidbox format
POST [base]/[type]?[search parameters]

A more complex way to create a resource (it requires the knowledge of search) but it gives some additional flexibility. If you provide search parameters, create becomes conditional create and works in the following way (depending on the number of search results):

  • No matches: The server performs a create interaction

  • One Match: The server returns the found resource and 200 OK

  • Multiple matches: The server returns a 412 Precondition Failed error indicating the client's criteria were not selective enough

200 OK

Create a patient if there is no patient with the name Bob.

Request
Response
Request
POST /Patient?name=Bob
name: [{given: ["Bob"]}]
gender: male
Response

Status: 200

name:
- given: [Bob]
id: 17b69d79-3d9b-45f8-af79-75f958502763
resourceType: Patient
meta:
lastUpdated: '2018-11-29T10:44:10.588Z'
versionId: '13'
tag:
- {system: 'https://aidbox.app', code: created}

A patient was not created, an existing patient was returned.