Document

Description

A document can be of various types. Due to this, the data type for this is very abstract. It is able to contain every file type (encoded in b64) with common meta information.

This meta type should only be used for other documents. For concrete documents please use the different types of documents (coming end of oktober).

Use

– Use to store additional files and documents.

Not use

– For not medical releated documents.

Data Model

Name Type M Description Example
category String The category can be used to differenciate between kinds of documents. “roentgen”
content String X Base64 encoded file data. “SGVsbG9Xb3JsZA==”
description String Some description text for the document. “Some description text for an important document.”
mimetype String X Documents MIME-type “text/plain”
modified DateTime Timestamp of last modification “2014-10-13T11:24:56.143”
name String X File name, including suffix “letter.pdf”
contentSize Integer Size of the content in byte. 2000000

Rules

every document must have a content with a mimetype and a description.

Update Rhythm

For every new Document a new Document can be created.

Schema

{
“id”: “/core/Document”,
“$schema”: “http://json-schema.org/draft-04/schema#”,
“type”: “object”,
“properties”: {
“category”: {
“type”: “string”
},
“content”: {
“type”: “string”,
“media”: {
“binaryEncoding”: “base64”
}
},
“description”: {
“type”: “string”
},
“mimetype”: {
“type”: “string”
},
“modified”: {
“$ref”: “/core/DateTime”
},
“name”: {
“type”: “string”
},
“contentSize”: {
“type”: “integer”
}
},
“additionalProperties”: false
}

Compatible Standards

Possible (containing parts):

– openEHR-EHR-COMPOSITION.report.v1
– openEHR-EHR-COMPOSITION.referral.v1