{ "openapi": "3.1.1", "info": { "title": "Demographic API", "version": "development", "x-status": "DEVELOPMENT", "x-spec": "demographic" }, "servers": [ { "url": "https://{baseUrl}/v1", "description": "An example openEHR server URL.", "variables": { "baseUrl": { "default": "cataniamc.prod.cadasto.com", "description": "The (example) server base URL prefix providing openEHR services. This may contain server name, port and base path prefix." } } } ], "security": [], "tags": [ { "name": "AGENT", "description": "Management of the [AGENT](https://specifications.openehr.org/releases/RM/latest/demographic.html#_agent_class) class.\n" }, { "name": "GROUP", "description": "Management of the [GROUP](https://specifications.openehr.org/releases/RM/latest/demographic.html#_group_class) class.\n" }, { "name": "ORGANISATION", "description": "Management of the [ORGANISATION](https://specifications.openehr.org/releases/RM/latest/demographic.html#_organisation_class) class.\n" }, { "name": "PERSON", "description": "Management of the [PERSON](https://specifications.openehr.org/releases/RM/latest/demographic.html#_person_class) class.\n" }, { "name": "ROLE", "description": "Management of the [ROLE](https://specifications.openehr.org/releases/RM/latest/demographic.html#_role_class) class.\n" }, { "name": "VERSIONED_PARTY", "description": "Management of the [VERSIONED_PARTY](https://specifications.openehr.org/releases/RM/latest/demographic.html#_versioned_party_class) class.\n" }, { "name": "CONTRIBUTION", "description": "Management of [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.html#_contribution_class) class.\n" }, { "name": "ITEM_TAG", "description": "Management of [ITEM_TAG](https://specifications.openehr.org/releases/RM/latest/common.html#_item_tag_class) resources attached to demographic versioned objects (PERSON, AGENT, GROUP, ORGANISATION, ROLE). See also the [ITEM_TAG guide](/docs/guides/item-tag).\n" }, { "name": "CAPABILITY_schema", "x-displayName": "CAPABILITY", "description": "The `CAPABILITY` schema, formally specified in the Reference Model as the [CAPABILITY](https://specifications.openehr.org/releases/RM/latest/demographic.html#_capability_class) class.\n" }, { "name": "CONTACT_schema", "x-displayName": "CONTACT", "description": "The `CONTACT` schema, formally specified in the Reference Model as the [CONTACT](https://specifications.openehr.org/releases/RM/latest/demographic.html#_contact_class) class.\n" }, { "name": "PARTY_IDENTITY_schema", "x-displayName": "PARTY_IDENTITY", "description": "The `PARTY_IDENTITY` schema, formally specified in the Reference Model as the [PARTY_IDENTITY](https://specifications.openehr.org/releases/RM/latest/demographic.html#_party_identity_class) class.\n" }, { "name": "PARTY_RELATIONSHIP_schema", "x-displayName": "PARTY_RELATIONSHIP", "description": "The `PARTY_RELATIONSHIP` resource, formally specified in the Reference Model as the [PARTY_RELATIONSHIP](https://specifications.openehr.org/releases/RM/latest/demographic.html#_party_relationship_class) class.\n" }, { "name": "ITEM_schema", "x-displayName": "ITEM", "description": "The abstract `ITEM` class.\n" }, { "name": "ITEM_STRUCTURE_schema", "x-displayName": "ITEM_STRUCTURE", "description": "The abstract `ITEM_STRUCTURE` class.\n" } ], "paths": { "/demographic/agent": { "post": { "operationId": "agent_create", "summary": "Create AGENT", "description": "Creates the first version of a new AGENT.\n", "tags": [ "AGENT" ], "parameters": [ { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The AGENT.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/201_AGENT" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } } } }, "/demographic/agent/{uid_based_id}": { "get": { "operationId": "agent_get", "summary": "Get AGENT", "description": "Retrieves a version of the AGENT identified by `uid_based_id`.\n\nThe `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`).\nThe former is used to retrieve a specific known version of the AGENT (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1`), whereas the later (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to retrieve a version from the version container whenever the _version_tree_id_ is unknown or irrelevant (such as when most recent version is requested).\n\nWhen the `uid_based_id` has the form of a HIER_OBJECT_ID, if the `version_at_time` is supplied, retrieves the version extant _at specified time_, otherwise retrieves the _latest_ AGENT version.\n\nSee [Resource identification](overview.html#tag/Resources/Resource-identification) for more details about the identifiers usage and meaning.\n", "tags": [ "AGENT" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id" }, { "$ref": "#/components/parameters/version_at_time" }, { "$ref": "#/components/parameters/Prefer" } ], "responses": { "200": { "$ref": "#/components/responses/200_AGENT_retrieved" }, "204": { "$ref": "#/components/responses/204_deleted_at_time" }, "404": { "$ref": "#/components/responses/404_not_found_or_no_version_at_time" } } }, "put": { "operationId": "agent_update", "summary": "Update AGENT", "description": "Updates AGENT identified by `uid_based_id`.\n\nThe `uid_based_id` can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n\nIf the request body already contains a AGENT.uid.value, it must match the `uid_based_id` in the URL. \n\nThe existing latest `version_uid` of AGENT resource (i.e. the `preceding_version_uid`) must be specified in the `If-Match` header.\n", "tags": [ "AGENT" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_versioned_object_uid" }, { "$ref": "#/components/parameters/If-Match" }, { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The new AGENT.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/200_AGENT_updated" }, "204": { "$ref": "#/components/responses/204_version_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "412": { "$ref": "#/components/responses/412_AGENT" }, "422": { "$ref": "#/components/responses/422" } } }, "delete": { "operationId": "agent_delete", "summary": "Delete AGENT", "description": "Deletes the AGENT identified by `uid_based_id`.\n\nThe `uid_based_id` MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the `preceding_version_uid` to be deleted.\n", "tags": [ "AGENT" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_version_uid" } ], "responses": { "204": { "$ref": "#/components/responses/204_version_deleted" }, "400": { "$ref": "#/components/responses/400_already_deleted" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409_AGENT_with_uid_based_id" } } } }, "/demographic/group": { "post": { "operationId": "group_create", "summary": "Create GROUP", "description": "Creates the first version of a new GROUP.\n", "tags": [ "GROUP" ], "parameters": [ { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The GROUP.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/201_GROUP" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } } } }, "/demographic/group/{uid_based_id}": { "get": { "operationId": "group_get", "summary": "Get GROUP", "description": "Retrieves a version of the GROUP identified by `uid_based_id`.\n\nThe `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`).\nThe former is used to retrieve a specific known version of the GROUP (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1`), whereas the later (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to retrieve a version from the version container whenever the _version_tree_id_ is unknown or irrelevant (such as when most recent version is requested).\n\nWhen the `uid_based_id` has the form of a HIER_OBJECT_ID, if the `version_at_time` is supplied, retrieves the version extant _at specified time_, otherwise retrieves the _latest_ GROUP version.\n\nSee [Resource identification](overview.html#tag/Resources/Resource-identification) for more details about the identifiers usage and meaning.\n", "tags": [ "GROUP" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id" }, { "$ref": "#/components/parameters/version_at_time" }, { "$ref": "#/components/parameters/Prefer" } ], "responses": { "200": { "$ref": "#/components/responses/200_GROUP_retrieved" }, "204": { "$ref": "#/components/responses/204_deleted_at_time" }, "404": { "$ref": "#/components/responses/404_not_found_or_no_version_at_time" } } }, "put": { "operationId": "group_update", "summary": "Update GROUP", "description": "Updates GROUP identified by `uid_based_id`.\n\nThe `uid_based_id` can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n\nIf the request body already contains a GROUP.uid.value, it must match the `uid_based_id` in the URL. \n\nThe existing latest `version_uid` of GROUP resource (i.e. the `preceding_version_uid`) must be specified in the `If-Match` header.\n", "tags": [ "GROUP" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_versioned_object_uid" }, { "$ref": "#/components/parameters/If-Match" }, { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The new GROUP.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/200_GROUP_updated" }, "204": { "$ref": "#/components/responses/204_version_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "412": { "$ref": "#/components/responses/412_GROUP" }, "422": { "$ref": "#/components/responses/422" } } }, "delete": { "operationId": "group_delete", "summary": "Delete GROUP", "description": "Deletes the GROUP identified by `uid_based_id`.\n\nThe `uid_based_id` MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the `preceding_version_uid` to be deleted.\n", "tags": [ "GROUP" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_version_uid" } ], "responses": { "204": { "$ref": "#/components/responses/204_version_deleted" }, "400": { "$ref": "#/components/responses/400_already_deleted" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409_GROUP_with_uid_based_id" } } } }, "/demographic/organisation": { "post": { "operationId": "organisation_create", "summary": "Create ORGANISATION", "description": "Creates the first version of a new ORGANISATION.\n", "tags": [ "ORGANISATION" ], "parameters": [ { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The ORGANISATION.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organisation" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/201_ORGANISATION" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } } } }, "/demographic/organisation/{uid_based_id}": { "get": { "operationId": "organisation_get", "summary": "Get ORGANISATION", "description": "Retrieves a version of the ORGANISATION identified by `uid_based_id`.\n\nThe `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`).\nThe former is used to retrieve a specific known version of the ORGANISATION (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1`), whereas the later (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to retrieve a version from the version container whenever the _version_tree_id_ is unknown or irrelevant (such as when most recent version is requested).\n\nWhen the `uid_based_id` has the form of a HIER_OBJECT_ID, if the `version_at_time` is supplied, retrieves the version extant _at specified time_, otherwise retrieves the _latest_ ORGANISATION version.\n\nSee [Resource identification](overview.html#tag/Resources/Resource-identification) for more details about the identifiers usage and meaning.\n", "tags": [ "ORGANISATION" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id" }, { "$ref": "#/components/parameters/version_at_time" }, { "$ref": "#/components/parameters/Prefer" } ], "responses": { "200": { "$ref": "#/components/responses/200_ORGANISATION_retrieved" }, "204": { "$ref": "#/components/responses/204_deleted_at_time" }, "404": { "$ref": "#/components/responses/404_not_found_or_no_version_at_time" } } }, "put": { "operationId": "organisation_update", "summary": "Update ORGANISATION", "description": "Updates ORGANISATION identified by `uid_based_id`.\n\nThe `uid_based_id` can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n\nIf the request body already contains a ORGANISATION.uid.value, it must match the `uid_based_id` in the URL. \n\nThe existing latest `version_uid` of ORGANISATION resource (i.e. the `preceding_version_uid`) must be specified in the `If-Match` header.\n", "tags": [ "ORGANISATION" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_versioned_object_uid" }, { "$ref": "#/components/parameters/If-Match" }, { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The new ORGANISATION.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organisation" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/200_ORGANISATION_updated" }, "204": { "$ref": "#/components/responses/204_version_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "412": { "$ref": "#/components/responses/412_ORGANISATION" }, "422": { "$ref": "#/components/responses/422" } } }, "delete": { "operationId": "organisation_delete", "summary": "Delete ORGANISATION", "description": "Deletes the ORGANISATION identified by `uid_based_id`.\n\nThe `uid_based_id` MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the `preceding_version_uid` to be deleted.\n", "tags": [ "ORGANISATION" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_version_uid" } ], "responses": { "204": { "$ref": "#/components/responses/204_version_deleted" }, "400": { "$ref": "#/components/responses/400_already_deleted" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409_ORGANISATION_with_uid_based_id" } } } }, "/demographic/person": { "post": { "operationId": "person_create", "summary": "Create PERSON", "description": "Creates the first version of a new PERSON.\n", "tags": [ "PERSON" ], "parameters": [ { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The PERSON.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/201_PERSON" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } } } }, "/demographic/person/{uid_based_id}": { "get": { "operationId": "person_get", "summary": "Get PERSON", "description": "Retrieves a version of the PERSON identified by `uid_based_id`.\n\nThe `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`).\nThe former is used to retrieve a specific known version of the PERSON (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1`), whereas the later (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to retrieve a version from the version container whenever the _version_tree_id_ is unknown or irrelevant (such as when most recent version is requested).\n\nWhen the `uid_based_id` has the form of a HIER_OBJECT_ID, if the `version_at_time` is supplied, retrieves the version extant _at specified time_, otherwise retrieves the _latest_ PERSON version.\n\nSee [Resource identification](overview.html#tag/Resources/Resource-identification) for more details about the identifiers usage and meaning.\n", "tags": [ "PERSON" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id" }, { "$ref": "#/components/parameters/version_at_time" }, { "$ref": "#/components/parameters/Prefer" } ], "responses": { "200": { "$ref": "#/components/responses/200_PERSON_retrieved" }, "204": { "$ref": "#/components/responses/204_deleted_at_time" }, "404": { "$ref": "#/components/responses/404_not_found_or_no_version_at_time" } } }, "put": { "operationId": "person_update", "summary": "Update PERSON", "description": "Updates PERSON identified by `uid_based_id`.\n\nThe `uid_based_id` can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n\nIf the request body already contains a PERSON.uid.value, it must match the `uid_based_id` in the URL. \n\nThe existing latest `version_uid` of PERSON resource (i.e. the `preceding_version_uid`) must be specified in the `If-Match` header.\n", "tags": [ "PERSON" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_versioned_object_uid" }, { "$ref": "#/components/parameters/If-Match" }, { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The new PERSON.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/200_PERSON_updated" }, "204": { "$ref": "#/components/responses/204_version_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "412": { "$ref": "#/components/responses/412_PERSON" }, "422": { "$ref": "#/components/responses/422" } } }, "delete": { "operationId": "person_delete", "summary": "Delete PERSON", "description": "Deletes the PERSON identified by `uid_based_id`.\n\nThe `uid_based_id` MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the `preceding_version_uid` to be deleted.\n", "tags": [ "PERSON" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_version_uid" } ], "responses": { "204": { "$ref": "#/components/responses/204_version_deleted" }, "400": { "$ref": "#/components/responses/400_already_deleted" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409_PERSON_with_uid_based_id" } } } }, "/demographic/role": { "post": { "operationId": "role_create", "summary": "Create ROLE", "description": "Creates the first version of a new ROLE.\n", "tags": [ "ROLE" ], "parameters": [ { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The ROLE.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/201_ROLE" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" } } } }, "/demographic/role/{uid_based_id}": { "get": { "operationId": "role_get", "summary": "Get ROLE", "description": "Retrieves a version of the ROLE identified by `uid_based_id`.\n\nThe `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`).\nThe former is used to retrieve a specific known version of the ROLE (e.g. one identified by `8849182c-82ad-4088-a07f-48ead4180515::cataniamc.prod.cadasto.com::1`), whereas the later (e.g. an identifier like `8849182c-82ad-4088-a07f-48ead4180515`) is be used to retrieve a version from the version container whenever the _version_tree_id_ is unknown or irrelevant (such as when most recent version is requested).\n\nWhen the `uid_based_id` has the form of a HIER_OBJECT_ID, if the `version_at_time` is supplied, retrieves the version extant _at specified time_, otherwise retrieves the _latest_ ROLE version.\n\nSee [Resource identification](overview.html#tag/Resources/Resource-identification) for more details about the identifiers usage and meaning.\n", "tags": [ "ROLE" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id" }, { "$ref": "#/components/parameters/version_at_time" }, { "$ref": "#/components/parameters/Prefer" } ], "responses": { "200": { "$ref": "#/components/responses/200_ROLE_retrieved" }, "204": { "$ref": "#/components/responses/204_deleted_at_time" }, "404": { "$ref": "#/components/responses/404_not_found_or_no_version_at_time" } } }, "put": { "operationId": "role_update", "summary": "Update ROLE", "description": "Updates ROLE identified by `uid_based_id`.\n\nThe `uid_based_id` can take only a form of an HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n\nIf the request body already contains a ROLE.uid.value, it must match the `uid_based_id` in the URL. \n\nThe existing latest `version_uid` of ROLE resource (i.e. the `preceding_version_uid`) must be specified in the `If-Match` header.\n", "tags": [ "ROLE" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_versioned_object_uid" }, { "$ref": "#/components/parameters/If-Match" }, { "$ref": "#/components/parameters/Prefer" }, { "$ref": "#/components/parameters/openehr-item-tag" } ], "requestBody": { "description": "The new ROLE.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/200_ROLE_updated" }, "204": { "$ref": "#/components/responses/204_version_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" }, "412": { "$ref": "#/components/responses/412_ROLE" }, "422": { "$ref": "#/components/responses/422" } } }, "delete": { "operationId": "role_delete", "summary": "Delete ROLE", "description": "Deletes the ROLE identified by `uid_based_id`.\n\nThe `uid_based_id` MUST be in a form of an OBJECT_VERSION_ID identifier taken from the last (most recent) VERSION.uid.value, representing the `preceding_version_uid` to be deleted.\n", "tags": [ "ROLE" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_as_version_uid" } ], "responses": { "204": { "$ref": "#/components/responses/204_version_deleted" }, "400": { "$ref": "#/components/responses/400_already_deleted" }, "404": { "$ref": "#/components/responses/404" }, "409": { "$ref": "#/components/responses/409_ROLE_with_uid_based_id" } } } }, "/demographic/versioned_party/{versioned_object_uid}": { "get": { "operationId": "versioned_party_get", "summary": "Get VERSIONED_PARTY", "description": "Retrieves a VERSIONED_PARTY identified by `versioned_object_uid`.\n", "tags": [ "VERSIONED_PARTY" ], "parameters": [ { "$ref": "#/components/parameters/versioned_object_uid_PARTY" } ], "responses": { "200": { "$ref": "#/components/responses/200_VERSIONED_PARTY" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/versioned_party/{versioned_object_uid}/revision_history": { "get": { "operationId": "versioned_party_revision_history", "summary": "Get VERSIONED_PARTY revision history", "description": "Retrieves revision history of the VERSIONED_PARTY identified by `versioned_object_uid`.\n", "tags": [ "VERSIONED_PARTY" ], "parameters": [ { "$ref": "#/components/parameters/versioned_object_uid_PARTY" } ], "responses": { "200": { "$ref": "#/components/responses/200_REVISION_HISTORY" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/versioned_party/{versioned_object_uid}/version": { "get": { "operationId": "versioned_party_version_get_at_time", "summary": "Get VERSIONED_PARTY version at time", "description": "Retrieves a VERSION from the VERSIONED_PARTY identified by `versioned_object_uid`.\n\nIf `version_at_time` is supplied, retrieves the VERSION extant _at specified time_, otherwise retrieves the _latest_ VERSION.\n", "tags": [ "VERSIONED_PARTY" ], "parameters": [ { "$ref": "#/components/parameters/versioned_object_uid_PARTY" }, { "$ref": "#/components/parameters/version_at_time" } ], "responses": { "200": { "$ref": "#/components/responses/200_VERSION_of_PARTY_at_time" }, "404": { "$ref": "#/components/responses/404_not_found_or_no_version_at_time" } } } }, "/demographic/versioned_party/{versioned_object_uid}/version/{version_uid}": { "get": { "operationId": "versioned_party_version_get_by_id", "summary": "Get VERSIONED_PARTY version by id", "description": "Retrieves a VERSION identified by `version_uid` of a VERSIONED_PARTY identified by `versioned_object_uid`.\n", "tags": [ "VERSIONED_PARTY" ], "parameters": [ { "$ref": "#/components/parameters/versioned_object_uid_PARTY" }, { "$ref": "#/components/parameters/version_uid" } ], "responses": { "200": { "$ref": "#/components/responses/200_VERSION_of_PARTY_by_id" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/contribution": { "post": { "operationId": "contribution_create", "summary": "Create CONTRIBUTION", "description": "We will use the relaxed CONTRIBUTION with the following optional attributes:\n - `uid`: when provided, it will be accepted in case is not in-use, otherwise error will be returned\n - `audit.time_committed`: server will always set it\n - `audit.system_id`: when provided, it will be validated\n", "tags": [ "CONTRIBUTION" ], "parameters": [ { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The CONTRIBUTION.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewContribution" } } }, "required": true }, "responses": { "201": { "$ref": "#/components/responses/201_demographic_CONTRIBUTION" }, "400": { "$ref": "#/components/responses/400_CONTRIBUTION" }, "409": { "$ref": "#/components/responses/409" } } } }, "/demographic/contribution/{contribution_uid}": { "get": { "operationId": "contribution_get", "summary": "Get CONTRIBUTION by id", "description": "Retrieves a CONTRIBUTION identified by `contribution_uid`.\n", "tags": [ "CONTRIBUTION" ], "parameters": [ { "$ref": "#/components/parameters/contribution_uid" } ], "responses": { "200": { "$ref": "#/components/responses/200_CONTRIBUTION" }, "404": { "$ref": "#/components/responses/404_demographic_CONTRIBUTION" } } } }, "/demographic/tags": { "get": { "operationId": "demographic_tags_get", "summary": "Get demographic tags", "description": "Retrieves the list of ITEM_TAG resources associated with any demographic target\n(PERSON, AGENT, GROUP, ORGANISATION, or ROLE), optionally filtered by `tag_key`,\n`tag_value`, and/or `tag_target_path`. When no filter is provided, all tags in\nthe demographic store are returned.\n\nMore than one ITEM_TAG may be associated with a single target — they are uniquely\nidentified by `(key, target_path)`.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/tag_key" }, { "$ref": "#/components/parameters/tag_value" }, { "$ref": "#/components/parameters/tag_target_path" } ], "responses": { "200": { "$ref": "#/components/responses/200_DEMOGRAPHIC_tags_list" }, "400": { "$ref": "#/components/responses/400" } } } }, "/demographic/agent/{uid_based_id}/tags": { "get": { "operationId": "agent_tags_get", "summary": "Get AGENT tags", "description": "Retrieves the list of ITEM_TAG resources associated with the target AGENT\nidentified by `uid_based_id`. Returns an empty list when the target has no tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" } ], "responses": { "200": { "$ref": "#/components/responses/200_AGENT_tags_list" }, "404": { "$ref": "#/components/responses/404" } } }, "put": { "operationId": "agent_tags_update", "summary": "Update AGENT tags", "description": "Replaces the full ITEM_TAG list for the target AGENT identified by `uid_based_id`\nwith the supplied list. Send an empty list to clear all tags. Tags are uniquely\nidentified by `(key, target_path)`; duplicates within the request are silently\ndeduplicated and the first occurrence wins.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The full new ITEM_TAG list for the target.", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateItemTag" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200_AGENT_tags_list" }, "204": { "$ref": "#/components/responses/204_tags_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/agent/{uid_based_id}/tags/{key}": { "delete": { "operationId": "agent_tags_delete", "summary": "Delete AGENT tag by key", "description": "Deletes the ITEM_TAG resource(s) identified by `key`, associated with the target\nAGENT identified by `uid_based_id`. Removes every ITEM_TAG with this key regardless\nof `target_path`.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/key" } ], "responses": { "204": { "$ref": "#/components/responses/204_tag_deleted" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/group/{uid_based_id}/tags": { "get": { "operationId": "group_tags_get", "summary": "Get GROUP tags", "description": "Retrieves the list of ITEM_TAG resources associated with the target GROUP\nidentified by `uid_based_id`. Returns an empty list when the target has no tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" } ], "responses": { "200": { "$ref": "#/components/responses/200_GROUP_tags_list" }, "404": { "$ref": "#/components/responses/404" } } }, "put": { "operationId": "group_tags_update", "summary": "Update GROUP tags", "description": "Replaces the full ITEM_TAG list for the target GROUP identified by `uid_based_id`\nwith the supplied list. Send an empty list to clear all tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The full new ITEM_TAG list for the target.", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateItemTag" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200_GROUP_tags_list" }, "204": { "$ref": "#/components/responses/204_tags_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/group/{uid_based_id}/tags/{key}": { "delete": { "operationId": "group_tags_delete", "summary": "Delete GROUP tag by key", "description": "Deletes the ITEM_TAG resource(s) identified by `key`, associated with the target\nGROUP identified by `uid_based_id`.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/key" } ], "responses": { "204": { "$ref": "#/components/responses/204_tag_deleted" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/organisation/{uid_based_id}/tags": { "get": { "operationId": "organisation_tags_get", "summary": "Get ORGANISATION tags", "description": "Retrieves the list of ITEM_TAG resources associated with the target ORGANISATION\nidentified by `uid_based_id`. Returns an empty list when the target has no tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" } ], "responses": { "200": { "$ref": "#/components/responses/200_ORGANISATION_tags_list" }, "404": { "$ref": "#/components/responses/404" } } }, "put": { "operationId": "organisation_tags_update", "summary": "Update ORGANISATION tags", "description": "Replaces the full ITEM_TAG list for the target ORGANISATION identified by\n`uid_based_id` with the supplied list. Send an empty list to clear all tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The full new ITEM_TAG list for the target.", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateItemTag" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200_ORGANISATION_tags_list" }, "204": { "$ref": "#/components/responses/204_tags_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/organisation/{uid_based_id}/tags/{key}": { "delete": { "operationId": "organisation_tags_delete", "summary": "Delete ORGANISATION tag by key", "description": "Deletes the ITEM_TAG resource(s) identified by `key`, associated with the target\nORGANISATION identified by `uid_based_id`.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/key" } ], "responses": { "204": { "$ref": "#/components/responses/204_tag_deleted" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/person/{uid_based_id}/tags": { "get": { "operationId": "person_tags_get", "summary": "Get PERSON tags", "description": "Retrieves the list of ITEM_TAG resources associated with the target PERSON\nidentified by `uid_based_id`. Returns an empty list when the target has no tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" } ], "responses": { "200": { "$ref": "#/components/responses/200_PERSON_tags_list" }, "404": { "$ref": "#/components/responses/404" } } }, "put": { "operationId": "person_tags_update", "summary": "Update PERSON tags", "description": "Replaces the full ITEM_TAG list for the target PERSON identified by `uid_based_id`\nwith the supplied list. Send an empty list to clear all tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The full new ITEM_TAG list for the target.", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateItemTag" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200_PERSON_tags_list" }, "204": { "$ref": "#/components/responses/204_tags_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/person/{uid_based_id}/tags/{key}": { "delete": { "operationId": "person_tags_delete", "summary": "Delete PERSON tag by key", "description": "Deletes the ITEM_TAG resource(s) identified by `key`, associated with the target\nPERSON identified by `uid_based_id`.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/key" } ], "responses": { "204": { "$ref": "#/components/responses/204_tag_deleted" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/role/{uid_based_id}/tags": { "get": { "operationId": "role_tags_get", "summary": "Get ROLE tags", "description": "Retrieves the list of ITEM_TAG resources associated with the target ROLE\nidentified by `uid_based_id`. Returns an empty list when the target has no tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" } ], "responses": { "200": { "$ref": "#/components/responses/200_ROLE_tags_list" }, "404": { "$ref": "#/components/responses/404" } } }, "put": { "operationId": "role_tags_update", "summary": "Update ROLE tags", "description": "Replaces the full ITEM_TAG list for the target ROLE identified by `uid_based_id`\nwith the supplied list. Send an empty list to clear all tags.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/Prefer" } ], "requestBody": { "description": "The full new ITEM_TAG list for the target.", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateItemTag" } } } } }, "responses": { "200": { "$ref": "#/components/responses/200_ROLE_tags_list" }, "204": { "$ref": "#/components/responses/204_tags_updated" }, "400": { "$ref": "#/components/responses/400" }, "404": { "$ref": "#/components/responses/404" } } } }, "/demographic/role/{uid_based_id}/tags/{key}": { "delete": { "operationId": "role_tags_delete", "summary": "Delete ROLE tag by key", "description": "Deletes the ITEM_TAG resource(s) identified by `key`, associated with the target\nROLE identified by `uid_based_id`.\n", "tags": [ "ITEM_TAG" ], "parameters": [ { "$ref": "#/components/parameters/uid_based_id_for_tags" }, { "$ref": "#/components/parameters/key" } ], "responses": { "204": { "$ref": "#/components/responses/204_tag_deleted" }, "404": { "$ref": "#/components/responses/404" } } } } }, "components": { "schemas": { "UMDvUri": { "title": "DV_URI", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_URI" ], "type": "string" }, "value": { "type": "string" } } }, "DvEhrUri": { "title": "DV_EHR_URI", "type": "object", "properties": { "_type": { "enum": [ "DV_EHR_URI" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ] }, "UMDvEhrUri": { "title": "DV_EHR_URI", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_EHR_URI" ], "type": "string" }, "value": { "type": "string" } } }, "UDvUri": { "title": "DV_URI", "type": "object", "description": "Polymorphic DV_URI wrapper. See concrete leaf schemas:\n- `UMDvUri`\n- `UMDvEhrUri`\n" }, "TerminologyId": { "title": "TERMINOLOGY_ID", "type": "object", "properties": { "_type": { "enum": [ "TERMINOLOGY_ID" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ] }, "CodePhrase": { "title": "CODE_PHRASE", "required": [ "terminology_id", "code_string" ], "type": "object", "properties": { "terminology_id": { "$ref": "#/components/schemas/TerminologyId" }, "code_string": { "type": "string" }, "preferred_term": { "type": "string" } } }, "DvCodedText": { "title": "DV_CODED_TEXT", "required": [ "value", "defining_code" ], "type": "object", "properties": { "_type": { "enum": [ "DV_CODED_TEXT" ], "type": "string" }, "value": { "type": "string" }, "hyperlink": { "$ref": "#/components/schemas/UDvUri" }, "formatting": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/TermMapping" } }, "language": { "$ref": "#/components/schemas/CodePhrase" }, "encoding": { "$ref": "#/components/schemas/CodePhrase" }, "defining_code": { "$ref": "#/components/schemas/CodePhrase" } } }, "TermMapping": { "title": "TERM_MAPPING", "required": [ "match", "target" ], "type": "object", "properties": { "match": { "pattern": "/^[><=?]$/", "type": "string" }, "purpose": { "type": "object", "properties": { "value": { "type": "string" }, "defining_code": { "$ref": "#/components/schemas/CodePhrase" } } }, "target": { "$ref": "#/components/schemas/CodePhrase" } } }, "UMDvText": { "title": "DV_TEXT", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_TEXT" ], "type": "string" }, "value": { "type": "string" }, "hyperlink": { "$ref": "#/components/schemas/UDvUri" }, "formatting": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/TermMapping" } }, "language": { "$ref": "#/components/schemas/CodePhrase" }, "encoding": { "$ref": "#/components/schemas/CodePhrase" } } }, "UMDvCodedText": { "title": "DV_CODED_TEXT", "required": [ "value", "defining_code", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_CODED_TEXT" ], "type": "string" }, "value": { "type": "string" }, "hyperlink": { "$ref": "#/components/schemas/UDvUri" }, "formatting": { "type": "string" }, "mappings": { "type": "array", "items": { "$ref": "#/components/schemas/TermMapping" } }, "language": { "$ref": "#/components/schemas/CodePhrase" }, "encoding": { "$ref": "#/components/schemas/CodePhrase" }, "defining_code": { "$ref": "#/components/schemas/CodePhrase" } } }, "UDvText": { "title": "DV_TEXT", "type": "object", "description": "Polymorphic DV_TEXT wrapper. See concrete leaf schemas:\n- `UMDvText`\n- `UMDvCodedText`\n" }, "HierObjectId": { "title": "HIER_OBJECT_ID", "required": [ "value" ], "type": "object", "properties": { "_type": { "enum": [ "HIER_OBJECT_ID" ], "type": "string" }, "value": { "type": "string", "format": "uuid" } } }, "UMHierObjectId": { "title": "HIER_OBJECT_ID", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "HIER_OBJECT_ID" ], "type": "string" }, "value": { "type": "string", "format": "uuid" } } }, "ObjectVersionId": { "title": "OBJECT_VERSION_ID", "required": [ "value" ], "type": "object", "properties": { "_type": { "enum": [ "OBJECT_VERSION_ID" ], "type": "string" }, "value": { "type": "string" } } }, "UMObjectVersionId": { "title": "OBJECT_VERSION_ID", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "OBJECT_VERSION_ID" ], "type": "string" }, "value": { "type": "string" } } }, "UUidBasedId": { "title": "UID_BASED_ID", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UMHierObjectId" }, { "$ref": "#/components/schemas/UMObjectVersionId" } ], "discriminator": { "propertyName": "_type", "mapping": { "HIER_OBJECT_ID": "#/components/schemas/UMHierObjectId", "OBJECT_VERSION_ID": "#/components/schemas/UMObjectVersionId" } } }, "Link": { "title": "LINK", "required": [ "meaning", "type", "target" ], "type": "object", "properties": { "meaning": { "type": "string" }, "type": { "type": "string" }, "target": { "$ref": "#/components/schemas/DvEhrUri" } } }, "ArchetypeId": { "title": "ARCHETYPE_ID", "type": "object", "properties": { "_type": { "enum": [ "ARCHETYPE_ID" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ] }, "TemplateId": { "title": "TEMPLATE_ID", "type": "object", "properties": { "_type": { "enum": [ "TEMPLATE_ID" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "value" ] }, "Archetyped": { "title": "ARCHETYPED", "required": [ "archetype_id", "rm_version" ], "type": "object", "properties": { "archetype_id": { "$ref": "#/components/schemas/ArchetypeId" }, "template_id": { "$ref": "#/components/schemas/TemplateId" }, "rm_version": { "type": "string" } }, "additionalProperties": false }, "DvIdentifier": { "title": "DV_IDENTIFIER", "required": [ "id" ], "type": "object", "properties": { "_type": { "enum": [ "DV_IDENTIFIER" ], "type": "string" }, "issuer": { "type": "string" }, "assigner": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" } }, "description": "Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number, prescription id, order id, and so on.\n\nDV_IDENTIFIER is used to represent any identifier of a real thing, issued by some authority or agency.\n" }, "DvMultimedia": { "title": "DV_MULTIMEDIA", "required": [ "_type", "media_type", "size" ], "type": "object", "properties": { "_type": { "enum": [ "DV_MULTIMEDIA" ], "type": "string" }, "charset": { "$ref": "#/components/schemas/CodePhrase" }, "language": { "$ref": "#/components/schemas/CodePhrase" }, "alternate_text": { "type": "string" }, "uri": { "$ref": "#/components/schemas/UDvUri" }, "data": { "type": "string" }, "media_type": { "$ref": "#/components/schemas/CodePhrase" }, "compression_algorithm": { "$ref": "#/components/schemas/CodePhrase" }, "integrity_check": { "type": "string" }, "integrity_check_algorithm": { "$ref": "#/components/schemas/CodePhrase" }, "thumbnail": { "type": "object", "description": "Recursive reference to DvMultimedia (thumbnail)" }, "size": { "type": "integer" } } }, "UMDvMultimedia": { "title": "DV_MULTIMEDIA", "required": [ "_type", "media_type", "size" ], "type": "object", "properties": { "_type": { "enum": [ "DV_MULTIMEDIA" ], "type": "string" }, "charset": { "$ref": "#/components/schemas/CodePhrase" }, "language": { "$ref": "#/components/schemas/CodePhrase" }, "alternate_text": { "type": "string" }, "uri": { "$ref": "#/components/schemas/UDvUri" }, "data": { "type": "string" }, "media_type": { "$ref": "#/components/schemas/CodePhrase" }, "compression_algorithm": { "$ref": "#/components/schemas/CodePhrase" }, "integrity_check": { "type": "string" }, "integrity_check_algorithm": { "$ref": "#/components/schemas/CodePhrase" }, "thumbnail": { "type": "object", "description": "Recursive reference to DvMultimedia (thumbnail)" }, "size": { "type": "integer" } } }, "UMDvParsable": { "title": "DV_PARSABLE", "required": [ "_type", "value", "formalism" ], "type": "object", "properties": { "_type": { "enum": [ "DV_PARSABLE" ], "type": "string" }, "charset": { "$ref": "#/components/schemas/CodePhrase" }, "language": { "$ref": "#/components/schemas/CodePhrase" }, "value": { "type": "string" }, "formalism": { "type": "string" } } }, "UDvEncapsulated": { "title": "DV_ENCAPSULATED", "type": "object", "description": "Polymorphic DV_ENCAPSULATED wrapper. See concrete leaf schemas:\n- `UMDvMultimedia`\n- `UMDvParsable`\n" }, "PartyRef": { "title": "PARTY_REF", "type": "object", "properties": { "namespace": { "type": "string" }, "type": { "pattern": "^PERSON|ORGANISATION|GROUP|AGENT|ROLE|PARTY|ACTOR$", "type": "string" }, "id": { "$ref": "#/components/schemas/UMHierObjectId" } }, "description": "Identifier for parties in a demographic or identity service.", "required": [ "namespace", "type", "id" ] }, "UMPartyIdentified": { "title": "PARTY_IDENTIFIED", "required": [ "_type" ], "type": "object", "properties": { "_type": { "enum": [ "PARTY_IDENTIFIED" ], "type": "string" }, "external_ref": { "$ref": "#/components/schemas/PartyRef" }, "name": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/DvIdentifier" } } } }, "UMPartyRelated": { "title": "PARTY_RELATED", "required": [ "_type", "relationship" ], "type": "object", "properties": { "_type": { "enum": [ "PARTY_RELATED" ], "type": "string" }, "external_ref": { "$ref": "#/components/schemas/PartyRef" }, "name": { "type": "string" }, "identifiers": { "type": "array", "items": { "$ref": "#/components/schemas/DvIdentifier" } }, "relationship": { "$ref": "#/components/schemas/DvCodedText" } } }, "UPartyIdentified": { "title": "PARTY_IDENTIFIED", "type": "object", "description": "Polymorphic PARTY_IDENTIFIED wrapper. See concrete leaf schemas:\n- `UMPartyIdentified`\n- `UMPartyRelated`\n" }, "UMPartySelf": { "title": "PARTY_SELF", "required": [ "_type" ], "type": "object", "properties": { "_type": { "enum": [ "PARTY_SELF" ], "type": "string" }, "external_ref": { "$ref": "#/components/schemas/PartyRef" } } }, "UPartyProxy": { "title": "PARTY_PROXY", "type": "object", "description": "Polymorphic PARTY_PROXY wrapper. See concrete leaf schemas:\n- `UMPartySelf`\n- `UMPartyIdentified`\n- `UMPartyRelated`\n" }, "DvInterval": { "title": "DV_INTERVAL", "required": [ "lower_unbounded", "upper_unbounded", "lower_included", "upper_included" ], "type": "object", "properties": { "_type": { "type": "string", "default": "DV_INTERVAL" }, "lower_unbounded": { "type": "boolean" }, "upper_unbounded": { "type": "boolean" }, "lower_included": { "type": "boolean" }, "upper_included": { "type": "boolean" } } }, "ReferenceRange": { "title": "REFERENCE_RANGE", "required": [ "meaning", "range" ], "type": "object", "properties": { "meaning": { "$ref": "#/components/schemas/UDvText" }, "range": { "$ref": "#/components/schemas/DvInterval" } } }, "DvDuration": { "title": "DV_DURATION", "type": "object", "properties": { "_type": { "enum": [ "DV_DURATION" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy_is_percent": { "type": "boolean" }, "accuracy": { "type": "number" } } }, "DvDateTime": { "title": "DV_DATE_TIME", "required": [ "value" ], "type": "object", "properties": { "_type": { "enum": [ "DV_DATE_TIME" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy": { "$ref": "#/components/schemas/DvDuration" }, "value": { "type": "string", "format": "date-time" } } }, "UMDvBoolean": { "title": "DV_BOOLEAN", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_BOOLEAN" ], "type": "string" }, "value": { "type": "boolean" } } }, "UMDvCount": { "title": "DV_COUNT", "required": [ "magnitude", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_COUNT" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy_is_percent": { "type": "boolean" }, "accuracy": { "type": "number" }, "magnitude": { "type": "integer" } } }, "UMDvDate": { "title": "DV_DATE", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_DATE" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy": { "$ref": "#/components/schemas/DvDuration" }, "value": { "type": "string", "format": "date" } } }, "UMDvDateTime": { "title": "DV_DATE_TIME", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_DATE_TIME" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy": { "$ref": "#/components/schemas/DvDuration" }, "value": { "type": "string", "format": "date-time" } } }, "UMDvDuration": { "title": "DV_DURATION", "required": [ "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_DURATION" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy_is_percent": { "type": "boolean" }, "accuracy": { "type": "number" } } }, "UMDvIdentifier": { "title": "DV_IDENTIFIER", "required": [ "id", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_IDENTIFIER" ], "type": "string" }, "issuer": { "type": "string" }, "assigner": { "type": "string" }, "id": { "type": "string" }, "type": { "type": "string" } } }, "UMDvOrdinal": { "title": "DV_ORDINAL", "required": [ "symbol", "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_ORDINAL" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "symbol": { "$ref": "#/components/schemas/DvCodedText" }, "value": { "type": "integer" } } }, "UMDvProportion": { "title": "DV_PROPORTION", "required": [ "numerator", "denominator", "semantic_type", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_PROPORTION" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy_is_percent": { "type": "boolean" }, "accuracy": { "type": "number" }, "numerator": { "type": "number" }, "denominator": { "type": "number" }, "semantic_type": { "type": "integer" }, "precision": { "type": "integer" } } }, "UMDvQuantity": { "title": "DV_QUANTITY", "required": [ "magnitude", "units", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_QUANTITY" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy_is_percent": { "type": "boolean" }, "accuracy": { "type": "number" }, "magnitude": { "type": "number" }, "precision": { "type": "integer" }, "units": { "type": "string" }, "units_system": { "type": "string" }, "units_display_name": { "type": "string" } } }, "UMDvScale": { "title": "DV_SCALE", "required": [ "symbol", "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_SCALE" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "symbol": { "$ref": "#/components/schemas/DvCodedText" }, "value": { "type": "number" } } }, "UMDvState": { "title": "DV_STATE", "required": [ "value", "is_terminal", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_STATE" ], "type": "string" }, "value": { "$ref": "#/components/schemas/DvCodedText" }, "is_terminal": { "type": "boolean" } } }, "UMDvTime": { "title": "DV_TIME", "required": [ "value", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "DV_TIME" ], "type": "string" }, "normal_status": { "$ref": "#/components/schemas/CodePhrase" }, "normal_range": { "$ref": "#/components/schemas/DvInterval" }, "other_reference_ranges": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceRange" } }, "magnitude_status": { "type": "string", "default": "=" }, "accuracy": { "$ref": "#/components/schemas/DvDuration" }, "value": { "type": "string", "format": "time" } } }, "UDataValue": { "title": "DATA_VALUE", "type": "object" }, "Element": { "title": "ELEMENT", "type": "object", "properties": { "_type": { "enum": [ "ELEMENT" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "null_flavour": { "$ref": "#/components/schemas/DvCodedText" }, "value": { "$ref": "#/components/schemas/UDataValue" }, "null_reason": { "$ref": "#/components/schemas/UDvText" } }, "required": [ "name", "archetype_node_id" ] }, "ItemSingle": { "title": "ITEM_SINGLE", "required": [ "name", "archetype_node_id", "item" ], "type": "object", "properties": { "_type": { "enum": [ "ITEM_SINGLE" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "item": { "$ref": "#/components/schemas/Element" } } }, "ItemList": { "title": "ITEM_LIST", "type": "object", "properties": { "_type": { "enum": [ "ITEM_LIST" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Element" } } }, "required": [ "name", "archetype_node_id" ] }, "Clstr": { "title": "CLUSTER", "required": [ "name", "archetype_node_id", "items" ], "type": "object", "properties": { "_type": { "enum": [ "CLUSTER" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UItemLeaf" } } } }, "UItem": { "title": "ITEM", "type": "object", "description": "Polymorphic ITEM wrapper. See concrete leaf schemas:\n- `Element`\n- `Clstr` (CLUSTER)\n" }, "UItemLeaf": { "title": "ITEM (Leaf)", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/Element" } ], "discriminator": { "propertyName": "_type", "mapping": { "ELEMENT": "#/components/schemas/Element" } } }, "ItemTable": { "title": "ITEM_TABLE", "type": "object", "properties": { "_type": { "enum": [ "ITEM_TABLE" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Clstr" } } }, "required": [ "name", "archetype_node_id" ] }, "ItemTree": { "title": "ITEM_TREE", "type": "object", "properties": { "_type": { "enum": [ "ITEM_TREE" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UItemLeaf" }, "description": "See [ITEM](#tag/ITEM_schema) schema details." } }, "required": [ "name", "archetype_node_id" ] }, "UItemStructure": { "title": "ITEM_STRUCTURE", "type": "object", "description": "Polymorphic ITEM_STRUCTURE wrapper. See concrete leaf schemas:\n- `ItemSingle`\n- `ItemList`\n- `ItemTable`\n- `ItemTree`\n" }, "FeederAuditDetails": { "title": "FEEDER_AUDIT_DETAILS", "required": [ "system_id" ], "type": "object", "properties": { "system_id": { "type": "string" }, "location": { "$ref": "#/components/schemas/UPartyIdentified" }, "subject": { "$ref": "#/components/schemas/UPartyProxy" }, "provider": { "$ref": "#/components/schemas/UPartyIdentified" }, "time": { "$ref": "#/components/schemas/DvDateTime" }, "version_id": { "type": "string" }, "other_details": { "type": "object", "description": "Any other details of the system audit. (Structure simplified for documentation performance).\n" } } }, "FeederAudit": { "title": "FEEDER_AUDIT", "required": [ "originating_system_audit" ], "type": "object", "properties": { "originating_system_item_ids": { "type": "array", "items": { "$ref": "#/components/schemas/DvIdentifier" } }, "feeder_system_item_ids": { "type": "array", "items": { "$ref": "#/components/schemas/DvIdentifier" } }, "original_content": { "$ref": "#/components/schemas/UDvEncapsulated" }, "originating_system_audit": { "$ref": "#/components/schemas/FeederAuditDetails" }, "feeder_system_audit": { "$ref": "#/components/schemas/FeederAuditDetails" } } }, "PartyIdentity": { "title": "PARTY_IDENTITY", "required": [ "name", "archetype_node_id", "details" ], "type": "object", "properties": { "_type": { "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "details": { "$ref": "#/components/schemas/UItemStructure" } } }, "ListOfPartyIdentity": { "title": "ListOfPartyIdentity", "type": "array", "items": { "$ref": "#/components/schemas/PartyIdentity" } }, "Address": { "title": "ADDRESS", "required": [ "name", "archetype_node_id", "details" ], "type": "object", "properties": { "_type": { "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "details": { "$ref": "#/components/schemas/UItemStructure" } } }, "DvIntervalOfDate": { "title": "DV_INTERVAL_of_DATE", "type": "object", "properties": { "_type": { "type": "string", "default": "DV_INTERVAL" }, "lower_unbounded": { "type": "boolean" }, "upper_unbounded": { "type": "boolean" }, "lower_included": { "type": "boolean" }, "upper_included": { "type": "boolean" }, "lower": { "$ref": "#/components/schemas/UMDvDate" }, "upper": { "$ref": "#/components/schemas/UMDvDate" } }, "required": [ "lower_unbounded", "upper_unbounded", "lower_included", "upper_included" ] }, "Contact": { "title": "CONTACT", "required": [ "name", "archetype_node_id", "addresses" ], "type": "object", "properties": { "_type": { "enum": [ "CONTACT" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "addresses": { "type": "array", "items": { "$ref": "#/components/schemas/Address" } }, "time_validity": { "$ref": "#/components/schemas/DvIntervalOfDate" } } }, "ListOfContact": { "title": "ListOfContact", "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "PartyRelationship": { "title": "PARTY_RELATIONSHIP", "required": [ "name", "archetype_node_id", "source", "target" ], "type": "object", "properties": { "_type": { "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "source": { "$ref": "#/components/schemas/PartyRef" }, "target": { "$ref": "#/components/schemas/PartyRef" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "time_validity": { "$ref": "#/components/schemas/DvIntervalOfDate" } } }, "ListOfPartyRelationship": { "title": "ListOfPartyRelationShip", "type": "array", "items": { "$ref": "#/components/schemas/PartyRelationship" } }, "Agent": { "title": "AGENT", "type": "object", "properties": { "_type": { "enum": [ "AGENT" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } }, "required": [ "name", "archetype_node_id", "identities" ] }, "Identifier": { "title": "Identifier", "required": [ "uid" ], "type": "object", "properties": { "uid": { "type": "string", "description": "The (version) resource identifier." } } }, "Error": { "title": "Error", "required": [ "message", "validationErrors" ], "type": "object", "properties": { "message": { "type": "string" }, "validationErrors": { "type": "array", "items": { "type": "string" }, "description": "" } } }, "Group": { "title": "GROUP", "type": "object", "properties": { "_type": { "enum": [ "GROUP" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } }, "required": [ "name", "archetype_node_id", "identities" ] }, "Organisation": { "title": "ORGANISATION", "type": "object", "properties": { "_type": { "enum": [ "ORGANISATION" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } }, "required": [ "name", "archetype_node_id", "identities" ] }, "Person": { "title": "PERSON", "type": "object", "properties": { "_type": { "enum": [ "PERSON" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } }, "required": [ "name", "archetype_node_id", "identities" ] }, "Capability": { "title": "CAPABILITY", "required": [ "name", "archetype_node_id", "credentials" ], "type": "object", "properties": { "_type": { "enum": [ "CAPABILITY" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "credentials": { "$ref": "#/components/schemas/UItemStructure" }, "time_validity": { "$ref": "#/components/schemas/DvIntervalOfDate" } } }, "ListOfCapability": { "title": "ListOfCapability", "type": "array", "items": { "$ref": "#/components/schemas/Capability" } }, "Role": { "title": "ROLE", "required": [ "name", "archetype_node_id", "identities", "performer" ], "type": "object", "properties": { "_type": { "enum": [ "ROLE" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "time_validity": { "$ref": "#/components/schemas/DvIntervalOfDate" }, "performer": { "$ref": "#/components/schemas/PartyRef" }, "capabilities": { "$ref": "#/components/schemas/ListOfCapability" } } }, "ObjectRefOfHierObjectId": { "title": "OBJECT_REF", "type": "object", "properties": { "namespace": { "type": "string" }, "type": { "type": "string" }, "id": { "$ref": "#/components/schemas/UMHierObjectId" } }, "required": [ "namespace", "type", "id" ] }, "VersionedParty": { "title": "VERSIONED_PARTY", "type": "object", "properties": { "_type": { "enum": [ "VERSIONED_PARTY" ], "type": "string" }, "uid": { "$ref": "#/components/schemas/HierObjectId" }, "owner_id": { "$ref": "#/components/schemas/ObjectRefOfHierObjectId" }, "time_created": { "$ref": "#/components/schemas/DvDateTime" } }, "description": "A VERSIONED_PARTY resource", "required": [ "uid", "owner_id", "time_created" ] }, "AuditDetails": { "title": "AUDIT_DETAILS", "required": [ "system_id", "time_committed", "change_type", "committer" ], "type": "object", "properties": { "_type": { "type": "string", "default": "AUDIT_DETAILS" }, "system_id": { "type": "string" }, "time_committed": { "$ref": "#/components/schemas/DvDateTime" }, "change_type": { "$ref": "#/components/schemas/DvCodedText" }, "description": { "$ref": "#/components/schemas/UDvText" }, "committer": { "$ref": "#/components/schemas/UPartyProxy" } }, "description": "The set of attributes required to document the committal of an information item to a repository." }, "RevisionHistoryItem": { "title": "REVISION_HISTORY_ITEM", "required": [ "version_id", "audits" ], "type": "object", "properties": { "version_id": { "$ref": "#/components/schemas/ObjectVersionId" }, "audits": { "type": "array", "items": { "$ref": "#/components/schemas/AuditDetails" } } }, "description": "A REVISION_HISTORY_ITEM resource" }, "RevisionHistory": { "title": "REVISION_HISTORY", "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RevisionHistoryItem" } } }, "description": "A REVISION_HISTORY resource" }, "UMAgent": { "title": "AGENT", "required": [ "name", "archetype_node_id", "identities", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "AGENT" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } } }, "UMGroup": { "title": "GROUP", "required": [ "name", "archetype_node_id", "identities", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "GROUP" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } } }, "UMOrganisation": { "title": "ORGANISATION", "required": [ "name", "archetype_node_id", "identities", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "ORGANISATION" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } } }, "UMPerson": { "title": "PERSON", "required": [ "name", "archetype_node_id", "identities", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "PERSON" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/UDvText" } }, "roles": { "type": "array", "items": { "$ref": "#/components/schemas/PartyRef" } } } }, "UMRole": { "title": "ROLE", "required": [ "name", "archetype_node_id", "identities", "performer", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "ROLE" ], "type": "string" }, "name": { "$ref": "#/components/schemas/UDvText" }, "archetype_node_id": { "type": "string", "xml": { "attribute": true } }, "uid": { "$ref": "#/components/schemas/UUidBasedId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" } }, "archetype_details": { "$ref": "#/components/schemas/Archetyped" }, "feeder_audit": { "$ref": "#/components/schemas/FeederAudit" }, "identities": { "$ref": "#/components/schemas/ListOfPartyIdentity" }, "contacts": { "$ref": "#/components/schemas/ListOfContact" }, "details": { "$ref": "#/components/schemas/UItemStructure" }, "relationships": { "$ref": "#/components/schemas/ListOfPartyRelationship" }, "time_validity": { "$ref": "#/components/schemas/DvIntervalOfDate" }, "performer": { "$ref": "#/components/schemas/PartyRef" }, "capabilities": { "$ref": "#/components/schemas/ListOfCapability" } } }, "UVersionable": { "title": "Versionable", "type": "object", "description": "Abstract parent of AGENT, GROUP, ORGANISATION, PERSON, ROLE. (Simplified for Docs)" }, "Attestation": { "title": "ATTESTATION", "required": [ "system_id", "time_committed", "change_type", "committer", "reason", "is_pending" ], "type": "object", "properties": { "_type": { "enum": [ "ATTESTATION" ], "type": "string" }, "system_id": { "type": "string" }, "time_committed": { "$ref": "#/components/schemas/DvDateTime" }, "change_type": { "$ref": "#/components/schemas/DvCodedText" }, "description": { "$ref": "#/components/schemas/UDvText" }, "committer": { "$ref": "#/components/schemas/UPartyProxy" }, "attested_view": { "$ref": "#/components/schemas/DvMultimedia" }, "proof": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DvEhrUri" } }, "reason": { "$ref": "#/components/schemas/UDvText" }, "is_pending": { "type": "boolean" } }, "examples": [ { "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F", "committer": { "_type": "PARTY_IDENTIFIED", "name": "A user name" }, "time_committed": { "value": "2017-08-15T10:37:15.422+02:00" }, "change_type": { "value": "creation", "defining_code": { "terminology_id": { "value": "openehr" }, "code_string": "249" } }, "description": { "value": "Description text" } } ] }, "UParty": { "title": "PARTY", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UMAgent" }, { "$ref": "#/components/schemas/UMGroup" }, { "$ref": "#/components/schemas/UMOrganisation" }, { "$ref": "#/components/schemas/UMPerson" }, { "$ref": "#/components/schemas/UMRole" } ], "discriminator": { "propertyName": "_type", "mapping": { "AGENT": "#/components/schemas/UMAgent", "GROUP": "#/components/schemas/UMGroup", "ORGANISATION": "#/components/schemas/UMOrganisation", "PERSON": "#/components/schemas/UMPerson", "ROLE": "#/components/schemas/UMRole" } } }, "UMOriginalVersionOfParty": { "title": "ORIGINAL_VERSION", "required": [ "contribution", "commit_audit", "data", "uid", "lifecycle_state", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "ORIGINAL_VERSION" ], "type": "string" }, "contribution": { "$ref": "#/components/schemas/ObjectRefOfHierObjectId" }, "signature": { "type": "string" }, "commit_audit": { "$ref": "#/components/schemas/AuditDetails" }, "data": { "$ref": "#/components/schemas/UParty" }, "uid": { "$ref": "#/components/schemas/ObjectVersionId" }, "preceding_version_uid": { "$ref": "#/components/schemas/ObjectVersionId" }, "other_input_version_uids": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectVersionId" } }, "lifecycle_state": { "$ref": "#/components/schemas/DvCodedText" }, "attestations": { "type": "array", "items": { "$ref": "#/components/schemas/Attestation" } } } }, "UMImportedVersionOfParty": { "title": "IMPORTED_VERSION", "required": [ "contribution", "commit_audit", "data", "item", "_type" ], "type": "object", "properties": { "_type": { "enum": [ "IMPORTED_VERSION" ], "type": "string" }, "contribution": { "$ref": "#/components/schemas/ObjectRefOfHierObjectId" }, "signature": { "type": "string" }, "commit_audit": { "$ref": "#/components/schemas/AuditDetails" }, "data": { "$ref": "#/components/schemas/UParty" }, "item": { "$ref": "#/components/schemas/UMOriginalVersionOfParty" } } }, "UVersionOfParty": { "title": "VERSION", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/UMOriginalVersionOfParty" }, { "$ref": "#/components/schemas/UMImportedVersionOfParty" } ], "discriminator": { "propertyName": "_type", "mapping": { "ORIGINAL_VERSION": "#/components/schemas/UMOriginalVersionOfParty", "IMPORTED_VERSION": "#/components/schemas/UMImportedVersionOfParty" } } }, "TerminologyCode": { "title": "TERMINOLOGY_CODE", "required": [ "terminology_id", "code_string" ], "type": "object", "properties": { "terminology_id": { "type": "string" }, "terminology_version": { "type": "string" }, "code_string": { "type": "string" }, "uri": { "type": "string", "format": "uri" } } }, "UpdateAudit": { "title": "UPDATE_AUDIT", "required": [ "change_type", "committer" ], "type": "object", "properties": { "_type": { "type": "string", "default": "UPDATE_AUDIT" }, "change_type": { "$ref": "#/components/schemas/TerminologyCode" }, "description": { "$ref": "#/components/schemas/UDvText" }, "committer": { "$ref": "#/components/schemas/UPartyProxy" } }, "description": "The set of attributes required to document the committal of an information item to a repository. Used by the server to create an AUDIT_DETAILS object." }, "UpdateAttestation": { "title": "UPDATE_ATTESTATION", "required": [ "change_type", "committer", "reason", "is_pending" ], "type": "object", "properties": { "_type": { "enum": [ "UPDATE_ATTESTATION" ], "type": "string" }, "change_type": { "$ref": "#/components/schemas/TerminologyCode" }, "description": { "$ref": "#/components/schemas/UDvText" }, "committer": { "$ref": "#/components/schemas/UPartyProxy" }, "attested_view": { "$ref": "#/components/schemas/DvMultimedia" }, "proof": { "type": "string" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DvEhrUri" } }, "reason": { "$ref": "#/components/schemas/UDvText" }, "is_pending": { "type": "boolean" } } }, "UpdateVersion": { "title": "UPDATE_VERSION", "required": [ "lifecycle_state", "data", "commit_audit" ], "type": "object", "properties": { "preceding_version_uid": { "$ref": "#/components/schemas/ObjectVersionId" }, "signature": { "type": "string" }, "lifecycle_state": { "$ref": "#/components/schemas/TerminologyCode" }, "attestations": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateAttestation" } }, "data": { "$ref": "#/components/schemas/UVersionable" }, "commit_audit": { "$ref": "#/components/schemas/UpdateAudit" } } }, "NewContribution": { "title": "NewContribution", "required": [ "versions", "audit" ], "type": "object", "properties": { "uid": { "$ref": "#/components/schemas/HierObjectId" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateVersion" } }, "audit": { "$ref": "#/components/schemas/UpdateAudit" } }, "description": "A new (un-committed) CONTRIBUTION resource for Demographic" }, "ObjectRefOfObjectVersionId": { "title": "OBJECT_REF", "type": "object", "properties": { "namespace": { "type": "string" }, "type": { "type": "string" }, "id": { "$ref": "#/components/schemas/UMObjectVersionId" } }, "required": [ "namespace", "type", "id" ], "examples": [ { "id": { "_type": "OBJECT_VERSION_ID", "value": "fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1" }, "namespace": "local", "type": "COMPOSITION" } ] }, "Contribution": { "title": "CONTRIBUTION", "required": [ "uid", "versions", "audit" ], "type": "object", "properties": { "uid": { "$ref": "#/components/schemas/HierObjectId" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" } }, "audit": { "$ref": "#/components/schemas/AuditDetails" } }, "description": "A CONTRIBUTION resource", "examples": [ { "uid": { "value": "0826851c-c4c2-4d61-92b9-410fb8275ff0" }, "versions": [ { "id": { "_type": "OBJECT_VERSION_ID", "value": "fb458d9c-1323-42bc-b7f8-787f3660a0b5::cataniamc.prod.cadasto.com::1" }, "namespace": "local", "type": "COMPOSITION" }, { "id": { "_type": "OBJECT_VERSION_ID", "value": "abcdefgh-1323-42bc-b7f8-787f3660a0ba::cataniamc.prod.cadasto.com::1" }, "namespace": "local", "type": "FOLDER" } ], "audit": { "system_id": "9624982A-9F42-41A5-9318-AE13D5F5031F", "committer": { "_type": "PARTY_IDENTIFIED", "name": "A user name" }, "time_committed": { "value": "2017-08-15T10:37:15.422+02:00" }, "change_type": { "value": "creation", "defining_code": { "terminology_id": { "value": "openehr" }, "code_string": "249" } }, "description": { "value": "Description text" } } } ] }, "UpdateItemTag": { "title": "UPDATE_ITEM_TAG", "required": [ "key" ], "type": "object", "additionalProperties": false, "properties": { "key": { "type": "string", "description": "Tag key (identifier). Stored case-insensitively." }, "value": { "type": "string", "description": "Optional tag value." }, "target_path": { "type": "string", "maxLength": 500, "description": "Optional pointer into the target resource (AQL path). Maximum length 500 characters." } } }, "ItemTagOfPerson": { "title": "ITEM_TAG", "type": "object", "required": [ "key", "target", "owner_id" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "target_path": { "type": "string" }, "target": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" }, "owner_id": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" } } }, "ItemTagOfAgent": { "title": "ITEM_TAG", "type": "object", "required": [ "key", "target", "owner_id" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "target_path": { "type": "string" }, "target": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" }, "owner_id": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" } } }, "ItemTagOfGroup": { "title": "ITEM_TAG", "type": "object", "required": [ "key", "target", "owner_id" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "target_path": { "type": "string" }, "target": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" }, "owner_id": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" } } }, "ItemTagOfOrganisation": { "title": "ITEM_TAG", "type": "object", "required": [ "key", "target", "owner_id" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "target_path": { "type": "string" }, "target": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" }, "owner_id": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" } } }, "ItemTagOfRole": { "title": "ITEM_TAG", "type": "object", "required": [ "key", "target", "owner_id" ], "properties": { "key": { "type": "string" }, "value": { "type": "string" }, "target_path": { "type": "string" }, "target": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" }, "owner_id": { "$ref": "#/components/schemas/ObjectRefOfObjectVersionId" } } } }, "parameters": { "Prefer": { "name": "Prefer", "in": "header", "description": "RFC 7240 preference header. Multiple tokens may be sent in a single header as a\ncomma-separated list (e.g. `Prefer: return=representation, include_item_tags`)\nor as repeated headers. Cadasto recognises the following tokens:\n\n| Token | Where it applies | Effect |\n|-------|------------------|--------|\n| `return=representation` | write endpoints | Return the full updated resource in the response body. |\n| `return=identifier` | write endpoints | Return only the resource identifier (e.g. the `uid`). |\n| `return=minimal` (default on writes) | write endpoints | Empty response body. |\n| `include_item_tags` *(Cadasto extension)* | read endpoints, and write endpoints when the request does not already carry an `openehr-item-tag` header | Emit the `openehr-item-tag` response header with the current tags. On writes that ship `openehr-item-tag` in the request, the token is implied — the response always echoes the tags. Omitted by default on reads. See the [ITEM_TAG guide](/docs/guides/item-tag) for details. |\n\nThe `Preference-Applied` response header echoes the tokens the server actually honoured (`return=`, plus `include_item_tags` / `resolve_refs` when applied).\n", "required": false, "style": "simple", "schema": { "type": "string" } }, "uid_based_id": { "name": "uid_based_id", "in": "path", "description": "An abstract identifier: it 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`).\n", "required": true, "style": "simple", "schema": { "type": "string" } }, "version_at_time": { "name": "version_at_time", "in": "query", "description": "A given time in the extended ISO 8601 format.\n", "style": "form", "explode": true, "schema": { "type": "string", "format": "datetime" } }, "uid_based_id_as_versioned_object_uid": { "name": "uid_based_id", "in": "path", "description": "An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, "If-Match": { "name": "If-Match", "in": "header", "description": "Header to make the request conditional. \nTogether with `ETag` request tag, it helps to prevent simultaneous updates of a resource from overwriting each other (\"mid-air collisions\").\nThe format is always an `version_uid` identifier enclosed by double quotes.\nThe operation will be performed only if the existing latest `version_uid` of the resource (i.e. the `preceding_version_uid`) matches this header's value.\n", "required": true, "style": "simple", "schema": { "type": "string" } }, "uid_based_id_as_version_uid": { "name": "uid_based_id", "in": "path", "description": "An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a `version_uid`).\n", "required": true, "style": "simple", "schema": { "type": "string" } }, "versioned_object_uid_PARTY": { "name": "versioned_object_uid", "in": "path", "description": "VERSIONED_PARTY identifier taken from VERSIONED_PARTY.uid.value.\n", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, "version_uid": { "name": "version_uid", "in": "path", "description": "VERSION identifier taken from VERSION.uid.value.\n", "required": true, "style": "simple", "schema": { "type": "string" } }, "contribution_uid": { "name": "contribution_uid", "in": "path", "description": "The CONTRIBUTION uid.\n", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, "uid_based_id_for_tags": { "name": "uid_based_id", "in": "path", "description": "An identifier in the form of a HIER_OBJECT_ID identifier taken from\nVERSIONED_OBJECT.uid.value (i.e. a `versioned_object_uid`).\n\n> **Cadasto exception:** unlike the upstream openEHR ITS-REST specification,\n> Cadasto only accepts the `versioned_object_uid` form on `/tags` endpoints.\n> Targeting a specific version with an OBJECT_VERSION_ID is **not** supported —\n> tags are scoped to the versioned object as a whole.\n", "required": true, "style": "simple", "schema": { "type": "string", "format": "uuid" } }, "tag_key": { "name": "tag_key", "in": "query", "description": "Filter by ITEM_TAG `key` (exact, case-insensitive match).", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "tag_value": { "name": "tag_value", "in": "query", "description": "Filter by ITEM_TAG `value`.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "tag_target_path": { "name": "tag_target_path", "in": "query", "description": "Filter by ITEM_TAG `target_path`.", "required": false, "style": "form", "explode": true, "schema": { "type": "string" } }, "key": { "name": "key", "in": "path", "description": "The ITEM_TAG key.", "required": true, "style": "simple", "schema": { "type": "string" } }, "openehr-item-tag": { "name": "openehr-item-tag", "in": "header", "description": "The list of ITEM_TAG resources to associate with the current versioned object,\ncommitted in the same transaction as the create/update.\n\nTwo interchangeable formats are accepted:\n- **JSON (recommended)** — same shape as the `/tags` endpoint body\n- **Spec semicolon format** — `key=\"...\",value=\"...\"; key=\"...\",value=\"...\",target_path=\"...\"`\n\n> **Cadasto exception:** the `openehr-version-item-tag` request header — used by\n> upstream openEHR to scope tags to a single VERSION — is **not supported** by\n> Cadasto and will be rejected with `400 Bad Request`. Tags are always scoped to\n> the versioned object. See the\n> [ITEM_TAG guide](/docs/guides/item-tag) for details and error formats.\n", "required": false, "style": "simple", "explode": true, "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateItemTag" } } } }, "headers": { "ETag": { "description": "The `ETag` (i.e. entity tag) response header is an identifier (e.g. a `version_uid` enclosed by double quotes) for a specific version of a resource.\n", "schema": { "type": "string" } }, "Location_AGENT": { "description": "The `Location` response header indicates the URL of the AGENT resource.\n", "schema": { "type": "string", "format": "url" } }, "Location_deprecated": { "description": "The `Location` is [deprecated](overview.html#tag/Requests_and_responses/HTTP-headers/Location) for this action.\n", "deprecated": true, "schema": { "type": "string" } }, "Location_version": { "description": "The `Location` response header indicates the URL of the resource version resulted from the operation.\n", "schema": { "type": "string", "format": "url" } }, "openehr-item-tag": { "description": "The list of ITEM_TAG resources associated with the current versioned object,\nemitted as a JSON array.\n\n**When this header is emitted:**\n- On write endpoints (`POST` create, `PUT` update) — automatically, when the\n request carried an `openehr-item-tag` header (tag-aware request → tag-aware\n response) and the response uses `return=representation`. To force inclusion\n on a write that did not send tags, add `Prefer: include_item_tags`.\n- On read endpoints (`GET`) — only when the client opts in by sending\n `Prefer: include_item_tags`. Without the opt-in the additional tag lookup is\n skipped and the header is omitted entirely.\n\nThe header is also omitted when the resource has no tags.\n\n> **Cadasto exception:** the `openehr-version-item-tag` response header — used by\n> upstream openEHR to convey VERSION-scoped tags — is **never emitted** by Cadasto.\n> All tags are scoped to the versioned object as a whole.\n", "schema": { "type": "string" } }, "Location_GROUP": { "description": "The `Location` response header indicates the URL of the GROUP resource.\n", "schema": { "type": "string", "format": "url" } }, "Location_ORGANISATION": { "description": "The `Location` response header indicates the URL of the ORGANISATION resource.\n", "schema": { "type": "string", "format": "url" } }, "Location_PERSON": { "description": "The `Location` response header indicates the URL of the PERSON resource.\n", "schema": { "type": "string", "format": "url" } }, "Location_ROLE": { "description": "The `Location` response header indicates the URL of the ROLE resource.\n", "schema": { "type": "string", "format": "url" } }, "ETag_VERSION": { "description": "The `ETag` (i.e. entity tag) response header is the VERSION identifier (i.e. the `version_uid`) enclosed by double quotes.\n", "schema": { "type": "string" } }, "ETag_CONTRIBUTION": { "description": "The `ETag` (i.e. entity tag) response header is the `contribution_uid` identifier, enclosed by double quotes.\n", "schema": { "type": "string" } }, "Location_demographic_CONTRIBUTION": { "description": "The `Location` response header indicates the URL of the CONTRIBUTION resource.\n", "schema": { "type": "string", "format": "url" } } }, "responses": { "400": { "description": "`400 Bad Request` is returned when the request could not be parsed or is invalid (e.g. malformed request URL syntax, missing required header or parameter, or syntactically invalid header, parameter or content). \nThe response body MAY contain error details.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "`404 Not Found` is returned when, based on the request parameters, the server did not find a current representation of a target resource, or is not willing to disclose that one exists.\n" }, "409": { "description": "`409 Conflict` is returned when a resource with same identifier(s) already exists.\n" }, "422": { "description": "`422 Unprocessable Entity` is returned when the content type and syntax is correct, could be converted to a resource, but there are semantic validation errors, such as the underlying template is not known or is not validating the supplied resource.\n" }, "201_AGENT": { "description": "`201 Created` is returned when the AGENT is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_AGENT" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Agent" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "200_AGENT_retrieved": { "description": "`200 OK` is returned when the requested AGENT is successfully retrieved.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agent" } } } }, "204_deleted_at_time": { "description": "`204 No Content` is returned when the resource identified by the request parameters (at specified `version_at_time`) time has been deleted.\n" }, "404_not_found_or_no_version_at_time": { "description": "`404 Not Found` is returned when either the URL configured doesn't exist at all, or the targeted resource doesn't exist, or when a VERSION of the resource does not exist at the specified `version_at_time`.\n" }, "200_AGENT_updated": { "description": "`200 OK` is returned when the AGENT is successfully updated, with the full resource in the response body when `Prefer` header is `return=representation`, or only its identifiers when `Prefer` header is `return=identifier`.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_AGENT" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Agent" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "204_version_updated": { "description": "`204 No Content` is returned when the update operation was successful and the `Prefer` header is missing or is set to `return=minimal`.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_version" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } } }, "412_AGENT": { "description": "`412 Precondition Failed` is returned when `If-Match` request header doesn't match the latest version on the service side.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "204_version_deleted": { "description": "`204 No Content` is returned for a successful delete operation.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "400_already_deleted": { "description": "`400 Bad Request` is returned when the request could not be parsed or is invalid (e.g. malformed request URL syntax, missing required header or parameter, or syntactically invalid header, parameter or content) or when the resource identified by the request parameters is already deleted.\n" }, "409_AGENT_with_uid_based_id": { "description": "`409 Conflict` is returned when supplied `uid_based_id` doesn't match the latest version.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "201_GROUP": { "description": "`201 Created` is returned when the GROUP is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_GROUP" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Group" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "200_GROUP_retrieved": { "description": "`200 OK` is returned when the requested GROUP is successfully retrieved.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "200_GROUP_updated": { "description": "`200 OK` is returned when the GROUP is successfully updated, with the full resource in the response body when `Prefer` header is `return=representation`, or only its identifiers when `Prefer` header is `return=identifier`.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_GROUP" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Group" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "412_GROUP": { "description": "`412 Precondition Failed` is returned when `If-Match` request header doesn't match the latest version on the service side.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "409_GROUP_with_uid_based_id": { "description": "`409 Conflict` is returned when supplied `uid_based_id` doesn't match the latest version.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "201_ORGANISATION": { "description": "`201 Created` is returned when the ORGANISATION is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_ORGANISATION" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Organisation" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "200_ORGANISATION_retrieved": { "description": "`200 OK` is returned when the requested ORGANISATION is successfully retrieved.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Organisation" } } } }, "200_ORGANISATION_updated": { "description": "`200 OK` is returned when the ORGANISATION is successfully updated, with the full resource in the response body when `Prefer` header is `return=representation`, or only its identifiers when `Prefer` header is `return=identifier`.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_ORGANISATION" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Organisation" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "412_ORGANISATION": { "description": "`412 Precondition Failed` is returned when `If-Match` request header doesn't match the latest version on the service side.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "409_ORGANISATION_with_uid_based_id": { "description": "`409 Conflict` is returned when supplied `uid_based_id` doesn't match the latest version.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "201_PERSON": { "description": "`201 Created` is returned when the PERSON is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_PERSON" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Person" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "200_PERSON_retrieved": { "description": "`200 OK` is returned when the requested PERSON is successfully retrieved.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "200_PERSON_updated": { "description": "`200 OK` is returned when the PERSON is successfully updated, with the full resource in the response body when `Prefer` header is `return=representation`, or only its identifiers when `Prefer` header is `return=identifier`.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_PERSON" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Person" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "412_PERSON": { "description": "`412 Precondition Failed` is returned when `If-Match` request header doesn't match the latest version on the service side.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "409_PERSON_with_uid_based_id": { "description": "`409 Conflict` is returned when supplied `uid_based_id` doesn't match the latest version.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "201_ROLE": { "description": "`201 Created` is returned when the ROLE is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_ROLE" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Role" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "200_ROLE_retrieved": { "description": "`200 OK` is returned when the requested ROLE is successfully retrieved.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } }, "200_ROLE_updated": { "description": "`200 OK` is returned when the ROLE is successfully updated, with the full resource in the response body when `Prefer` header is `return=representation`, or only its identifiers when `Prefer` header is `return=identifier`.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_ROLE" }, "openehr-item-tag": { "$ref": "#/components/headers/openehr-item-tag" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Role" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "412_ROLE": { "description": "`412 Precondition Failed` is returned when `If-Match` request header doesn't match the latest version on the service side.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "409_ROLE_with_uid_based_id": { "description": "`409 Conflict` is returned when supplied `uid_based_id` doesn't match the latest version.\nReturns also latest `version_uid` in the `ETag` header.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } } }, "200_VERSIONED_PARTY": { "description": "`200 OK` is returned when the requested VERSIONED_PARTY is successfully retrieved.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VersionedParty" } } } }, "200_REVISION_HISTORY": { "description": "`200 OK` is returned when the requested REVISION_HISTORY is successfully retrieved.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevisionHistory" } } } }, "200_VERSION_of_PARTY_at_time": { "description": "`200 OK` is returned when the requested VERSION is successfully retrieved.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag_VERSION" }, "Location": { "$ref": "#/components/headers/Location_deprecated" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UVersionOfParty" } } } }, "200_VERSION_of_PARTY_by_id": { "description": "`200 OK` is returned when the requested VERSION is successfully retrieved.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UVersionOfParty" } } } }, "201_demographic_CONTRIBUTION": { "description": "`201 Created` is returned when the CONTRIBUTION is successfully created. \nIf `Prefer` header is `return=representation`, the full resource is included in the response body; if is `return=identifier`, only its unique identifier is included. \nIf the `Prefer` header is missing or set to `return=minimal`, the body is empty.\n", "headers": { "ETag": { "$ref": "#/components/headers/ETag_CONTRIBUTION" }, "Location": { "$ref": "#/components/headers/Location_demographic_CONTRIBUTION" } }, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/Contribution" }, { "$ref": "#/components/schemas/Identifier" } ] } } } }, "400_CONTRIBUTION": { "description": "`400 Bad Request` is returned when the request could not be parsed or is invalid (e.g. malformed request URL syntax, missing required header or parameter, or syntactically invalid header, parameter or content, or the modification type does not match the operation - i.e. first version of a MODIFICATION).\nThe response body MAY contain error details.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "200_CONTRIBUTION": { "description": "`200 OK` is returned when the CONTRIBUTION is successfully retrieved.\n", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contribution" } } } }, "404_demographic_CONTRIBUTION": { "description": "`404 Not Found` is returned when a CONTRIBUTION with `contribution_uid` does not exist.\n" }, "200_DEMOGRAPHIC_tags_list": { "description": "`200 OK` is returned with the list of all matching ITEM_TAG resources across every demographic\ntarget. Returns an empty list when no tags match. Each entry includes the `target` it is\nattached to and the demographic system as `owner_id`.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/ItemTagOfAgent" }, { "$ref": "#/components/schemas/ItemTagOfGroup" }, { "$ref": "#/components/schemas/ItemTagOfOrganisation" }, { "$ref": "#/components/schemas/ItemTagOfPerson" }, { "$ref": "#/components/schemas/ItemTagOfRole" } ] } } } } }, "200_AGENT_tags_list": { "description": "`200 OK` is returned with the list of ITEM_TAG resources associated with the target AGENT.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagOfAgent" } } } } }, "200_GROUP_tags_list": { "description": "`200 OK` is returned with the list of ITEM_TAG resources associated with the target GROUP.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagOfGroup" } } } } }, "200_ORGANISATION_tags_list": { "description": "`200 OK` is returned with the list of ITEM_TAG resources associated with the target ORGANISATION.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagOfOrganisation" } } } } }, "200_PERSON_tags_list": { "description": "`200 OK` is returned with the list of ITEM_TAG resources associated with the target PERSON.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagOfPerson" } } } } }, "200_ROLE_tags_list": { "description": "`200 OK` is returned with the list of ITEM_TAG resources associated with the target ROLE.\n", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTagOfRole" } } } } }, "204_tags_updated": { "description": "`204 No Content` is returned when the tag list was successfully replaced and the\n`Prefer` header is missing or set to `return=minimal`.\n" }, "204_tag_deleted": { "description": "`204 No Content` is returned when the ITEM_TAG with the supplied `key` was successfully deleted.\n" } } }, "x-ext-urls": {} }