EHRbase API (v1)

Download OpenAPI specification:Download

EHRbase implements the official openEHR REST API. Additionally, EHRbase provides a custom status heartbeat endpoint, an Admin API (if activated) and a Status and Metrics API (if activated) for monitoring and maintenance. Note: The openEHR REST API is documented in their official documentation, not here. Please refer to their separate documentation.

EHRbase Documentation

Admin - Template

updateTemplate

path Parameters

template_id

required

string

Target template id to update. The value comes from the 'template_id' property.

header Parameters

Accept	string Default: application/xml Client should specify expected format
Content-Type required	string Client may request content format

Request Body schema: application/xml
required

string

New template content to replace old one with

Responses

Response samples

200
401
403
404
422

Content type

application/xml

No sample

deleteTemplate

path Parameters

template_id

required

string

Target template id to delete. The value comes from the 'template_id' property.

Responses

Response samples

202
401
403
404
422

Content type

application/json

{"deleted": 0
}

deleteAllTemplates

Responses

Response samples

200
401
403
404
422

Content type

application/json

{ }

Admin - EHR

updateEhr

path Parameters

ehr_id

required

string

Target EHR id to update

header Parameters

Accept

string

Client requested response content type

Responses

Response samples

200
401
403
404

Content type

application/json

{"updated": 0
}

deleteEhr

path Parameters

ehr_id

required

string

Target EHR id to delete

Responses

Response samples

204
401
403
404

Content type

application/json

{"deleted": 0
}

Admin - Contribution

updateContribution

path Parameters

ehr_id required	string Target EHR id to update contribution inside.
contribution_id required	string Target Contribution id to update

Responses

Response samples

200
401
403
404

Content type

application/json

{"updated": 0
}

Not supported since 2.0.0

path Parameters

ehr_id required	string Target EHR id to update contribution inside.
contribution_id required	string Target Contribution id to update

Responses

Response samples

501

Content type

application/json

{"deleted": 0
}

Admin - EHR-Merge

Merge a source EHR into an existing target EHR

Request Body schema: application/json
required

source_ehr required	string <uuid>
target_ehr required	string <uuid>
detail_level	string Enum: "BASIC" "FOLDER_COPY"
reversible required	boolean
dry_run	boolean
folder_merge	string Enum: "BASIC" "COPY"
composition_merge	string Enum: "BASIC" "PERSISTENT"

Responses

Request samples

Payload

Content type

application/json

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

Response samples

200
401
403
404

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": {"ehr_creation": "2019-08-24T14:15:22Z",
"ehr_status": {"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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,
"lowerUnbounded": null,
"upperIncluded": 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,
"lowerUnbounded": null,
"upperIncluded": 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"
}
}
]
},
"contributions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"compositions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deletedCompositions": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
}
],
"folders": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
}
],
"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

id

required

string <uuid>

EHR id to find the merge target for

Responses

Response samples

200
401
403
404

Content type

text/plain

No sample

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

200
401
403
404

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": {"ehr_creation": "2019-08-24T14:15:22Z",
"ehr_status": {"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
},
"contributions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"compositions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deletedCompositions": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
}
],
"folders": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
}
],
"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

200
401
403
404

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": {"ehr_creation": "2019-08-24T14:15:22Z",
"ehr_status": {"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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,
"lowerUnbounded": null,
"upperIncluded": 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,
"lowerUnbounded": null,
"upperIncluded": 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"
}
}
]
},
"contributions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"compositions": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"deletedCompositions": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
}
],
"folders": [{"versions": [{"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"version": 0,
"sys_period_lower": "2019-08-24T14:15:22Z",
"sys_period_upper": "2019-08-24T14:15:22Z",
"contribution": "e0467caf-25c8-4cad-beac-49220acc545c",
"audit_details": "60c3415c-ae65-4365-a78c-1b467d0282dd",
"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"
}
}
]
}
],
"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"
}
]
}
}

Admin - Heartbeat

getStatus

Responses

Response samples

200
401
403

Content type

application/json

{"message": "string"
}

Admin - Stored-Query

deleteStoredQuery

path Parameters

qualified_query_name required	string
version required	string

header Parameters

Accept

string

Responses

Admin - Directory

deleteDirectory

path Parameters

ehr_id required	string Target EHR ed to remove Directory from
directory_id required	string Target Directory id to delete

Responses

Response samples

200
401
403
404

Content type

application/json

{"deleted": 0
}

Admin - Composition

deleteComposition

path Parameters

ehr_id required	string Target EHR id to remove composition from
composition_id required	string Target Composition id to remove

Responses

Response samples

200
401
403
404

Content type

application/json

{"deleted": 0
}

EHRbase API (v1)

Admin - Template

updateTemplate

path Parameters

header Parameters

Request Body schema: application/xmlrequired

Responses

Response samples

deleteTemplate

path Parameters

Responses

Response samples

deleteAllTemplates

Responses

Response samples

Admin - EHR

updateEhr

path Parameters

header Parameters

Responses

Response samples

deleteEhr

path Parameters

Responses

Response samples

Admin - Contribution

updateContribution

path Parameters

Responses

Response samples

Not supported since 2.0.0

path Parameters

Responses

Response samples

Admin - 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

Admin - Heartbeat

getStatus

Responses

Response samples

Admin - Stored-Query

deleteStoredQuery

path Parameters

header Parameters

Responses

Admin - Directory

deleteDirectory

path Parameters

Responses

Response samples

Admin - Composition

deleteComposition

path Parameters

Responses

Response samples

Request Body schema: application/xml
required

Request Body schema: application/json
required