Admin API (1.0.0)

Download OpenAPI specification:Download

Overview

Purpose

This specification describes service endpoints, resources and operations as well as details of requests and responses that interacts with EHR openEHR API in a RESTful manner.

Status

This specification is in the STABLE 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/latest/ehr.html.

Composition

Delete Composition

Removes a composition and all related and not otherwise referenced data from EHRbase

path Parameters

ehr_id required	string
composition_id required	string Example: {{last_composition_id_short}}

Responses

EHR

Administrative routes for EHRs

Update EHR

Sends new data for a specific EHR entry which will replace the old content of this EHR withour history entries

path Parameters

ehr_id

required

string

Example: {{ehr_id}}

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Delete EHR

Removes and EHR phyically from the database. All corresponding resources will also be removed including all history entries.

path Parameters

ehr_id

required

string

Example: {{ehr_id}}

Responses

Contribution

Update Contribution

Replaces the content of a Contribution with the new data sent with the request

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{ }

Template

Update template

Updated a given template by replacing the content of the template by the new sent data. If there is still data referencing the template the request will be rejected

path Parameters

template_id

required

string

Example: International Patient Summary

Responses

Delete template

Removes a given template from database physically. If there is still data referencing the template the request will be rejected

path Parameters

template_id

required

string

Example: International Patient Summary

Responses

Delete all templates

Deletes all templates from database physically if there were no more Compositions referencing templates.

Responses

Query

Delete Stored Query Version

Deletes a stored query version

path Parameters

qualified_query_name required	string Example: org.ehrbase::compositions_with_high_blood_pressure
version required	string Example: 1.0.0

Responses

Status & Management

Admin API status

Get the admin api status

Responses

EHR-Merge

Merge a source EHR into an existing target EHR

Request Body schema: application/json
required

reversible required	boolean
source_ehr required	string <uuid>
target_ehr required	string <uuid>
detail_level	string Value: "BASIC"
dry_run	boolean

Responses

Request samples

Payload

Content type

application/json

{"reversible": true,
"source_ehr": "e41451f3-ce0a-41b1-8452-c636cac1e6f5",
"target_ehr": "097716e6-03df-4e2e-938b-1cedb015bb9f",
"detail_level": "BASIC",
"dry_run": true
}

Response samples

Content type

application/json

