Skip to main content
API docs by Redocly

EHRbase Item Tag Experimental API (v1)

Download OpenAPI specification:Download

License: Apache 2.0

Experimental API for working with Item Tags

EHRbase Documentation

EHR_STATUS ITEM_TAGS

Get tags

Returns all tags for or filters based on the given ids and/or keys.

path Parameters
ehr_id
required
string($uuid)

Identifier of owner object, such as EHR.

versioned_object_uid
required
string($uuid|$version)

Identifier of target, which may be a VERSIONED_OBJECT or a VERSION.

query Parameters
ids
string($uuid)

Filter for tag Identifier.

keys
string($key)

Filter for tag keys.

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or Update tags

Bulk creation/update of tags. Tags without IDs are created, those with IDs are updated.

path Parameters
ehr_id
required
string($uuid)

Identifier of owner object, such as EHR.

versioned_object_uid
required
string($uuid|$version)

Identifier of target, which may be a VERSIONED_OBJECT or a VERSION.

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Prefer
string($prefer)
Enum: "return=minimal" "return=representation"

Preferred response type.

Request Body schema: application/json
required
Array
id
string <uuid>
target
string <uuid>
key
string
value
string
owner_id
string <uuid>
target_type
string
Enum: "EHR_STATUS" "COMPOSITION"
target_path
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes tags

Deletes all tags for matching the given uuid or ItemTag.id.

path Parameters
ehr_id
required
string($uuid)

Identifier of owner object, such as EHR.

versioned_object_uid
required
string($uuid|$version)

Identifier of target, which may be a VERSIONED_OBJECT or a VERSION.

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Request Body schema: application/json
required
One of
string <uuid>

List of ItemTag string($uuid) or entries to delete

Responses

Request samples

Content type
application/json
Example
"string"

COMPOSITION ITEM_TAG

Get tags

Returns all tags for or filters based on the given ids and/or keys.

path Parameters
ehr_id
required
string($uuid)

Identifier of owner object, such as EHR.

versioned_object_uid
required
string($uuid|$version)

Identifier of target, which may be a VERSIONED_OBJECT or a VERSION.

query Parameters
ids
string($uuid)

Filter for tag Identifier.

keys
string($key)

Filter for tag keys.

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create or Update tags

Bulk creation/update of tags. Tags without IDs are created, those with IDs are updated.

path Parameters
ehr_id
required
string($uuid)

Identifier of owner object, such as EHR.

versioned_object_uid
required
string($uuid|$version)

Identifier of target, which may be a VERSIONED_OBJECT or a VERSION.

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Prefer
string($prefer)
Enum: "return=minimal" "return=representation"

Preferred response type.

Request Body schema: application/json
required
Array
id
string <uuid>
target
string <uuid>
key
string
value
string
owner_id
string <uuid>
target_type
string
Enum: "EHR_STATUS" "COMPOSITION"
target_path
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Deletes tags

Deletes all tags for matching the given uuid or ItemTag.id.

path Parameters
ehr_id
required
string($uuid)

Identifier of owner object, such as EHR.

versioned_object_uid
required
string($uuid|$version)

Identifier of target, which may be a VERSIONED_OBJECT or a VERSION.

header Parameters
openEHR-VERSION
string
openEHR-AUDIT_DETAILS
string
Request Body schema: application/json
required
One of
string <uuid>

List of ItemTag string($uuid) or entries to delete

Responses

Request samples

Content type
application/json
Example
"string"