StyleGuide

Headers

Don't put . at the end of the header:

# good
Header
# bad
Header.

Abbreviations and product names

Keep original case of abbreviations:

# good
FHIR, API, JSON, SaaS
# bad
fhir, Api, json, saas

Use capitalized and consistent names for products:

# good
Aidbox, Aidbox.Dev, Aidbox.Cloud, Aidbox.One, Fhirbase
# bad
aidbox, devbox, cloud version of aidbox, enterprise aidbox, fhirebase

Requests

  • [ ] some name, which should be substituted with something meaningful

  • { } mean optional

get
Example request

[base]/[type]/[id]
Request
Response
Path Parameters
[base]
required
string
200: OK
Request
Response
POST /Patient
resourceType: Patient
name:
- given: [Max]
family: Turikov
gender: male
birthDate: '1990-10-10'
address:
- line:
- 123 Oxygen St
city: Hello
district: World
state: NY
postalCode: '3212'
telecom:
- use: home
- system: phone
value: "(32) 8934 1234"
use: work
rank: 1

200 OK inside text

  • 200 OK - as options for responses

'Button' names should be single-quoted.

Placeholders <YOUR-BOX> should be in SCREAMING-CAMEL-CASE.