{"outcome": {"level": "BASIC",
"summary": "string"
},
"source_ehr": "e41451f3-ce0a-41b1-8452-c636cac1e6f5",
"target_ehr": "097716e6-03df-4e2e-938b-1cedb015bb9f",
"merge_date": "2019-08-24T14:15:22Z",
"unmerge_data": {"contributions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"compositions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"folders": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"data": {"name": {"value": "string",
"hyperlink": {"value": "http://example.com"
},
"formatting": "string",
"mappings": [{"match": null,
"purpose": null,
"target": null
}
],
"language": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
},
"encoding": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
}
},
"archetypeNodeId": "string",
"uid": {"value": "string"
},
"archetypeDetails": {"archetypeId": {"specialisation": "string",
"versionId": "string",
"value": "string",
"namespace": "string",
"qualifiedRmEntity": "string",
"domainConcept": "string",
"rmOriginator": "string",
"rmName": "string",
"rmEntity": "string",
"semanticId": "string",
"fullId": "string"
},
"templateId": {"value": "string"
},
"rmVersion": "string"
},
"feederAudit": {"originatingSystemItemIds": [{"issuer": null,
"assigner": null,
"id": null,
"type": null
}
],
"feederSystemItemIds": [{"issuer": null,
"assigner": null,
"id": null,
"type": null
}
],
"originalContent": {"charset": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"originatingSystemAudit": {"systemId": "string",
"location": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"provider": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"subject": {"externalRef": null
},
"time": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"value": { }
},
"versionId": "string",
"otherDetails": {"name": null,
"archetypeNodeId": null,
"uid": null,
"archetypeDetails": null,
"feederAudit": null,
"links": [ ],
"items": [ ],
"path": null
}
},
"feederSystemAudit": {"systemId": "string",
"location": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"provider": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"subject": {"externalRef": null
},
"time": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"value": { }
},
"versionId": "string",
"otherDetails": {"name": null,
"archetypeNodeId": null,
"uid": null,
"archetypeDetails": null,
"feederAudit": null,
"links": [ ],
"items": [ ],
"path": null
}
}
},
"links": [{"meaning": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"type": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"target": {"value": null
}
}
],
"path": "string"
},
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd"
}
]
}
],
"ehr_creation": "2019-08-24T14:15:22Z",
"ehr_status": {"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"data": {"name": {"value": "string",
"hyperlink": {"value": "http://example.com"
},
"formatting": "string",
"mappings": [{"match": "string",
"purpose": {"value": null,
"hyperlink": null,
"formatting": null,
"language": null,
"encoding": null,
"definingCode": null
},
"target": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
}
],
"language": {"terminologyId": {"value": "string"
},
"codeString": "string",
"preferredTerm": "string"
},
"encoding": {"terminologyId": {"value": "string"
},
"codeString": "string",
"preferredTerm": "string"
}
},
"archetypeNodeId": "string",
"uid": {"value": "string"
},
"archetypeDetails": {"archetypeId": {"specialisation": "string",
"versionId": "string",
"value": "string",
"namespace": "string",
"qualifiedRmEntity": "string",
"domainConcept": "string",
"rmOriginator": "string",
"rmName": "string",
"rmEntity": "string",
"semanticId": "string",
"fullId": "string"
},
"templateId": {"value": "string"
},
"rmVersion": "string"
},
"feederAudit": {"originatingSystemItemIds": [{"issuer": "string",
"assigner": "string",
"id": "string",
"type": "string"
}
],
"feederSystemItemIds": [{"issuer": "string",
"assigner": "string",
"id": "string",
"type": "string"
}
],
"originalContent": {"charset": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
},
"language": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
}
},
"originatingSystemAudit": {"systemId": "string",
"location": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"provider": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"subject": {"externalRef": {"namespace": null,
"type": null,
"id": null
}
},
"time": {"normalStatus": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"normalRange": {"lower": null,
"upper": null,
"upperUnbounded": null,
"lowerIncluded": null,
"upperIncluded": null,
"lowerUnbounded": null
},
"otherReferenceRanges": [null
],
"magnitudeStatus": "string",
"accuracy": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"accuracyIsPercent": null,
"value": { }
},
"value": { }
},
"versionId": "string",
"otherDetails": {"name": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"archetypeNodeId": "string",
"uid": {"value": null
},
"archetypeDetails": {"archetypeId": null,
"templateId": null,
"rmVersion": null
},
"feederAudit": { },
"links": [null
],
"items": [null
],
"path": "string"
}
},
"feederSystemAudit": {"systemId": "string",
"location": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"provider": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"subject": {"externalRef": {"namespace": null,
"type": null,
"id": null
}
},
"time": {"normalStatus": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"normalRange": {"lower": null,
"upper": null,
"upperUnbounded": null,
"lowerIncluded": null,
"upperIncluded": null,
"lowerUnbounded": null
},
"otherReferenceRanges": [null
],
"magnitudeStatus": "string",
"accuracy": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"accuracyIsPercent": null,
"value": { }
},
"value": { }
},
"versionId": "string",
"otherDetails": {"name": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"archetypeNodeId": "string",
"uid": {"value": null
},
"archetypeDetails": {"archetypeId": null,
"templateId": null,
"rmVersion": null
},
"feederAudit": { },
"links": [null
],
"items": [null
],
"path": "string"
}
}
},
"links": [{"meaning": {"value": "string",
"hyperlink": {"value": null
},
"formatting": "string",
"mappings": [null
],
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"encoding": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"type": {"value": "string",
"hyperlink": {"value": null
},
"formatting": "string",
"mappings": [null
],
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"encoding": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"target": {"value": "http://example.com"
}
}
],
"path": "string"
},
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd"
}
]
},
"moved_item_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deleted_item_tags": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
"key": "string",
"value": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"target_type": "EHR_STATUS",
"target_path": "string"
}
]
}
}

