Skip to content

Latest commit

 

History

History
225 lines (148 loc) · 9.16 KB

flat json.md

File metadata and controls

225 lines (148 loc) · 9.16 KB
Raw

FLAT JSON

EtherCIS supports two flat json formats

  • ECISFLAT: which is the native understanding of FLAT JSON based on AQL path. Since EtherCIS relies on RM object representation (in particular Composition), the parsing of flat json key value pairs is efficient.
  • FLAT: this is Marand's flat json format as described in the Overview of openEHR and Ehrscape.

FLAT

Marand's flat json is based on key value pairs (more precisely path/value) where the path expression is based on node names and array indexes. For example:

{
  "laboratory_order/_uid": "23d69330-7790-4394-8abc-1455681f6ffa::ydh.code4health.com::1",
  "laboratory_order/language|code": "en",
  "laboratory_order/language|terminology": "ISO_639-1",
  "laboratory_order/territory|code": "GB",
  "laboratory_order/territory|terminology": "ISO_3166-1",
  "laboratory_order/context/_health_care_facility|id": "999999-345",
  "laboratory_order/context/_health_care_facility|id_scheme": "2.16.840.1.113883.2.1.4.3",
  "laboratory_order/context/_health_care_facility|id_namespace": "NHS-UK",
  "laboratory_order/context/_health_care_facility|name": "Northumbria Community NHS",
  "laboratory_order/context/setting|terminology": "openehr",
  "laboratory_order/laboratory_test_request/_uid": "b8c17799-457d-4583-8d85-c369dffacc21",
  "laboratory_order/laboratory_test_request/lab_request/service_requested|code": "444164000",
  "laboratory_order/laboratory_test_request/lab_request/service_requested|value": "Urea, electrolytes and creatinine measurement",
  "laboratory_order/laboratory_test_request/lab_request/service_requested|terminology": "SNOMED-CT",
  "laboratory_order/laboratory_test_request/lab_request/timing": "R5/2015-04-10T00:19:00+02:00/P2M",
  "laboratory_order/laboratory_test_request/lab_request/timing|formalism": "timing",
  "laboratory_order/laboratory_test_request/narrative": "Urea, electrolytes and creatinine measurement",
  "laboratory_order/laboratory_test_request/language|code": "en",
  "laboratory_order/laboratory_test_tracker/time": "2015-04-10T00:19:02.518+02:00",
  "laboratory_order/laboratory_test_tracker/language|code": "en",
  "laboratory_order/laboratory_test_tracker/language|terminology": "ISO_639-1",
  "laboratory_order/laboratory_test_tracker/encoding|code": "UTF-8",
  "laboratory_order/laboratory_test_tracker/encoding|terminology": "IANA_character-sets",
  "laboratory_order/composer|name": "Dr Joyce Smith",
  "ctx/language": "en",
  "ctx/territory": "GB"
}

This flat json format is easy to read and interpret by a human operator, but it cannot be directly identified by Ocean's modelling tools.

ECISFLAT

The flat json format currently supported by Ethercis is a simple Path/Value representation of data in a Composition.

For example, a flat json data block is

{
        "/context/health_care_facility|name":"Northumbria Community NHS",
        "/context/health_care_facility|identifier":"999999-345",
        "/context/start_time":"2015-09-28T10:18:17.352+07:00",
        "/context/end_time":"2015-09-28T11:18:17.352+07:00",
        "/context/participation|function":"Oncologist",
        "/context/participation|name":"Dr. Marcus Johnson",
        "/context/participation|identifier":"1345678",
        "/context/participation|mode":"face-to-face communication::openehr::216",
        "/context/location":"local",
        "/context/setting":"openehr::227|emergency care|",
        "/composer|identifier":"1345678",
        "/composer|name":"Dr. Marcus Johnson",
        "/category":"openehr::433|event|",
        "/territory":"FR",
        "/language":"fr",
        "/content[openEHR-EHR-SECTION.medications.v1]/items[openEHR-EHR-INSTRUCTION.medication.v1]/participation:0":"Nurse|1345678::Jessica|face-to-face communication::openehr::216",
        "/content[openEHR-EHR-SECTION.medications.v1]/items[openEHR-EHR-INSTRUCTION.medication.v1]/participation:1":"Assistant|1345678::2.16.840.1.113883.2.1.4.3::NHS-UK::ANY::D. Mabuse|face-to-face communication::openehr::216",
        "/content[openEHR-EHR-SECTION.medications.v1]/items[openEHR-EHR-INSTRUCTION.medication.v1]/activities[at0001]/timing":"before sleep",
        "/content[openEHR-EHR-SECTION.medications.v1]/items[openEHR-EHR-INSTRUCTION.medication.v1]/activities[at0001]/description[openEHR-EHR-ITEM_TREE.medication_mod.v1]/items[at0001]":"aspirin",
        "/content[openEHR-EHR-SECTION.medications.v1]/items[openEHR-EHR-INSTRUCTION.medication.v1]/activities[at0002]/timing":"lunch",
        "/content[openEHR-EHR-SECTION.medications.v1]/items[openEHR-EHR-INSTRUCTION.medication.v1]/activities[at0002]/description[openEHR-EHR-ITEM_TREE.medication_mod.v1]/items[at0001]":"Atorvastatin"
}

