openEHR ITEM TAG API

openapi: 3.2.0
info:
  title: Openehr ITEM TAG API
  contact:
    name: Specifications Editorial Committee openEHR
    url: https://specifications.openehr.org/
    email: info@openehr.org
  license:
    name: Creative Commons Attribution-NoDerivs 3.0 Unported
    url: https://creativecommons.org/licenses/by-nd/3.0/
  x-refined-note:
  - x-spec differs across the merged source definitions and was not carried
  - x-status differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged ITEM_TAG across 2 of this provider''s published API definitions: openehr-demographic-openapi.yml, openehr-ehr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{baseUrl}/v1
  description: An example openEHR server URL.
  variables:
    baseUrl:
      default: openEHRSys.example.com
      description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
security: []
tags:
- name: Item Tag
  description: Management of ITEM_TAG resources.
paths:
  /demographic/tags:
    get:
      operationId: demographic_tags_get
      summary: Get Demographic tags
      description: 'Retrieves the list of ITEM_TAG resources associated with any target VERSION or VERSIONED_PARTY within the Demographic space.


        This list can be filtered by the given one or more `tag_key`, `tag_value`, `tag_target_path` query parameters.

        In case no such parameter is provided then all ITEM_TAG resources will be retrieved.


        This will return an empty list when there is no matching ITEM_TAG associated with any target within given EHR.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/tag_key'
      - $ref: '#/components/parameters/tag_value'
      - $ref: '#/components/parameters/tag_target_path'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_PERSON_ItemTagList_retrieved'
        '400':
          $ref: '#/components/responses/400'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/agent/{uid_based_id}/tags:
    get:
      operationId: agent_tags_get
      summary: Get AGENT tags
      description: 'Retrieves the list of all ITEM_TAG resources associated with a given target AGENT version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to get the tags of a particular (target) version of the AGENT version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to get the tags of the target VERSIONED_PARTY container.


        This will return an empty list when there is no ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target AGENT or VERSIONED_PARTY, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_AGENT_ItemTagList_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    put:
      operationId: agent_tags_update
      summary: Update AGENT tags
      description: 'Updates the list of all ITEM_TAG resources associated with a given target AGENT version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).

        The former is used to update the tags of a particular AGENT version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to update the tags of the target VERSIONED_PARTY container.


        Providing an empty list will effectively remove all ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Prefer'
      - $ref: '#/components/parameters/Accept_canonical'
      - $ref: '#/components/parameters/ContentType_canonical'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateItemTag'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200_AGENT_ItemTagList_updated'
        '204':
          $ref: '#/components/responses/204_updated'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/agent/{uid_based_id}/tags/{key}:
    delete:
      operationId: agent_tags_delete
      summary: Delete AGENT tags
      description: 'Deletes the ITEM_TAG resource(s) identified by `tag_key`, associated with a given target AGENT version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to delete the tags a particular (target) version of the AGENT version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to delete the tags of the target VERSIONED_PARTY container.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/key'
      responses:
        '204':
          $ref: '#/components/responses/204_deleted'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id_or_key'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/group/{uid_based_id}/tags:
    get:
      operationId: group_tags_get
      summary: Get GROUP tags
      description: 'Retrieves the list of all ITEM_TAG resources associated with a given target GROUP version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to get the tags of a particular (target) version of the GROUP version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to get the tags of the target VERSIONED_PARTY container.


        This will return an empty list when there is no ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target GROUP or VERSIONED_PARTY, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_GROUP_ItemTagList_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    put:
      operationId: group_tags_update
      summary: Update GROUP tags
      description: 'Updates the list of all ITEM_TAG resources associated with a given target GROUP version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).

        The former is used to update the tags of a particular GROUP version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to update the tags of the target VERSIONED_PARTY container.


        Providing an empty list will effectively remove all ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Prefer'
      - $ref: '#/components/parameters/Accept_canonical'
      - $ref: '#/components/parameters/ContentType_canonical'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateItemTag'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200_GROUP_ItemTagList_updated'
        '204':
          $ref: '#/components/responses/204_updated'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/group/{uid_based_id}/tags/{key}:
    delete:
      operationId: group_tags_delete
      summary: Delete GROUP tags
      description: 'Deletes the ITEM_TAG resource(s) identified by `tag_key`, associated with a given target GROUP version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to delete the tags a particular (target) version of the GROUP version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to delete the tags of the target VERSIONED_PARTY container.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/key'
      responses:
        '204':
          $ref: '#/components/responses/204_deleted'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id_or_key'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/organisation/{uid_based_id}/tags:
    get:
      operationId: organisation_tags_get
      summary: Get ORGANISATION tags
      description: 'Retrieves the list of all ITEM_TAG resources associated with a given target ORGANISATION version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to get the tags of a particular (target) version of the ORGANISATION version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to get the tags of the target VERSIONED_PARTY container.


        This will return an empty list when there is no ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target ORGANISATION or VERSIONED_PARTY, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_ORGANISATION_ItemTagList_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    put:
      operationId: organisation_tags_update
      summary: Update ORGANISATION tags
      description: 'Updates the list of all ITEM_TAG resources associated with a given target ORGANISATION version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).

        The former is used to update the tags of a particular ORGANISATION version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to update the tags of the target VERSIONED_PARTY container.


        Providing an empty list will effectively remove all ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Prefer'
      - $ref: '#/components/parameters/Accept_canonical'
      - $ref: '#/components/parameters/ContentType_canonical'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateItemTag'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200_ORGANISATION_ItemTagList_updated'
        '204':
          $ref: '#/components/responses/204_updated'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/organisation/{uid_based_id}/tags/{key}:
    delete:
      operationId: organisation_tags_delete
      summary: Delete ORGANISATION tags
      description: 'Deletes the ITEM_TAG resource(s) identified by `tag_key`, associated with a given target ORGANISATION version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to delete the tags a particular (target) version of the ORGANISATION version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to delete the tags of the target VERSIONED_PARTY container.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/key'
      responses:
        '204':
          $ref: '#/components/responses/204_deleted'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id_or_key'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/person/{uid_based_id}/tags:
    get:
      operationId: person_tags_get
      summary: Get PERSON tags
      description: 'Retrieves the list of all ITEM_TAG resources associated with a given target PERSON version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to get the tags of a particular (target) version of the PERSON version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to get the tags of the target VERSIONED_PARTY container.


        This will return an empty list when there is no ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target PERSON or VERSIONED_PARTY, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_PERSON_ItemTagList_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    put:
      operationId: person_tags_update
      summary: Update PERSON tags
      description: 'Updates the list of all ITEM_TAG resources associated with a given target PERSON version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).

        The former is used to update the tags of a particular PERSON version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to update the tags of the target VERSIONED_PARTY container.


        Providing an empty list will effectively remove all ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Prefer'
      - $ref: '#/components/parameters/Accept_canonical'
      - $ref: '#/components/parameters/ContentType_canonical'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateItemTag'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200_PERSON_ItemTagList_updated'
        '204':
          $ref: '#/components/responses/204_updated'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/person/{uid_based_id}/tags/{key}:
    delete:
      operationId: person_tags_delete
      summary: Delete PERSON tags
      description: 'Deletes the ITEM_TAG resource(s) identified by `tag_key`, associated with a given target PERSON version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to delete the tags a particular (target) version of the PERSON version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to delete the tags of the target VERSIONED_PARTY container.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/key'
      responses:
        '204':
          $ref: '#/components/responses/204_deleted'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id_or_key'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/role/{uid_based_id}/tags:
    get:
      operationId: role_tags_get
      summary: Get ROLE tags
      description: 'Retrieves the list of all ITEM_TAG resources associated with a given target ROLE version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to get the tags of a particular (target) version of the ROLE version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to get the tags of the target VERSIONED_PARTY container.


        This will return an empty list when there is no ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target ROLE or VERSIONED_PARTY, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_ROLE_ItemTagList_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    put:
      operationId: role_tags_update
      summary: Update ROLE tags
      description: 'Updates the list of all ITEM_TAG resources associated with a given target ROLE version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).

        The former is used to update the tags of a particular ROLE version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to update the tags of the target VERSIONED_PARTY container.


        Providing an empty list will effectively remove all ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Prefer'
      - $ref: '#/components/parameters/Accept_canonical'
      - $ref: '#/components/parameters/ContentType_canonical'
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/UpdateItemTag'
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200_ROLE_ItemTagList_updated'
        '204':
          $ref: '#/components/responses/204_updated'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /demographic/role/{uid_based_id}/tags/{key}:
    delete:
      operationId: role_tags_delete
      summary: Delete ROLE tags
      description: 'Deletes the ITEM_TAG resource(s) identified by `tag_key`, associated with a given target ROLE version or VERSIONED_PARTY identified by `uid_based_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_PARTY.uid.value (i.e. a `versioned_object_uid`).

        The former is used to delete the tags a particular (target) version of the ROLE version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to delete the tags of the target VERSIONED_PARTY container.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/key'
      responses:
        '204':
          $ref: '#/components/responses/204_deleted'
        '404':
          $ref: '#/components/responses/404_unknown_uid_based_id_or_key'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /ehr/{ehr_id}/tags:
    get:
      operationId: ehr_tags_get
      summary: Get EHR tags
      description: 'Retrieves the list of ITEM_TAG resources associated with any target VERSION or

        VERSIONED_OBJECT within the EHR identified by `ehr_id`.


        This list can be filtered by the given one or more `tag_key`, `tag_value`, `tag_target_path` query parameters.

        In case no such parameter is provided then all ITEM_TAG resources will be retrieved.


        This will return an empty list when there is no matching ITEM_TAG associated with any target within given EHR.


        More than one ITEM_TAG may be associated with a single target, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/tag_key'
      - $ref: '#/components/parameters/tag_value'
      - $ref: '#/components/parameters/tag_target_path'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_COMPOSITION_ItemTagList_retrieved'
        '400':
          $ref: '#/components/responses/400'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id'
    servers:
    - url: https://{baseUrl}/v1
      description: An example openEHR server URL.
      variables:
        baseUrl:
          default: openEHRSys.example.com
          description: The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix.
  /ehr/{ehr_id}/composition/{uid_based_id}/tags:
    get:
      operationId: composition_tags_get
      summary: Get COMPOSITION tags
      description: 'Retrieves the list of all ITEM_TAG resources associated with a given target COMPOSITION version or

        VERSIONED_COMPOSITION identified by `uid_based_id` and owned by EHR identified by `ehr_id`.


        The `uid_based_id` can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`),

        or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).

        The former is used to get the tags of a particular (target) version of the COMPOSITION version (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1`),

        whereas the latter (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to get the tags of the target VERSIONED_COMPOSITION container.


        This will return an empty list when there is no ITEM_TAG associated with the given target.


        More than one ITEM_TAG may be associated with a single target COMPOSITION or VERSIONED_COMPOSITION, in which case they are uniquely identified

        by their `key` and `target_path` pair attributes.'
      tags:
      - Item Tag
      parameters:
      - $ref: '#/components/parameters/ehr_id'
      - $ref: '#/components/parameters/uid_based_id'
      - $ref: '#/components/parameters/Accept_canonical'
      responses:
        '200':
          $ref: '#/components/responses/200_COMPOSITION_ItemTagList_retrieved'
        '404':
          $ref: '#/components/responses/404_unknown_ehr_id_or_uid_based_id'
    put:
      operationId: composition_tags_update
      summary: Update COMPOSITION tags
      description: 'Updates the list of all ITEM_TAG resources associated with a given target COMPOSITION version or

        VERSIONED_COMPOSITION identified by `uid_based_id` and owned by EHR identified by `ehr_id`.


        The 

# --- truncated at 32 KB (59 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openehr/refs/heads/main/openapi/openehr-item-tag-api-openapi.yml