Request the EHR id that a given EHR was merged into, taking cascading into account

path Parameters

required

string <uuid>

EHR id to find the merge target for

Responses

Response samples

Content type

application/json

"string"

Request the merging status of a SOURCE_EHR and/or TARGET_EHR

query Parameters

source	string <uuid> source EHR id to find merge status for
target	string <uuid> target EHR id to find merge status for
cascaded	boolean Default: false whether cascaded merges shall be taken into account

Responses

Response samples

Content type

application/json

[{"outcome": {"level": "BASIC",
"summary": "string"
},
"source_ehr": "e41451f3-ce0a-41b1-8452-c636cac1e6f5",
"target_ehr": "097716e6-03df-4e2e-938b-1cedb015bb9f",
"merge_date": "2019-08-24T14:15:22Z",
"unmerge_data": {"contributions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"compositions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"folders": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"data": {"name": {"value": "string",
"hyperlink": {"value": null
},
"formatting": "string",
"mappings": [null
],
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"encoding": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"archetypeNodeId": "string",
"uid": {"value": "string"
},
"archetypeDetails": {"archetypeId": {"qualified_rm_entity": null,
"domain_concept": null,
"rm_originator": null,
"rm_name": null,
"rm_entity": null,
"specialisation": null,
"versionId": null,
"value": null,
"namespace": null,
"qualifiedRmEntity": null,
"domainConcept": null,
"rmOriginator": null,
"rmName": null,
"rmEntity": null,
"semanticId": null,
"fullId": null
},
"templateId": {"value": null
},
"rmVersion": "string"
},
"feederAudit": {"originatingSystemItemIds": [null
],
"feederSystemItemIds": [null
],
"originalContent": {"charset": null,
"language": null
},
"originatingSystemAudit": {"systemId": null,
"location": null,
"provider": null,
"subject": null,
"time": null,
"versionId": null,
"otherDetails": null
},
"feederSystemAudit": {"systemId": null,
"location": null,
"provider": null,
"subject": null,
"time": null,
"versionId": null,
"otherDetails": null
}
},
"links": [{"meaning": null,
"type": null,
"target": null
}
],
"path": "string"
},
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd"
}
]
}
],
"ehr_creation": "2019-08-24T14:15:22Z",
"ehr_status": {"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"data": {"name": {"value": "string",
"hyperlink": {"value": "http://example.com"
},
"formatting": "string",
"mappings": [{"match": null,
"purpose": null,
"target": null
}
],
"language": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
},
"encoding": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
}
},
"archetypeNodeId": "string",
"uid": {"value": "string"
},
"archetypeDetails": {"archetypeId": {"specialisation": "string",
"versionId": "string",
"value": "string",
"namespace": "string",
"qualifiedRmEntity": "string",
"domainConcept": "string",
"rmOriginator": "string",
"rmName": "string",
"rmEntity": "string",
"semanticId": "string",
"fullId": "string"
},
"templateId": {"value": "string"
},
"rmVersion": "string"
},
"feederAudit": {"originatingSystemItemIds": [{"issuer": null,
"assigner": null,
"id": null,
"type": null
}
],
"feederSystemItemIds": [{"issuer": null,
"assigner": null,
"id": null,
"type": null
}
],
"originalContent": {"charset": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"originatingSystemAudit": {"systemId": "string",
"location": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"provider": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"subject": {"externalRef": null
},
"time": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"value": { }
},
"versionId": "string",
"otherDetails": {"name": null,
"archetypeNodeId": null,
"uid": null,
"archetypeDetails": null,
"feederAudit": null,
"links": [ ],
"items": [ ],
"path": null
}
},
"feederSystemAudit": {"systemId": "string",
"location": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"provider": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"subject": {"externalRef": null
},
"time": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"value": { }
},
"versionId": "string",
"otherDetails": {"name": null,
"archetypeNodeId": null,
"uid": null,
"archetypeDetails": null,
"feederAudit": null,
"links": [ ],
"items": [ ],
"path": null
}
}
},
"links": [{"meaning": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"type": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"target": {"value": null
}
}
],
"path": "string"
},
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd"
}
]
},
"moved_item_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deleted_item_tags": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
"key": "string",
"value": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"target_type": "EHR_STATUS",
"target_path": "string"
}
]
}
}
]

