Skip to main content

EHRbase API (v1)

Download OpenAPI specification:Download

License: Apache 2.0

EHRbase implements the official openEHR REST API. Additionally, EHRbase provides a custom status heartbeat endpoint, an Admin API (if activated) and a Status and Metrics API (if activated) for monitoring and maintenance. Note: The openEHR REST API is documented in their official documentation, not here. Please refer to their separate documentation.

EHR

Get EHR by id

path Parameters
ehr_id
required
string

Responses

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Create EHR with id

path Parameters
ehr_id
required
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Prefer
string
Request Body schema: application/json
Array
object (HierObjectId)
object (HierObjectId)
object (EHR_STATUS)
object (DvDateTime)
Array of objects (CompositionDto)
Array of objects (ContributionDto)

Responses

Request samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Get EHR summary by subject id and namespace

query Parameters
subject_id
required
string
subject_namespace
required
string

Responses

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Create EHR

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Prefer
string
Default: return=minimal
Request Body schema: application/json
Array
object (HierObjectId)
object (HierObjectId)
object (EHR_STATUS)
object (DvDateTime)
Array of objects (CompositionDto)
Array of objects (ContributionDto)

Responses

Request samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

EHR_STATUS

Get EHR_STATUS version by time

path Parameters
ehr_id
required
string <uuid>
query Parameters
version_at_time
string

Responses

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Update EHR_STATUS

path Parameters
ehr_id
required
string <uuid>
header Parameters
If-Match
required
string
Prefer
string
Request Body schema: application/json
required
Array
object (UIDBasedId)
archetype_node_id
required
string
object (DvText)
object (Archetyped)
object (FeederAudit)
object (PartySelf)
is_queryable
boolean
is_modifiable
boolean
object (ItemStructure)
_type
required
string

Responses

Request samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

Get EHR_STATUS by version id

path Parameters
ehr_id
required
string <uuid>
version_uid
required
string

Responses

Response samples

Content type
application/json
{
  • "archetype_node_id": "openEHR-EHR-EHR_STATUS.generic.v1",
  • "name": {
    },
  • "uid": {
    },
  • "subject": {
    },
  • "is_queryable": true,
  • "is_modifiable": true
}

DIRECTORY

Get folder in directory version at time

path Parameters
ehr_id
required
string <uuid>
query Parameters
version_at_time
string
path
string
header Parameters
Accept
string
Default: application/json

Responses

Update directory

path Parameters
ehr_id
required
string <uuid>
header Parameters
required
object (ObjectVersionId)
Content-Type
required
string
Accept
string
Default: application/json
Prefer
string
Default: return=minimal
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Request Body schema: application/json
required
object (DvText)
archetypeNodeId
string
object (UIDBasedId)
object (Archetyped)
object (FeederAudit)
Array of objects (Link)
Array of objects (ObjectRefObjectId)
folders
Array of objects (Folder)
object (ItemStructure)
path
string

Responses

Request samples

Content type
application/json
{
  • "name": {
    },
  • "archetypeNodeId": "string",
  • "uid": {
    },
  • "archetypeDetails": {
    },
  • "feederAudit": {
    },
  • "links": [
    ],
  • "items": [
    ],
  • "folders": [
    ],
  • "details": {
    },
  • "path": "string"
}

Create directory

path Parameters
ehr_id
required
string <uuid>
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Content-Type
required
string
Accept
string
Default: application/json
Prefer
string
Default: return=minimal
Request Body schema: application/json
required
object (DvText)
archetypeNodeId
string
object (UIDBasedId)
object (Archetyped)
object (FeederAudit)
Array of objects (Link)
Array of objects (ObjectRefObjectId)
folders
Array of objects (Folder)
object (ItemStructure)
path
string

Responses

Request samples

Content type
application/json
{
  • "name": {
    },
  • "archetypeNodeId": "string",
  • "uid": {
    },
  • "archetypeDetails": {
    },
  • "feederAudit": {
    },
  • "links": [
    ],
  • "items": [
    ],
  • "folders": [
    ],
  • "details": {
    },
  • "path": "string"
}

Delete directory

path Parameters
ehr_id
required
string <uuid>
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Accept
string
Default: application/json
required
object (ObjectVersionId)

Responses

