Synchronisation Extract

Overview

The UML diagram below illustrates an Extract variant designed for synchronising two openEHR systems. The specification only allows for a list of Contributions, or Contributions since a certain Contribution; it also allows the actual versions to be included or excluded. If they are excluded, you can get just Contributions on their own - i.e. find out what the other system has got.

RM ehr extract.sync extract
Figure 1. rm.extract.synchronisation_extract Package

Class Descriptions

SYNC_EXTRACT_REQUEST Class

  • Definition

  • Effective

  • BMM

  • UML

Class

SYNC_EXTRACT_REQUEST

Description

Type of request designed for synchronisation of Contributions between openEHR servers.

Inherit

MESSAGE_CONTENT

Attributes

Signature

Meaning

1..1

specification: SYNC_EXTRACT_SPEC

Details of specification of synchronisation request.
SYNC_EXTRACT_REQUEST

Type of request designed for synchronisation of Contributions between openEHR servers.

Inherits: MESSAGE_CONTENT

Attributes

specification: SYNC_EXTRACT_SPEC [1..1]

Details of specification of synchronisation request.

 
{
    "name": "SYNC_EXTRACT_REQUEST",
    "documentation": "Type of request designed for synchronisation of Contributions between openEHR servers.",
    "ancestors": [
        "MESSAGE_CONTENT"
    ],
    "properties": {
        "specification": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "specification",
            "documentation": "Details of specification of synchronisation request.",
            "is_mandatory": true,
            "type": "SYNC_EXTRACT_SPEC"
        }
    }
}
SYNC_EXTRACT_REQUEST

SYNC_EXTRACT Class

  • Definition

  • Effective

  • BMM

  • UML

Class

SYNC_EXTRACT

Inherit

MESSAGE_CONTENT

Attributes

Signature

Meaning

1..1

specification: SYNC_EXTRACT_SPEC

Details of specification of this Extract.

0..1

items: List<X_CONTRIBUTION>

Content, in the form of a serialised Contributions.
SYNC_EXTRACT

Inherits: MESSAGE_CONTENT

Attributes

specification: SYNC_EXTRACT_SPEC [1..1]

Details of specification of this Extract.

items: List<X_CONTRIBUTION> [0..1]

Content, in the form of a serialised Contributions.

 
{
    "name": "SYNC_EXTRACT",
    "ancestors": [
        "MESSAGE_CONTENT"
    ],
    "properties": {
        "specification": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "specification",
            "documentation": "Details of specification of this Extract.",
            "is_mandatory": true,
            "type": "SYNC_EXTRACT_SPEC"
        },
        "items": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "items",
            "documentation": "Content, in the form of a serialised Contributions.",
            "type_def": {
                "container_type": "List",
                "type": "X_CONTRIBUTION"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        }
    }
}
SYNC_EXTRACT

SYNC_EXTRACT_SPEC Class

  • Definition

  • Effective

  • BMM

  • UML

Class

SYNC_EXTRACT_SPEC

Description

Details of specification of Extract, used in a request to specify an Extract, or in a response, to describe what is actually in the Extract.

Attributes

Signature

Meaning

1..1

includes_versions: Boolean

True if the Versions from the Contribution are included; False if just the Contribution and its Audit are included.

0..1

contribution_list: List<HIER_OBJECT_ID>

List of Contributions to include / that are included in the Extract.

0..1

contributions_since: DV_DATE_TIME

Specify Contributions included in Extract by threshold date.

0..1

all_contributions: Boolean

True if all Contributions in the record are included.
SYNC_EXTRACT_SPEC

Details of specification of Extract, used in a request to specify an Extract, or in a response, to describe what is actually in the Extract.

Attributes

includes_versions: Boolean [1..1]

True if the Versions from the Contribution are included; False if just the Contribution and its Audit are included.

contribution_list: List<HIER_OBJECT_ID> [0..1]

List of Contributions to include / that are included in the Extract.

contributions_since: DV_DATE_TIME [0..1]

Specify Contributions included in Extract by threshold date.

all_contributions: Boolean [0..1]

True if all Contributions in the record are included.

 
{
    "name": "SYNC_EXTRACT_SPEC",
    "documentation": "Details of specification of Extract, used in a request to specify an Extract, or in a response, to describe what is actually in the Extract.",
    "properties": {
        "includes_versions": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "includes_versions",
            "documentation": "True if the Versions from the Contribution are included; False if just the Contribution and its Audit are included.",
            "is_mandatory": true,
            "type": "Boolean"
        },
        "contribution_list": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "contribution_list",
            "documentation": "List of Contributions to include / that are included in the Extract.",
            "type_def": {
                "container_type": "List",
                "type": "HIER_OBJECT_ID"
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        },
        "contributions_since": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "contributions_since",
            "documentation": "Specify Contributions included in Extract by threshold date.",
            "type": "DV_DATE_TIME"
        },
        "all_contributions": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "all_contributions",
            "documentation": "True if all Contributions in the record are included.",
            "type": "Boolean"
        }
    }
}
SYNC_EXTRACT_SPEC

X_CONTRIBUTION Class

  • Definition

  • Effective

  • BMM

  • UML

Class

X_CONTRIBUTION

Description

Serialised form of Contribution for an Extract.

Attributes

Signature

Meaning

1..1

uid: HIER_OBJECT_ID

Uid of Contribution in source system.

1..1

audit: AUDIT_DETAILS

Audit of Contribution in source system.

0..1

versions: List<VERSION<X_CONTRIBUTION>>

Serialised Versions from Contribution in source system.
X_CONTRIBUTION

Serialised form of Contribution for an Extract.

Attributes

uid: HIER_OBJECT_ID [1..1]

Uid of Contribution in source system.

audit: AUDIT_DETAILS [1..1]

Audit of Contribution in source system.

versions: List<VERSION<X_CONTRIBUTION>> [0..1]

Serialised Versions from Contribution in source system.

 
{
    "name": "X_CONTRIBUTION",
    "documentation": "Serialised form of Contribution for an Extract.",
    "properties": {
        "uid": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "uid",
            "documentation": "Uid of Contribution in source system.",
            "is_mandatory": true,
            "type": "HIER_OBJECT_ID"
        },
        "audit": {
            "_type": "P_BMM_SINGLE_PROPERTY",
            "name": "audit",
            "documentation": "Audit of Contribution in source system.",
            "is_mandatory": true,
            "type": "AUDIT_DETAILS"
        },
        "versions": {
            "_type": "P_BMM_CONTAINER_PROPERTY",
            "name": "versions",
            "documentation": "Serialised Versions from Contribution in source system.",
            "type_def": {
                "container_type": "List",
                "type_def": {
                    "_type": "P_BMM_GENERIC_TYPE",
                    "root_type": "VERSION",
                    "generic_parameters": [
                        "X_CONTRIBUTION"
                    ]
                }
            },
            "cardinality": {
                "lower": 0,
                "upper_unbounded": true
            }
        }
    }
}
X_CONTRIBUTION