Paths

The path expression is directly issued from the template designer or a CKM like openEHR UK CKM. For the latter, select 'Show Path' option when displaying a template.

OpenEHR locatable path are described at: Paths and Locators

NB. In a flat json block, path expressions consist of several sections:

  • /context Hold the composition context attributes
  • a number of composition attributes to specify: category, language etc
  • /content the set of entries (care entries, section, admin entry etc.)

Values

The syntax for encoding of OpenEHR data values follow several conventions depending on the type, see: Data Types Specification for more details

DvCodedText

"terminology::code|value|"

DvText

"text"

CodePhrase

"terminology::code"

DvDateTime

YYYY-MM-DDTHH:MM:SS

DvTime

HH:MM:SS

DvDate

YYYY-MM-DD

DvBoolean

"true|false"

DvInterval

Date interval: YYYY-MM-DD::YYYY-MM-DD
[TBC]

DvEHRURI

"a URL"

DvOrdinal

Ordinal#|corresponding coded text	

Example: `1|SNOMED-CT::313267000|Stroke|

DvQuantity

magnitude,unit

Example: "12,kg" "78.500,kg" (NB. the precision is implictly given by the number of digits in the decimal part)

DvDuration

"ISO 8601 duration"

Example: PT2h5m0s

DvCount

integer_value

DvProportion

numerator,denominator,proportion_kind

Example: "25.3,100,2" "21,24,3" (respectively: PERCENT, FRACTION)

Proportion Kind:

RATIO(0),
UNITARY(1),
PERCENT(2),
FRACTION(3),
INTEGER_FRACTION(4)

DvMultimedia

integrityCheckAlgorithm": "openehr_integrity_check_algorithms::SHA-1"
mediaType": "IANA_media-types::text/plain"
compressionAlgorithm": "openehr_compression_algorithms::other"
uri": "file://test.ethercis.com/dir/file.jpg"

DvParsable

<value>,<formalism>

For example (timing ISO8601)

/timing|value": "R2/2016-03-19T16:00:00Z/P1M,ISO8601"

Participation

A participation consists of several complex attributes and is represented sequentially:

    ...|function": "Oncologist"
    ...|identifier": "999999-8"
    ...|mode": "openehr::216|evil cabinet|"
    ...|name": "Dr. Caligari"

Another terse representation on one line:

Nurse|1345678::Jessica|openehr::216|face-to-face communication

function|id:name|terminology::code|mode

Indexes

Arrays are supported by specifying an index value prefixed by ":", for example:

/content[openEHR-EHR-EVALUATION.verbal_examination.v1]/participation:0
/content[openEHR-EHR-EVALUATION.verbal_examination.v1]/participation:1
/content[openEHR-EHR-EVALUATION.verbal_examination.v1]/participation:2

Or by inserting an array index in the node predicate:

/items[openEHR-EHR-EVALUATION.reason_for_encounter.v1]/data[at0001]/items[at0002, '<name/value>#1']:"does not sleep"
/items[openEHR-EHR-EVALUATION.reason_for_encounter.v1]/data[at0001]/items[at0002, '<name/value>#2']:"thinks too much"
/items[openEHR-EHR-EVALUATION.reason_for_encounter.v1]/data[at0001]/items[at0002, '<name/value>#3']:"thinks way too much"

For example:

  "/content[openEHR-EHR-EVALUATION.family_history.v2]/data[at0001]/items[at0003, 'Per family member#1']/items[at0008, 'Clinical history#1']/items[at0009]|value": "hooligan",
  "/content[openEHR-EHR-EVALUATION.family_history.v2]/data[at0001]/items[at0003, 'Per family member#1']/items[at0008, 'Clinical history#1']/items[at0010]|value": "P20Y",
  "/content[openEHR-EHR-EVALUATION.family_history.v2]/data[at0001]/items[at0003, 'Per family member#1']/items[at0008, 'Clinical history#1']/items[at0012]|value": "violent",
  "/content[openEHR-EHR-EVALUATION.family_history.v2]/data[at0001]/items[at0003, 'Per family member#1']/items[at0008, 'Clinical history#2']/items[at0009]|value": "TV addict",
  "/content[openEHR-EHR-EVALUATION.family_history.v2]/data[at0001]/items[at0003, 'Per family member#1']/items[at0008, 'Clinical history#2']/items[at0010]|value": "P22Y",
  "/content[openEHR-EHR-EVALUATION.family_history.v2]/data[at0001]/items[at0003, 'Per family member#1']/items[at0008, 'Clinical history#2']/items[at0012]|value": "idiosyncratic",

Choice The choice is specified by indicating the index of the alternative prefixed by '@', for example:

"@1|Choice #1"

- OR -

"@2|local::111|Continue Indefinitely|"