Aidbox
Aidbox.Dev
Aidbox.Cloud
Aidbox.One
Fhirbase
Search…
Getting started
Getting Started
Installation & Configuration
Features
Licensing and Support
Versioning & Release Notes
FAQ
Aidbox configuration
Aidbox project
API constructor (beta)
Setup SMTP provider
Zen Configuration
API
FHIR API
REST API
CRUD
Create
Read
Update
Patch
Delete
Aidbox version
Bulk API
Batch Upsert
Batch/Transaction
Cache
ETAG support
Reactive API
Sequence API
Encryption API
Compartments API
GraphQL API
RPC API
Aidbox UI
Profiling and validation
Profiling and validation overview
Profiling with zen-lang
Asynchronous resource validation
Profiling with AidboxProfile
Terminology
Aidbox terminology module overview
Import external (not-present) terminologies
Concept
CodeSystem
ValueSet
$translate on ConceptMap
Terminology Tutorials
FHIR Implementation Guides
🎓
HL7 FHIR Da Vinci PDex Plan Net IG
App development guides
Tutorials
Administration
Receive logs from your app
$matcho
$to-format
Security & Access Control
Overview
Authentication Flows
Access Control
Multitenancy
Storage
Archiving
Database
AWS S3
GCP Cloud Storage
Azure Blob Storage
Core Modules
Entities & Attributes
$json-schema
Monitoring
Logging & Audit
Modules
HL7 v2 Integration
FHIR Resources
Custom Resources
Aidbox Search
First-Class Extensions
Multibox
Multibox box manager API
Plan API
Plan API Overview
Patient Access API
Integrations
Analytics
Audit
Authentication
Tools
Mappings
Aidbox SDK
Contact us
Powered By
GitBook
Read
1
GET [base]/[type]/[id]
Copied!
One of the most basic interactions is used to obtain a resource by a given
id
. For more advanced options for getting resources, check out
Search
.
Response code
Text
Description
200
OK
Resource successfully found and returned
404
Not Found
Resource with a given
id
doesn't exist on the server
410
Gone
Resource was deleted
200
OK
Get an existing patient:
Request (FHIR)
Request (Aidbox)
Response (FHIR)
Response (Aidbox)
1
GET /fhir/Patient/17b69d79-3d9b-45f8-af79-75f958502763
Copied!
1
GET /Patient/17b69d79-3d9b-45f8-af79-75f958502763
Copied!
Status:
200
1
name
:
2
-
given
:
Bob
3
gender
:
male
4
id
:
17b69d79
-
3d9b
-
45f8
-
af79
-
75f958502763
5
resourceType
:
Patient
6
meta
:
7
lastUpdated
:
'2018-11-29T10:44:10.588Z'
8
versionId
:
'13'
9
extension
:
10
-
url
:
'ex:createdAt'
11
valueInstant
:
'2018-11-29T10:44:10.588Z'
Copied!
Status:
200
1
name
:
2
-
given
:
Bob
3
gender
:
male
4
id
:
17b69d79
-
3d9b
-
45f8
-
af79
-
75f958502763
5
resourceType
:
Patient
6
meta
:
7
lastUpdated
:
'2018-11-29T10:44:10.588Z'
8
createdAt
:
'2018-11-29T10:44:10.588Z'
9
versionId
:
'13'
Copied!
404
Not Found
Attempt to get a non-existing patient:
Request (FHIR)
Request (Aidbox)
Request (FHIR)
Response (Aidbox)
1
GET /fhir/Patient/some-not-existing-id
Copied!
1
GET /Patient/some-not-existing-id
Copied!
Status:
404
1
resourceType
:
OperationOutcome
2
id
:
'not-found'
3
text
:
4
status
:
generated
5
div
:
Resource Patient/some
-
not
-
existing
-
id not found
6
issue
:
7
-
severity
:
fatal
8
code
:
not
-
found
9
diagnostics
:
Resource Patient/some
-
not
-
existing
-
id not found
Copied!
Status:
404
1
resourceType
:
OperationOutcome
2
id
:
'not-found'
3
text
:
4
status
:
generated
5
div
:
Resource Patient/some
-
not
-
existing
-
id not found
6
issue
:
7
-
severity
:
fatal
8
code
:
not
-
found
9
diagnostics
:
Resource Patient/some
-
not
-
existing
-
id not found
Copied!
vread
1
GET [base]/[type]/[id]/_history/[vid]
Copied!
This one is another read interaction, but it returns a specific version resource. Similar to read, but it additionally requires to specify version id.
200
OK
Version id
13
was extracted from the response of a
create
interaction.
Request (FHIR)
Request (Aidbox)
Response (FHIR)
Response (Aidbox)
1
GET /fhir/Patient/17b69d79-3d9b-45f8-af79-75f958502763/_history/13
Copied!
1
GET /Patient/17b69d79-3d9b-45f8-af79-75f958502763/_history/13
Copied!
Status:
200
1
name
:
2
-
given
:
3
-
Bob
4
gender
:
male
5
id
:
'17b69d79-3d9b-45f8-af79-75f958502763'
6
resourceType
:
Patient
7
meta
:
8
lastUpdated
:
'2018-11-29T10:44:10.588Z'
9
versionId
:
'13'
10
extension
:
11
-
url
:
'ex:createdAt'
12
valueInstant
:
'2018-11-29T10:44:10.588Z'
Copied!
Status:
200
1
name
:
2
-
given
:
3
-
Bob
4
gender
:
male
5
id
:
'17b69d79-3d9b-45f8-af79-75f958502763'
6
resourceType
:
Patient
7
meta
:
8
lastUpdated
:
'2018-11-29T10:44:10.588Z'
9
createdAt
:
'2018-11-29T10:44:10.588ZZ'
10
versionId
:
'13'
Copied!
​
Previous
Create
Next
Update
Last modified
1yr ago
Copy link
Contents
200 OK
404 Not Found
vread
200 OK