Request the details of a merge operation

query Parameters

source required	string <uuid> source EHR id to find merge details for
target required	string <uuid> target EHR id to find merge details for
unmerge_data	boolean Default: false if data for unmerging is to be included

Responses

Response samples

Content type

application/json

{"outcome": {"level": "BASIC",
"summary": "string"
},
"source_ehr": "e41451f3-ce0a-41b1-8452-c636cac1e6f5",
"target_ehr": "097716e6-03df-4e2e-938b-1cedb015bb9f",
"merge_date": "2019-08-24T14:15:22Z",
"unmerge_data": {"contributions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"compositions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"folders": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"data": {"name": {"value": "string",
"hyperlink": {"value": "http://example.com"
},
"formatting": "string",
"mappings": [{"match": null,
"purpose": null,
"target": null
}
],
"language": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
},
"encoding": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
}
},
"archetypeNodeId": "string",
"uid": {"value": "string"
},
"archetypeDetails": {"archetypeId": {"specialisation": "string",
"versionId": "string",
"value": "string",
"namespace": "string",
"qualifiedRmEntity": "string",
"domainConcept": "string",
"rmOriginator": "string",
"rmName": "string",
"rmEntity": "string",
"semanticId": "string",
"fullId": "string"
},
"templateId": {"value": "string"
},
"rmVersion": "string"
},
"feederAudit": {"originatingSystemItemIds": [{"issuer": null,
"assigner": null,
"id": null,
"type": null
}
],
"feederSystemItemIds": [{"issuer": null,
"assigner": null,
"id": null,
"type": null
}
],
"originalContent": {"charset": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"originatingSystemAudit": {"systemId": "string",
"location": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"provider": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"subject": {"externalRef": null
},
"time": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"value": { }
},
"versionId": "string",
"otherDetails": {"name": null,
"archetypeNodeId": null,
"uid": null,
"archetypeDetails": null,
"feederAudit": null,
"links": [ ],
"items": [ ],
"path": null
}
},
"feederSystemAudit": {"systemId": "string",
"location": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"provider": {"externalRef": null,
"name": null,
"identifiers": [ ]
},
"subject": {"externalRef": null
},
"time": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"value": { }
},
"versionId": "string",
"otherDetails": {"name": null,
"archetypeNodeId": null,
"uid": null,
"archetypeDetails": null,
"feederAudit": null,
"links": [ ],
"items": [ ],
"path": null
}
}
},
"links": [{"meaning": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"type": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"target": {"value": null
}
}
],
"path": "string"
},
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd"
}
]
}
],
"ehr_creation": "2019-08-24T14:15:22Z",
"ehr_status": {"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"data": {"name": {"value": "string",
"hyperlink": {"value": "http://example.com"
},
"formatting": "string",
"mappings": [{"match": "string",
"purpose": {"value": null,
"hyperlink": null,
"formatting": null,
"language": null,
"encoding": null,
"definingCode": null
},
"target": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
}
],
"language": {"terminologyId": {"value": "string"
},
"codeString": "string",
"preferredTerm": "string"
},
"encoding": {"terminologyId": {"value": "string"
},
"codeString": "string",
"preferredTerm": "string"
}
},
"archetypeNodeId": "string",
"uid": {"value": "string"
},
"archetypeDetails": {"archetypeId": {"specialisation": "string",
"versionId": "string",
"value": "string",
"namespace": "string",
"qualifiedRmEntity": "string",
"domainConcept": "string",
"rmOriginator": "string",
"rmName": "string",
"rmEntity": "string",
"semanticId": "string",
"fullId": "string"
},
"templateId": {"value": "string"
},
"rmVersion": "string"
},
"feederAudit": {"originatingSystemItemIds": [{"issuer": "string",
"assigner": "string",
"id": "string",
"type": "string"
}
],
"feederSystemItemIds": [{"issuer": "string",
"assigner": "string",
"id": "string",
"type": "string"
}
],
"originalContent": {"charset": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
},
"language": {"terminologyId": {"value": null
},
"codeString": "string",
"preferredTerm": "string"
}
},
"originatingSystemAudit": {"systemId": "string",
"location": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"provider": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"subject": {"externalRef": {"namespace": null,
"type": null,
"id": null
}
},
"time": {"normalStatus": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"normalRange": {"lower": null,
"upper": null,
"upperUnbounded": null,
"lowerIncluded": null,
"upperIncluded": null,
"lowerUnbounded": null
},
"otherReferenceRanges": [null
],
"magnitudeStatus": "string",
"accuracy": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"accuracyIsPercent": null,
"value": { }
},
"value": { }
},
"versionId": "string",
"otherDetails": {"name": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"archetypeNodeId": "string",
"uid": {"value": null
},
"archetypeDetails": {"archetypeId": null,
"templateId": null,
"rmVersion": null
},
"feederAudit": { },
"links": [null
],
"items": [null
],
"path": "string"
}
},
"feederSystemAudit": {"systemId": "string",
"location": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"provider": {"externalRef": {"namespace": null,
"type": null,
"id": null
},
"name": "string",
"identifiers": [null
]
},
"subject": {"externalRef": {"namespace": null,
"type": null,
"id": null
}
},
"time": {"normalStatus": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"normalRange": {"lower": null,
"upper": null,
"upperUnbounded": null,
"lowerIncluded": null,
"upperIncluded": null,
"lowerUnbounded": null
},
"otherReferenceRanges": [null
],
"magnitudeStatus": "string",
"accuracy": {"normalStatus": null,
"normalRange": null,
"otherReferenceRanges": [ ],
"magnitudeStatus": null,
"accuracy": null,
"accuracyIsPercent": null,
"value": { }
},
"value": { }
},
"versionId": "string",
"otherDetails": {"name": {"value": null,
"hyperlink": null,
"formatting": null,
"mappings": [ ],
"language": null,
"encoding": null
},
"archetypeNodeId": "string",
"uid": {"value": null
},
"archetypeDetails": {"archetypeId": null,
"templateId": null,
"rmVersion": null
},
"feederAudit": { },
"links": [null
],
"items": [null
],
"path": "string"
}
}
},
"links": [{"meaning": {"value": "string",
"hyperlink": {"value": null
},
"formatting": "string",
"mappings": [null
],
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"encoding": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"type": {"value": "string",
"hyperlink": {"value": null
},
"formatting": "string",
"mappings": [null
],
"language": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
},
"encoding": {"terminologyId": null,
"codeString": null,
"preferredTerm": null
}
},
"target": {"value": "http://example.com"
}
}
],
"path": "string"
},
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd"
}
]
},
"moved_item_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deleted_item_tags": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"target": "65a17d54-9c67-4477-8b80-d3f97e165aa5",
"key": "string",
"value": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"target_type": "EHR_STATUS",
"target_path": "string"
}
]
}
}

ehr_id required	string
directory_id required	string Example: {{folder_id_short}}

Admin API (1.0.0)

Overview

Purpose

Status

Composition

Delete Composition

path Parameters

Responses

EHR

Update EHR

path Parameters

Request Body schema: application/json

Responses

Request samples

Delete EHR

path Parameters

Responses

Contribution

Update Contribution

Request Body schema: application/json

Responses

Request samples

Directory

Delete directory

path Parameters

Responses

Template

Update template

path Parameters

Responses

Delete template

path Parameters

Responses

Delete all templates

Responses

Query

Delete Stored Query Version

path Parameters

Responses

Status & Management

Admin API status

Responses

EHR-Merge

Merge a source EHR into an existing target EHR

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Request the EHR id that a given EHR was merged into, taking cascading into account

path Parameters

Responses

Response samples

Request the merging status of a SOURCE_EHR and/or TARGET_EHR

query Parameters

Responses

Response samples

Request the details of a merge operation

query Parameters

Responses

Response samples

Request Body schema: application/json
required