Get folder in directory version

path Parameters
ehr_id
required
string <uuid>
required
object (ObjectVersionId)
query Parameters
path
string
header Parameters
Accept
string
Default: application/json

Responses

COMPOSITION

Get composition at time

path Parameters
ehr_id
required
string
versioned_object_uid
required
string
query Parameters
format
string
Enum: "JSON" "XML" "STRUCTURED" "FLAT"

Composition format

version_at_time
string
header Parameters
Accept
string

Responses

Response samples

Content type
{ }

Update composition

path Parameters
ehr_id
required
string
versioned_object_uid
required
string
query Parameters
openehrVersion
required
string
templateId
string
format
string
Enum: "JSON" "XML" "STRUCTURED" "FLAT"

Composition format

header Parameters
openEHR-AUDIT_DETAILS
string
Content-Type
string
Accept
string
Prefer
string
If-Match
required
string
Request Body schema:
required
string

Responses

Request samples

Content type
"string"

Response samples

Content type
"string"

Create composition

path Parameters
ehr_id
required
string
query Parameters
templateId
string
format
string
Enum: "JSON" "XML" "STRUCTURED" "FLAT"

Composition format

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Content-Type
required
string
Accept
string
Prefer
string
Request Body schema:
required
string

Responses

Request samples

Content type
"string"

Response samples

Content type
"string"

Delete composition

path Parameters
ehr_id
required
string
preceding_version_uid
required
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string

Responses

Response samples

Content type
{ }

STORED_QUERY

Get stored query and info/metadata

path Parameters
qualified_query_name
required
string
version
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "q": "string",
  • "name": "string",
  • "type": "string",
  • "version": "string",
  • "saved": "string"
}

Store a query

Content type application/json is still supported but it's deprecated, please use text/plain instead.

path Parameters
qualified_query_name
required
string
version
required
string
query Parameters
type
string
Default: "AQL"
header Parameters
Content-Type
string
Accept
string
Request Body schema:
required
string

Responses

Request samples

Content type
No sample

Response samples

Content type
{
  • "q": "string",
  • "name": "string",
  • "type": "string",
  • "version": "string",
  • "saved": "string"
}

List stored queries

path Parameters
qualified_query_name
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "versions": [
    ]
}

Store a query

Content type application/json is still supported but it's deprecated, please use text/plain instead.

path Parameters
qualified_query_name
required
string
query Parameters
type
string
Default: "AQL"
header Parameters
Content-Type
string
Accept
string
Request Body schema:
required
string

Responses

Request samples

Content type
No sample

Response samples

Content type
{
  • "q": "string",
  • "name": "string",
  • "type": "string",
  • "version": "string",
  • "saved": "string"
}

Response samples

Content type
{
  • "versions": [
    ]
}

QUERY

Execute stored query

path Parameters
qualified_query_name
required
string
version
required
string
query Parameters
offset
integer <int32>
fetch
integer <int32>
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "q": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Execute stored query

path Parameters
qualified_query_name
required
string
version
required
string
header Parameters
Accept
string
Content-Type
required
string
Request Body schema:
property name*
additional property
object

Responses

Request samples

