OpenEHR Base package
0.1.0 - First Draft International flag

OpenEHR Base package, published by openEHR + HL7. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/openehr-fhir/base-spec/ and changes regularly. See the Directory of published versions

Logical Model: EXTRACT_UPDATE_SPEC - Detailed Descriptions

Page standards status: Informative Maturity Level: 3

Definitions for the EXTRACT-UPDATE-SPEC logical model.

Guidance on how to interpret the contents of this table can be foundhere

0. EXTRACT_UPDATE_SPEC
Definition

Specification of the how the request should be processed by server. The request can be persisted in the server, meaning that a) it can be re-activated by the requesting system simply by indicating Request id, and b) that a changes-only pattern of Extract updates can be set up. To achieve this, the server has to remember what was sent in the previous response.

The update mode may be event-driven and periodic update or a mixture of both. The candidate items to be sent each time are the result of re-evaluating the content and versioning parts of the specification; what is actually sent is determined by the _send_changes_only_ flag.


Base definition for all types defined in FHIR type system.

ShortSpecification of the how the request should be processed by server.Base for all types and resources
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOverall_validity: Overall validity must be present (repeat_period.exists() or trigger_events.exists())
Trigger_events_validity: Trigger events validity must be present (trigger_events.exists() implies trigger_events.empty().not())
Send_changes_only_validity: Send changes only validity must satisfy conditional constraints (null # TODO: manual translation needed)
2. EXTRACT_UPDATE_SPEC.persist-in-server
Definition

If True, this Request is persisted in the server until further notice.

ShortIf True, this Request is persisted in the server until further notice.
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_UPDATE_SPEC.repeat-period
Definition

Period for resending update Extracts in response to original Request.

ShortPeriod for resending update Extracts in response to original Request.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
6. EXTRACT_UPDATE_SPEC.trigger-events
Definition

Set of Event names that will cause sending of update Extracts. Event types include:

  • |any_change| - any change in content items matched by content specification, e.g. new versions of persistent compositions. If the content list allows matching of any, or a wide range of archetypes, this event type will match any additions to the record.
  • |correction| - match error corrections only, including deletions.
  • |update| - match updates (i.e. new versions) of included content items.

Coded by openEHR Terminology group 'extract update trigger event type'.

ShortSet of Event names that will cause sending of update Extracts.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. EXTRACT_UPDATE_SPEC.update-method
Definition

Indicate mode of update. Can be: send only items that are changed (including logical deletions) or new since last send. For _persist_in_server_ Requests only.

ShortIndicate mode of update.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. EXTRACT_UPDATE_SPEC
Definition

Specification of the how the request should be processed by server. The request can be persisted in the server, meaning that a) it can be re-activated by the requesting system simply by indicating Request id, and b) that a changes-only pattern of Extract updates can be set up. To achieve this, the server has to remember what was sent in the previous response.

The update mode may be event-driven and periodic update or a mixture of both. The candidate items to be sent each time are the result of re-evaluating the content and versioning parts of the specification; what is actually sent is determined by the _send_changes_only_ flag.

ShortSpecification of the how the request should be processed by server.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOverall_validity: Overall validity must be present (repeat_period.exists() or trigger_events.exists())
Trigger_events_validity: Trigger events validity must be present (trigger_events.exists() implies trigger_events.empty().not())
Send_changes_only_validity: Send changes only validity must satisfy conditional constraints (null # TODO: manual translation needed)
2. EXTRACT_UPDATE_SPEC.persist-in-server
Definition

If True, this Request is persisted in the server until further notice.

ShortIf True, this Request is persisted in the server until further notice.
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_UPDATE_SPEC.repeat-period
Definition

Period for resending update Extracts in response to original Request.

ShortPeriod for resending update Extracts in response to original Request.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
6. EXTRACT_UPDATE_SPEC.trigger-events
Definition

Set of Event names that will cause sending of update Extracts. Event types include:

  • |any_change| - any change in content items matched by content specification, e.g. new versions of persistent compositions. If the content list allows matching of any, or a wide range of archetypes, this event type will match any additions to the record.
  • |correction| - match error corrections only, including deletions.
  • |update| - match updates (i.e. new versions) of included content items.

Coded by openEHR Terminology group 'extract update trigger event type'.

ShortSet of Event names that will cause sending of update Extracts.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. EXTRACT_UPDATE_SPEC.update-method
Definition

Indicate mode of update. Can be: send only items that are changed (including logical deletions) or new since last send. For _persist_in_server_ Requests only.

ShortIndicate mode of update.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse

Guidance on how to interpret the contents of this table can be foundhere

0. EXTRACT_UPDATE_SPEC
Definition

Specification of the how the request should be processed by server. The request can be persisted in the server, meaning that a) it can be re-activated by the requesting system simply by indicating Request id, and b) that a changes-only pattern of Extract updates can be set up. To achieve this, the server has to remember what was sent in the previous response.

The update mode may be event-driven and periodic update or a mixture of both. The candidate items to be sent each time are the result of re-evaluating the content and versioning parts of the specification; what is actually sent is determined by the _send_changes_only_ flag.

ShortSpecification of the how the request should be processed by server.
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
InvariantsOverall_validity: Overall validity must be present (repeat_period.exists() or trigger_events.exists())
Trigger_events_validity: Trigger events validity must be present (trigger_events.exists() implies trigger_events.empty().not())
Send_changes_only_validity: Send changes only validity must satisfy conditional constraints (null # TODO: manual translation needed)
2. EXTRACT_UPDATE_SPEC.persist-in-server
Definition

If True, this Request is persisted in the server until further notice.

ShortIf True, this Request is persisted in the server until further notice.
Control1..1
Typeboolean
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. EXTRACT_UPDATE_SPEC.repeat-period
Definition

Period for resending update Extracts in response to original Request.

ShortPeriod for resending update Extracts in response to original Request.
Control0..1
Typehttp://openehr.org/fhir/StructureDefinition/DV-DURATION
Is Modifierfalse
6. EXTRACT_UPDATE_SPEC.trigger-events
Definition

Set of Event names that will cause sending of update Extracts. Event types include:

  • |any_change| - any change in content items matched by content specification, e.g. new versions of persistent compositions. If the content list allows matching of any, or a wide range of archetypes, this event type will match any additions to the record.
  • |correction| - match error corrections only, including deletions.
  • |update| - match updates (i.e. new versions) of included content items.

Coded by openEHR Terminology group 'extract update trigger event type'.

ShortSet of Event names that will cause sending of update Extracts.
Control0..*
Typehttp://openehr.org/fhir/StructureDefinition/DV-CODED-TEXT
Is Modifierfalse
8. EXTRACT_UPDATE_SPEC.update-method
Definition

Indicate mode of update. Can be: send only items that are changed (including logical deletions) or new since last send. For _persist_in_server_ Requests only.

ShortIndicate mode of update.
Control1..1
Typehttp://openehr.org/fhir/StructureDefinition/CODE-PHRASE
Is Modifierfalse