How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
openEHR

openEHR Demographic API

Party, role and demographic data handling. Published but marked DEVELOPMENT by openEHR. openEHR SPECIFICATION, not a callable service — 42 operation(s) across 27 path(s), served from the templated host `https://{baseUrl}/v1`.

Documentation Provider Profile APIs.io OpenAPI GitHub

openEHR Demographic API is one of 6 APIs that openEHR publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include openEHR, Healthcare, EHR, and Specification. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 42 operations across 27 paths, organized into 8 resource areas, and defines 104 schemas. It is described by OpenAPI 3.0.3, at version development.

Requests are made against a single base URL, https://{baseUrl}/v1.

42 operations 27 paths 104 schemas 10 DELETE16 GET6 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
development
Server
https://{baseUrl}/v1
Contact
Specifications Editorial Committee openEHR
License
Creative Commons Attribution-NoDerivs 3.0 Unported
Resource Areas
8

Paths & Operations 42

Across 27 paths, the API surfaces 42 operations — 10 DELETE, 16 GET, 6 POST, 10 PUT. They span 8 resource areas: AGENT, GROUP, ORGANISATION, PERSON, ROLE, VERSIONED_PARTY, CONTRIBUTION, ITEM_TAG. Each is listed below with its method, path, parameters, and response codes.

AGENT 4

