Demographic API (development)
Purpose
This specification describes service endpoints, resources and operations as well as details of requests and responses that interacts with Demographic openEHR API in a RESTful manner.
Related Documents
Prerequisite documents for reading this document include:
Related documents include:
- The openEHR Architecture Overview
- The openEHR Global Class Index
- The XML-Schemas (XSD)
- The JSON-Schemas and Simplified Data Template (SDT)
- The openEHR Platform Abstract Service Model
Status
This specification is in the DEVELOPMENT
state, and can be downloaded as OpenAPI specification file (in YAML format) for validation, or for code generators.
Users are encouraged to comment on and/or advise on these paragraphs as well as the main content.
The development version of this document can be found at https://specifications.openehr.org/releases/ITS-REST/development/demographic.html.
Management of the AGENT class.
Create AGENT
Creates the first version of a new AGENT.
header Parameters
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The AGENT.
_type | string Value: "AGENT" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 201
- 400
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Get AGENT
Retrieves a version of the AGENT identified by uid_based_id
.
The uid_based_id
can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid
), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid
).
The former is used to retrieve a specific known version of the AGENT (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.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).
When 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.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Update AGENT
Updates AGENT identified by uid_based_id
.
The 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
).
If the request body already contains a AGENT.uid.value, it must match the uid_based_id
in the URL.
The existing latest version_uid
of AGENT resource (i.e. the preceding_version_uid
) must be specified in the If-Match
header.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new AGENT.
_type | string Value: "AGENT" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 200
- 400
{- "_type": "AGENT",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Delete AGENT
Deletes the AGENT identified by uid_based_id
.
The 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.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Management of the GROUP class.
Create GROUP
Creates the first version of a new GROUP.
header Parameters
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The GROUP.
_type | string Value: "GROUP" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 201
- 400
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Get GROUP
Retrieves a version of the GROUP identified by uid_based_id
.
The uid_based_id
can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid
), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid
).
The former is used to retrieve a specific known version of the GROUP (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.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).
When 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.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Update GROUP
Updates GROUP identified by uid_based_id
.
The 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
).
If the request body already contains a GROUP.uid.value, it must match the uid_based_id
in the URL.
The existing latest version_uid
of GROUP resource (i.e. the preceding_version_uid
) must be specified in the If-Match
header.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new GROUP.
_type | string Value: "GROUP" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 200
- 400
{- "_type": "GROUP",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Delete GROUP
Deletes the GROUP identified by uid_based_id
.
The 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.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Management of the ORGANISATION class.
Create ORGANISATION
Creates the first version of a new ORGANISATION.
header Parameters
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The ORGANISATION.
_type | string Value: "ORGANISATION" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 201
- 400
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Get ORGANISATION
Retrieves a version of the ORGANISATION identified by uid_based_id
.
The uid_based_id
can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid
), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid
).
The former is used to retrieve a specific known version of the ORGANISATION (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.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).
When 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.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Update ORGANISATION
Updates ORGANISATION identified by uid_based_id
.
The 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
).
If the request body already contains a ORGANISATION.uid.value, it must match the uid_based_id
in the URL.
The existing latest version_uid
of ORGANISATION resource (i.e. the preceding_version_uid
) must be specified in the If-Match
header.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new ORGANISATION.
_type | string Value: "ORGANISATION" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 200
- 400
{- "_type": "ORGANISATION",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Delete ORGANISATION
Deletes the ORGANISATION identified by uid_based_id
.
The 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.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An identifier in a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
Responses
Management of the PERSON class.
Create PERSON
Creates the first version of a new PERSON.
header Parameters
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The PERSON.
_type | string Value: "PERSON" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |
object (FEEDER_AUDIT) | |
identities required | Array of objects (PARTY_IDENTITY) See PARTY_IDENTITY schema details. |
contacts | Array of objects (CONTACT) See CONTACT schema details. |
details | object (ITEM_STRUCTURE) See ITEM_STRUCTURE schema details. |
relationships | Array of objects (PARTY_RELATIONSHIP) See PARTY_RELATIONSHIP schema details. |
Array of objects (DV_TEXT) | |
Array of objects (PARTY_REF) |
Responses
Request samples
- Payload
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Response samples
- 201
- 400
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Get PERSON
Retrieves a version of the PERSON identified by uid_based_id
.
The uid_based_id
can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a version_uid
), or a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a versioned_object_uid
).
The former is used to retrieve a specific known version of the PERSON (e.g. one identified by 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.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).
When 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.
See Resource identification for more details about the identifiers usage and meaning.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515::openEHRSys.example.com::1 An abstract identifier: it can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value (i.e. a |
query Parameters
version_at_time | string Example: version_at_time=2015-01-20T19:30:22.765+01:00 A given time in the extended ISO 8601 format. |
Responses
Response samples
- 200
{- "_type": "PERSON",
- "name": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "archetype_node_id": "string",
- "uid": {
- "_type": "HIER_OBJECT_ID",
- "value": "6cb19121-4307-4648-9da0-d62e4d51f19b"
}, - "links": [
- {
- "meaning": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "type": {
- "_type": "DV_TEXT",
- "value": "Text value"
}, - "target": {
- "_type": "DV_EHR_URI",
- "value": "ehr://system_id/ehr_id/top_level_structure_locator/path_inside_top_level_structure"
}
}
], - "archetype_details": {
- "archetype_id": {
- "value": "openEHR-EHR-COMPOSITION.encounter.v1"
}, - "template_id": {
- "value": "Example.v1::c7ec861c-c413-39ff-9965-a198ebf44747"
}, - "rm_version": "1.0.2"
}, - "feeder_audit": {
- "originating_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "feeder_system_item_ids": [
- {
- "id": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "type": "Patient"
}
], - "original_content": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": {
- "_type": "DV_MULTIMEDIA",
- "charset": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "language": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "alternate_text": "string",
- "data": "string",
- "media_type": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "compression_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "integrity_check": "string",
- "integrity_check_algorithm": {
- "terminology_id": {
- "value": "local"
}, - "code_string": "at0001"
}, - "thumbnail": { },
- "size": 0
}, - "size": 0
}, - "originating_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}, - "feeder_system_audit": {
- "system_id": "string",
- "location": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "subject": {
- "_type": "PARTY_SELF",
- "external_ref": {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
}, - "provider": {
- "_type": "PARTY_IDENTIFIED",
- "external_ref": {
- "id": {
- "_type": "GENERIC_ID",
- "value": "16b74749-e6aa-4945-b760-b42bdc07098a",
- "scheme": "pid"
}, - "namespace": "openEHRSys.example.com",
- "type": "PERSON"
}, - "name": "A name"
}, - "time": {
- "_type": "DV_DATE_TIME",
- "value": "2017-08-15T10:37:15.422+02:00"
}, - "version_id": "string",
- "other_details": { }
}
}, - "identities": [
- { }
], - "contacts": [
- { }
], - "details": { },
- "relationships": [
- { }
], - "languages": [
- {
- "_type": "DV_TEXT",
- "value": "Text value"
}
], - "roles": [
- {
- "id": {
- "_type": "HIER_OBJECT_ID",
- "value": "b52b9408-7048-4ec8-94bd-831fb0727e67"
}, - "namespace": "local",
- "type": "PERSON"
}
]
}
Update PERSON
Updates PERSON identified by uid_based_id
.
The 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
).
If the request body already contains a PERSON.uid.value, it must match the uid_based_id
in the URL.
The existing latest version_uid
of PERSON resource (i.e. the preceding_version_uid
) must be specified in the If-Match
header.
path Parameters
uid_based_id required | string Example: 8849182c-82ad-4088-a07f-48ead4180515 An identifier in a form of a HIER_OBJECT_ID identifier taken from VERSIONED_OBJECT.uid.value (i.e. a |
header Parameters
If-Match required | string Example: "6cb19121-4307-4648-9da0-d62e4d51f19b::openEHRSys.example.com::1" Header to make the request conditional.
Together with |
Prefer | string Default: return=minimal Enum: "return=representation" "return=minimal" Request header to indicate the preference over response details.
The response will contain the entire resource when the |
Request Body schema: application/jsonrequired
The new PERSON.
_type | string Value: "PERSON" |
required | object (DV_TEXT) |
archetype_node_id required | string |
object (UID_BASED_ID) | |
Array of objects (LINK) | |
object (ARCHETYPED) | |