Content type
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
{
  • "meta": {
    },
  • "q": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Execute stored query

path Parameters
qualified_query_name
required
string
query Parameters
offset
integer <int32>
fetch
integer <int32>
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "q": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Execute stored query

path Parameters
qualified_query_name
required
string
header Parameters
Accept
string
Content-Type
required
string
Request Body schema:
property name*
additional property
object

Responses

Request samples

Content type
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
{
  • "meta": {
    },
  • "q": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Execute ad-hoc (non-stored) AQL query

query Parameters
q
required
string
offset
integer <int32>
fetch
integer <int32>
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "meta": {
    },
  • "q": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

Execute ad-hoc (non-stored) AQL query

header Parameters
Accept
string
Content-Type
required
string
Request Body schema:
required
property name*
additional property
object

Responses

Request samples

Content type
{
  • "property1": { },
  • "property2": { }
}

Response samples

Content type
{
  • "meta": {
    },
  • "q": "string",
  • "name": "string",
  • "columns": [
    ],
  • "rows": [
    ]
}

CONTRIBUTION

Create contribution

path Parameters
ehr_id
required
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Content-Type
required
string
Accept
string
Prefer
string
Request Body schema:
required
string

Responses

Request samples

Content type
No sample

Response samples

Content type
{ }

Get contribution by id

path Parameters
ehr_id
required
string
contribution_uid
required
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Accept
string

Responses

Response samples

Content type
{ }

ADL 2 TEMPLATE

List templates

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Accept
string

Responses

Response samples

Content type
application/json
{ }

Upload a template

query Parameters
version
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Content-Type
string
Accept
string
Prefer
string
Request Body schema: text/plain
required
string

Responses

Get template

path Parameters
template_id
required
string
version_pattern
required
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Accept
string

Responses

ADL 1.4 TEMPLATE

List templates

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Accept
string

Responses

Response samples

Content type
[
  • {
    }
]

Upload a template

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Prefer
string
Request Body schema: application/xml
required
string

Responses

Get template

path Parameters
template_id
required
string
header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Accept
string

Responses

Response samples

Content type
No sample

Get an example composition for the specified template

path Parameters
template_id
required
string
query Parameters
format
string
Enum: "JSON" "XML" "STRUCTURED" "FLAT"

Composition format

header Parameters
Accept
string

Responses

Response samples

Content type
"string"

VERSIONED_EHR_STATUS

Get versioned EHR_STATUS

path Parameters
ehr_id
required
string

Responses

Response samples

Content type
{
  • "uid": {
    },
  • "owner_id": {
    },
  • "time_created": "string",
  • "_type": "string"
}

Get versioned EHR_STATUS version by time

path Parameters
ehr_id
required
string
query Parameters
version_at_time
string

Responses

Response samples

Content type
{
  • "contribution": {
    },
  • "signature": "string",
  • "attestations": [
    ],
  • "data": {
    },
  • "_type": "string",
  • "uid": {
    },
  • "commit_audit": {
    },
  • "preceding_version_uid": {
    },
  • "other_input_version_uids": [
    ],
  • "lifecycle_state": {
    }
}

Get versioned EHR_STATUS version by id

path Parameters
ehr_id
required
string
version_uid
required
string

Responses

Response samples

Content type
{
  • "contribution": {
    },
  • "signature": "string",
  • "attestations": [
    ],
  • "data": {
    },
  • "_type": "string",
  • "uid": {
    },
  • "commit_audit": {
    },
  • "preceding_version_uid": {
    },
  • "other_input_version_uids": [
    ],
  • "lifecycle_state": {
    }
}

Get versioned EHR_STATUS revision history

path Parameters
ehr_id
required
string

Responses

Response samples

Content type
[
  • {
    }
]

VERSIONED_COMPOSITION

Get versioned composition

path Parameters
ehr_id
required
string
versioned_object_uid
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "uid": {
    },
  • "owner_id": {
    },
  • "time_created": "string",
  • "_type": "string"
}

Get versioned composition version at time

path Parameters
ehr_id
required
string
versioned_object_uid
required
string
query Parameters
version_at_time
string
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "contribution": {
    },
  • "signature": "string",
  • "attestations": [
    ],
  • "data": {
    },
  • "_type": "string",
  • "uid": {
    },
  • "commit_audit": {
    },
  • "preceding_version_uid": {
    },
  • "other_input_version_uids": [
    ],
  • "lifecycle_state": {
    }
}

Get versioned composition version by id

path Parameters
ehr_id
required
string
versioned_object_uid
required
string
version_uid
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "contribution": {
    },
  • "signature": "string",
  • "attestations": [
    ],
  • "data": {
    },
  • "_type": "string",
  • "uid": {
    },
  • "commit_audit": {
    },
  • "preceding_version_uid": {
    },
  • "other_input_version_uids": [
    ],
  • "lifecycle_state": {
    }
}

Get versioned composition revision history

path Parameters
ehr_id
required
string
versioned_object_uid
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
[
  • {
    }
]

TEMPLATE

Deprecated since 2.2.0 and marked for removal Deprecated

path Parameters
template_id
required
string
header Parameters
Accept
string

Responses

Response samples

Content type
{
  • "templateId": "string",
  • "version": "string",
  • "defaultLanguage": "string",
  • "languages": [
    ],
  • "tree": {
    }
}