openEHR Demographic API
Description Purpose This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Description
Purpose
This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with the openEHR Demographic 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 Formats](simplified_formats.html)
Status
This specification is in the DEVELOPMENT state, and can be downloaded as OpenAPI specification file (in YAML format) [for validation](computable/OAS/demographic-validation.openapi.yaml), or [for code generators](computable/OAS/demographic-codegen.openapi.yaml).
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 .
Endpoints 42
AGENT
- POSTCreate AGENT
/demographic/agentCreates the first version of a new AGENT. A list of ITEM_TAGs can be associated with the AGENT, in which case a openehr-item-tag or openehr-version-item-tag… - GETGet AGENT
/demographic/agent/:uid_based_idRetrieves 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… - PUTUpdate AGENT
/demographic/agent/:uid_based_idUpdates 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… - DELETEDelete AGENT
/demographic/agent/:uid_based_idDeletes 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)…
GROUP
- POSTCreate GROUP
/demographic/groupCreates the first version of a new GROUP. A list of ITEM_TAGs can be associated with the GROUP, in which case a openehr-item-tag or openehr-version-item-tag… - GETGet GROUP
/demographic/group/:uid_based_idRetrieves 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… - PUTUpdate GROUP
/demographic/group/:uid_based_idUpdates 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… - DELETEDelete GROUP
/demographic/group/:uid_based_idDeletes 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)…
ORGANISATION
- POSTCreate ORGANISATION
/demographic/organisationCreates the first version of a new ORGANISATION. A list of ITEM_TAGs can be associated with the ORGANISATION, in which case a openehr-item-tag or… - GETGet ORGANISATION
/demographic/organisation/:uid_based_idRetrieves 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… - PUTUpdate ORGANISATION
/demographic/organisation/:uid_based_idUpdates 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… - DELETEDelete ORGANISATION
/demographic/organisation/:uid_based_idDeletes 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)…
PERSON
- POSTCreate PERSON
/demographic/personCreates the first version of a new PERSON. A list of ITEM_TAGs can be associated with the PERSON, in which case a openehr-item-tag or openehr-version-item-tag… - GETGet PERSON
/demographic/person/:uid_based_idRetrieves 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… - PUTUpdate PERSON
/demographic/person/:uid_based_idUpdates 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… - DELETEDelete PERSON
/demographic/person/:uid_based_idDeletes the PERSON 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)…
ROLE
- POSTCreate ROLE
/demographic/roleCreates the first version of a new ROLE. A list of ITEM_TAGs can be associated with the ROLE, in which case a openehr-item-tag or openehr-version-item-tag… - GETGet ROLE
/demographic/role/:uid_based_idRetrieves a version of the ROLE identified by uid_based_id. The uid_based_id can take a form of an OBJECT_VERSION_ID identifier taken from VERSION.uid.value… - PUTUpdate ROLE
/demographic/role/:uid_based_idUpdates ROLE 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… - DELETEDelete ROLE
/demographic/role/:uid_based_idDeletes the ROLE 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)…
VERSIONED_PARTY
- GETGet VERSIONED_PARTY
/demographic/versioned_party/:versioned_object_uidRetrieves a VERSIONED_PARTY identified by versioned_object_uid. - GETGet VERSIONED_PARTY revision history
/demographic/versioned_party/:versioned_object_uid/revision_historyRetrieves revision history of the VERSIONED_PARTY identified by versioned_object_uid. - GETGet PARTY version at time
/demographic/versioned_party/:versioned_object_uid/versionRetrieves a VERSION from the VERSIONED_PARTY identified by versioned_object_uid. If version_at_time is supplied, retrieves the VERSION extant _at specified… - GETGet PARTY version by version id
/demographic/versioned_party/:versioned_object_uid/version/:version_uidRetrieves a VERSION identified by version_uid of a VERSIONED_PARTY identified by versioned_object_uid.
CONTRIBUTION
- POSTCreate CONTRIBUTION
/demographic/contributionWe will use the relaxed CONTRIBUTION with the following optional attributes: uid: when provided, it will be accepted in case is not in-use, otherwise error… - GETGet CONTRIBUTION by id
/demographic/contribution/:contribution_uidRetrieves a CONTRIBUTION identified by contribution_uid.
ITEM_TAG
- GETGet Demographic tags
/demographic/tagsRetrieves the list of ITEM_TAG resources associated with any target VERSION or VERSIONED_PARTY within the Demographic space. This list can be filtered by the… - GETGet AGENT tags
/demographic/agent/:uid_based_id/tagsRetrieves the list of all ITEM_TAG resources associated with a given target AGENT version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - PUTUpdate AGENT tags
/demographic/agent/:uid_based_id/tagsUpdates the list of all ITEM_TAG resources associated with a given target AGENT version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - DELETEDelete AGENT tags
/demographic/agent/:uid_based_id/tags/:keyDeletes the ITEM_TAG resource(s) identified by tag_key, associated with a given target AGENT version or VERSIONED_PARTY identified by uid_based_id. The… - GETGet GROUP tags
/demographic/group/:uid_based_id/tagsRetrieves the list of all ITEM_TAG resources associated with a given target GROUP version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - PUTUpdate GROUP tags
/demographic/group/:uid_based_id/tagsUpdates the list of all ITEM_TAG resources associated with a given target GROUP version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - DELETEDelete GROUP tags
/demographic/group/:uid_based_id/tags/:keyDeletes the ITEM_TAG resource(s) identified by tag_key, associated with a given target GROUP version or VERSIONED_PARTY identified by uid_based_id. The… - GETGet ORGANISATION tags
/demographic/organisation/:uid_based_id/tagsRetrieves the list of all ITEM_TAG resources associated with a given target ORGANISATION version or VERSIONED_PARTY identified by uid_based_id. The… - PUTUpdate ORGANISATION tags
/demographic/organisation/:uid_based_id/tagsUpdates the list of all ITEM_TAG resources associated with a given target ORGANISATION version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id… - DELETEDelete ORGANISATION tags
/demographic/organisation/:uid_based_id/tags/:keyDeletes the ITEM_TAG resource(s) identified by tag_key, associated with a given target ORGANISATION version or VERSIONED_PARTY identified by uid_based_id. The… - GETGet PERSON tags
/demographic/person/:uid_based_id/tagsRetrieves the list of all ITEM_TAG resources associated with a given target PERSON version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - PUTUpdate PERSON tags
/demographic/person/:uid_based_id/tagsUpdates the list of all ITEM_TAG resources associated with a given target PERSON version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - DELETEDelete PERSON tags
/demographic/person/:uid_based_id/tags/:keyDeletes the ITEM_TAG resource(s) identified by tag_key, associated with a given target PERSON version or VERSIONED_PARTY identified by uid_based_id. The… - GETGet ROLE tags
/demographic/role/:uid_based_id/tagsRetrieves the list of all ITEM_TAG resources associated with a given target ROLE version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - PUTUpdate ROLE tags
/demographic/role/:uid_based_id/tagsUpdates the list of all ITEM_TAG resources associated with a given target ROLE version or VERSIONED_PARTY identified by uid_based_id. The uid_based_id can… - DELETEDelete ROLE tags
/demographic/role/:uid_based_id/tags/:keyDeletes the ITEM_TAG resource(s) identified by tag_key, associated with a given target ROLE version or VERSIONED_PARTY identified by uid_based_id. The…
API details
- Base URL
https://{baseUrl}/v1- Authentication
- None declared in the description
- Operations
- 42 operations on 27 pathsGET 16PUT 10DELETE 10POST 6
- Main resources
- ITEM_TAG 16AGENT 4GROUP 4ORGANISATION 4PERSON 4ROLE 4VERSIONED_PARTY 4CONTRIBUTION 2
- Description format
- OpenAPI 3.0.3, API version
development - Links
- OpenAPI document · Support
- Listed from
- openEHR's published OpenAPI description (openEHR/specifications-ITS-REST) (Apache-2.0)
How to test the openEHR Demographic API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the openEHR Demographic API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Create AGENT” (POST /demographic/agent), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the openEHR Demographic API?
Description Purpose This specification describes service endpoints, resources and operations as well as details of requests and responses that interact with… It is listed under Healthcare and has 42 endpoints.
Who publishes the openEHR Demographic API?
It is listed from openEHR's public API description (an OpenAPI document), not published by openEHR on Swastik Codes. Anyone who controls openehr.org can claim the profile by adding a DNS TXT record.
What is the base URL of the openEHR Demographic API?
Requests go to https://{baseUrl}/v1. Endpoint paths are added to this base URL.
How do I authenticate with the openEHR Demographic API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the openEHR Demographic API have?
42 operations on 27 paths (16 GET, 10 PUT, 10 DELETE, 6 POST). The largest groups are ITEM_TAG, AGENT, GROUP, ORGANISATION.
Is forking the openEHR Demographic API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.