Management of the [AGENT](https://specifications.openehr.org/releases/RM/latest/demographic.htmlagentclass) class.

POST
/demographic/agent
Create AGENT
agent_create 5 params body → 201400404422
GET
/demographic/agent/{uid_based_id}
Get AGENT
agent_get 3 params → 200204404
PUT
/demographic/agent/{uid_based_id}
Update AGENT
agent_update 6 params body → 200204400404412422
DELETE
/demographic/agent/{uid_based_id}
Delete AGENT
agent_delete 1 param → 204400404409
GROUP 4

Management of the [GROUP](https://specifications.openehr.org/releases/RM/latest/demographic.htmlgroupclass) class.

POST
/demographic/group
Create GROUP
group_create 5 params body → 201400404422
GET
/demographic/group/{uid_based_id}
Get GROUP
group_get 3 params → 200204404
PUT
/demographic/group/{uid_based_id}
Update GROUP
group_update 6 params body → 200204400404412422
DELETE
/demographic/group/{uid_based_id}
Delete GROUP
group_delete 1 param → 204400404409
ORGANISATION 4

Management of the [ORGANISATION](https://specifications.openehr.org/releases/RM/latest/demographic.htmlorganisationclass) class.

POST
/demographic/organisation
Create ORGANISATION
organisation_create 5 params body → 201400404422
GET
/demographic/organisation/{uid_based_id}
Get ORGANISATION
organisation_get 3 params → 200204404
PUT
/demographic/organisation/{uid_based_id}
Update ORGANISATION
organisation_update 6 params body → 200204400404412422
DELETE
/demographic/organisation/{uid_based_id}
Delete ORGANISATION
organisation_delete 1 param → 204400404409
PERSON 4

Management of the [PERSON](https://specifications.openehr.org/releases/RM/latest/demographic.htmlpersonclass) class.

POST
/demographic/person
Create PERSON
person_create 5 params body → 201400404422
GET
/demographic/person/{uid_based_id}
Get PERSON
person_get 3 params → 200204404
PUT
/demographic/person/{uid_based_id}
Update PERSON
person_update 6 params body → 200204400404412422
DELETE
/demographic/person/{uid_based_id}
Delete PERSON
person_delete 1 param → 204400404409
ROLE 4

Management of the [ROLE](https://specifications.openehr.org/releases/RM/latest/demographic.htmlroleclass) class.

POST
/demographic/role
Create ROLE
role_create 5 params body → 201400404422
GET
/demographic/role/{uid_based_id}
Get ROLE
role_get 3 params → 200204404
PUT
/demographic/role/{uid_based_id}
Update ROLE
role_update 6 params body → 200204400404412422
DELETE
/demographic/role/{uid_based_id}
Delete ROLE
role_delete 1 param → 204400404409
VERSIONED_PARTY 4

Management of the [VERSIONEDPARTY](https://specifications.openehr.org/releases/RM/latest/demographic.htmlversionedpartyclass) class.

GET
/demographic/versioned_party/{versioned_object_uid}
Get VERSIONEDPARTY
versioned_party_get 3 params → 200404
GET
/demographic/versioned_party/{versioned_object_uid}/revision_history
Get VERSIONEDPARTY revision history
versioned_party_revision_history 3 params → 200404
GET
/demographic/versioned_party/{versioned_object_uid}/version
Get VERSIONEDPARTY version at time
versioned_party_version_get_at_time 4 params → 200404
GET
/demographic/versioned_party/{versioned_object_uid}/version/{version_uid}
Get VERSIONEDPARTY version by id
versioned_party_version_get_by_id 4 params → 200404
CONTRIBUTION 2

Management of [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.htmlcontributionclass) class.

POST
/demographic/contribution
Create CONTRIBUTION
contribution_create 3 params body → 201400409
GET
/demographic/contribution/{contribution_uid}
Get CONTRIBUTION by id
contribution_get 2 params → 200404
ITEM_TAG 16

Management of [ITEMTAG](https://specifications.openehr.org/releases/RM/development/common.htmlitemtagclass) resources.

GET
/demographic/tags
Get Demographic tags
demographic_tags_get 4 params → 200400
GET
/demographic/agent/{uid_based_id}/tags
Get AGENT tags
agent_tags_get 2 params → 200404
PUT
/demographic/agent/{uid_based_id}/tags
Update AGENT tags
agent_tags_update 4 params body → 200204400404
DELETE
/demographic/agent/{uid_based_id}/tags/{key}
Delete AGENT tags
agent_tags_delete 2 params → 204404
GET
/demographic/group/{uid_based_id}/tags
Get GROUP tags
group_tags_get 2 params → 200404
PUT
/demographic/group/{uid_based_id}/tags
Update GROUP tags
group_tags_update 4 params body → 200204400404
DELETE
/demographic/group/{uid_based_id}/tags/{key}
Delete GROUP tags
group_tags_delete 2 params → 204404
GET
/demographic/organisation/{uid_based_id}/tags
Get ORGANISATION tags
organisation_tags_get 2 params → 200404
PUT
/demographic/organisation/{uid_based_id}/tags
Update ORGANISATION tags
organisation_tags_update 4 params body → 200204400404
DELETE
/demographic/organisation/{uid_based_id}/tags/{key}
Delete ORGANISATION tags
organisation_tags_delete 2 params → 204404
GET
/demographic/person/{uid_based_id}/tags
Get PERSON tags
person_tags_get 2 params → 200404
PUT
/demographic/person/{uid_based_id}/tags
Update PERSON tags
person_tags_update 4 params body → 200204400404
DELETE
/demographic/person/{uid_based_id}/tags/{key}
Delete PERSON tags
person_tags_delete 2 params → 204404
GET
/demographic/role/{uid_based_id}/tags
Get ROLE tags
role_tags_get 2 params → 200404
PUT
/demographic/role/{uid_based_id}/tags
Update ROLE tags
role_tags_update 4 params body → 200204400404
DELETE
/demographic/role/{uid_based_id}/tags/{key}
Delete ROLE tags
role_tags_delete 2 params → 204404

Schemas 104

The contract defines 104 schemas that model the data the API accepts and returns. The most detailed are UMRole (14 properties), Role (14 properties), Group (13 properties), Organisation (13 properties). Each schema is shown below with its type and property counts.

UpdateItemTag
object
3 properties 1 required
UMDvUri
object
2 properties 2 required
DvEhrUri
object
2 properties 1 required
UMDvEhrUri
object
2 properties 2 required
UDvUri
object
TerminologyId
object
2 properties 1 required
CodePhrase
object
3 properties 2 required
DvCodedText
object
8 properties 2 required
TermMapping
object
3 properties 2 required
UMDvText
object
7 properties 2 required
UMDvCodedText
object
8 properties 3 required
UDvText
object
HierObjectId
object
2 properties 1 required
UMHierObjectId
object
2 properties 2 required
ObjectVersionId
object
2 properties 1 required
UMObjectVersionId
object
2 properties 2 required
UUidBasedId
object
Link
object
3 properties 3 required
ArchetypeId
object
2 properties 1 required
TemplateId
object
2 properties 1 required
Archetyped
object
3 properties 2 required
DvIdentifier
object
Type for representing identifiers of real-world entities. Typical identifiers include drivers licence number, social security number, veterans affairs number,…
5 properties 1 required
DvMultimedia
object
12 properties 3 required
UMDvMultimedia
object
12 properties 3 required
UMDvParsable
object
5 properties 3 required
UDvEncapsulated
object
PartyRef
object
Identifier for parties in a demographic or identity service.
3 properties 3 required
UMPartyIdentified
object
4 properties 1 required
UMPartyRelated
object
5 properties 2 required
UPartyIdentified
object
UMPartySelf
object
2 properties 1 required
UPartyProxy
object
DvInterval
object
5 properties 4 required
ReferenceRange
object
2 properties 2 required
DvDuration
object
8 properties 1 required
DvDateTime
object
7 properties 1 required
UMDvBoolean
object
2 properties 2 required
UMDvCount
object
8 properties 2 required
UMDvDate
object
7 properties 2 required
UMDvDateTime
object
7 properties 2 required
UMDvDuration
object
8 properties 2 required
UMDvIdentifier
object
5 properties 2 required
UMDvOrdinal
object
6 properties 3 required
UMDvProportion
object
11 properties 4 required
UMDvQuantity
object
12 properties 3 required
UMDvScale
object
6 properties 3 required
UMDvState
object
3 properties 3 required
UMDvTime
object
7 properties 2 required
UDataValue
object
Element
object
10 properties 2 required
ItemSingle
object
8 properties 3 required
ItemList
object
8 properties 2 required
Clstr
object
8 properties 3 required
UItem
object
ItemTable
object
8 properties 2 required
ItemTree
object
8 properties 2 required
UItemStructure
object
FeederAuditDetails
object
7 properties 1 required
FeederAudit
object
5 properties 1 required
PartyIdentity
object
8 properties 3 required
ListOfPartyIdentity
array
Address
object
8 properties 3 required
DvIntervalOfDate
object
7 properties 4 required
Contact
object
9 properties 3 required
ListOfContact
array
PartyRelationship
object
11 properties 4 required
ListOfPartyRelationship
array
Agent
object
13 properties 3 required
Identifier
object
1 property 1 required
Error
object
2 properties 2 required
Group
object
13 properties 3 required
Organisation
object
13 properties 3 required
Person
object
13 properties 3 required
Capability
object
9 properties 3 required
ListOfCapability
array
Role
object
14 properties 4 required
ObjectRefOfHierObjectId
object
3 properties 3 required
VersionedParty
object
A VERSIONEDPARTY resource
4 properties 3 required
AuditDetails
object
The set of attributes required to document the committal of an information item to a repository.
6 properties 4 required
RevisionHistoryItem
object
A REVISIONHISTORYITEM resource
2 properties 2 required
RevisionHistory
object
A REVISIONHISTORY resource
1 property 1 required
UMAgent
object
13 properties 4 required
UMGroup
object
13 properties 4 required
UMOrganisation
object
13 properties 4 required
UMPerson
object
13 properties 4 required
UMRole
object
14 properties 5 required
UVersionable
object
Attestation
object
11 properties 6 required
UParty
object
UMOriginalVersionOfParty
object
10 properties 6 required
UMImportedVersionOfParty
object
6 properties 5 required
UVersionOfParty
object
UpdateAudit
object
The set of attributes required to document the committal of an information item to a repository. UPDATEAUDIT is a REST commit DTO, not an RM class: structurall…
5 properties 2 required
UpdateAttestation
object
10 properties 4 required
UpdateVersion
object
6 properties 3 required
NewContribution
object
A new (un-committed) CONTRIBUTION resource for Demographic
3 properties 2 required
ObjectRefOfObjectVersionId
object
3 properties 3 required
Contribution
object
A CONTRIBUTION resource
3 properties 3 required
UObjectRefOfUidBasedId
object
3 properties 3 required
ItemTagOfPerson
object
5 properties 3 required
ItemTagOfAgent
object
5 properties 3 required
ItemTagOfGroup
object
5 properties 3 required
ItemTagOfOrganisation
object
5 properties 3 required
ItemTagOfRole
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openehr-demographic-openapi.yml Raw ↑

Other APIs openEHR publishes across the network.

openEHR EHR API
AE Profile APIs.io
openEHR Query API
AE Profile APIs.io
openEHR Definition API
AE Profile APIs.io
openEHR System API
AE Profile APIs.io
openEHR Admin API
AE Profile APIs.io
#openEHR#Healthcare#EHR#Specification
← Back to O APIs
API Details
ID
openehr:demographic
Server
https://{baseUrl}/v1
Docs
https://specifications.openehr.org/releases/ITS-REST/latest/demographic.html
Provider
openEHR
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=demographic&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/demographic"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of openEHR Demographic API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.