These pages describe behavior of services in the infrastructure which are not directly invoked by a client.
What is described here is what happens when a user performs login, how submitted measurements are processed in automated processing, how citizens' adherence to care plans are monitored and handled. Also described is the periodic importing of organizations.
Handling at Login
When a user performs login at the eHealth Infrastructure, various checks are performed and security artifacts (such as the security token) are produced. In addition, certain resources are read, created or possibly updated. The following applies to users of Practitioner type.
The external security token contains one to many organizational scopes in which the user can have:
Zero, one or many different careteams in which the user can have one to many user roles
Zero, one or many user roles in the organizational scope
For the recognized user roles bound to a recognized and pre-existing CareTeam, it is ensured that:
a
CareTeam.participant
exists where theCareTeam.participant.member
references the Practitioner. A participant can have multiple roles in a CareTeam.If such an entry is not present, or does not contain the current role then the CareTeam is updated.
When a
CareTeam.participant
is added, theCareTeam.participant.period
is set with aPeriod.start
of date/time at update. ThePeriod.end
is left without value to form an open-ended period.
For all the organizational scopes where the organization identification can be resolved to an Organization in the eHealth Infrastructure, it is ensured that:
a PractitionerRole exists where the
PractitionerRole.practitioner
references the Practitioner and thePractitionerRole.organization
references the Organization
Automated Processing of Submitted Measurement
The Clinical Administrator can define a PlanDefinition, its activities in referenced ActivityDefinition, possible Questionnaire to be answered, and add zero, one or more Library resources each containing a rule. The Library of interest here are those of automated processing type that are attached to a plan for which a measurement has been successfully submitted.
In the following, a measurement resource denotes an Observation, QuestionnaireResponse or Media which has been submitted either by itself or along with other measurement resources in a call of the submit-measurement
operation. All the measurement resource(s) submitted together are denoted a measurement.
Overall, the automated processing of a submitted measurement is asynchronous and constitute the following handling as a response to a submitted measurement event (which contains a reference to a Provenance resource referencing the measurement resources):
For each measurement resource in the order Observation, QuestionnaireResponse and Media resources in the measurement:
The timing of the measurement resource is examined to see if was submitted timely, as described in Automated Processing of Measurements Submitted at Unexpected Time .
The automated processing rule(s) are evaluated, as described in Processing of Automated Processing Rules
The automated processing of submitted measurement is shown in the sequence diagram Automated Processing of Measurements.
Automated Processing of Measurements Submitted at Unexpected Time
For each measurement resource, automated processing resolves the ServiceRequest referenced by the measurement resource. The measurement submission time is then compared to the scheduled timing constructs in ServiceRequest.Timing.repeat
. The measurement submission time is either of:
Observation.meta.lastUpdated
QuestionnaireResponse.meta.lastUpdated
Media.meta.lastUpdated
A measurement has been submitted at unexpected time when:
the scheduled timing is specified as
(Timing.repeat).dayOfWeek
and the day of week code is not identical to that corresponding to the measurement submission time, orthe scheduled timing is specified with
(Timing.repeat).timeOfDay
and(Timing.repeat).boundsDuration
and the measurement submission time is not within the period (start and end included):start of period:
(Timing.repeat).timeOfDay
end of period:
(Timing.repeat).boundsDuration
added to(Timing.repeat).timeOfDay
In case the ServiceRequest has ServiceRequest.Period
or ServiceRequest.occurenceDateTime
it is not checked.
In case a measurement has been submitted at unexpected time, automated processing produces:
A Task with
.status
set torequested
.episodeOfCare
set to the same reference to EpisodeOfCare as used in the measurement resource’s.episodeOfCare
.category
set toUnexpectedMeasurementResolving
.focus.reference
referencing the measurement resource (Observation, QuestionnaireResponse, or Media).ehealth-task-responsible
set to same one or more CareTeam as theCarePlan.team
(CarePlan found through reverse association from measurement resource’s.basedOn
reference to ServiceRequest referred fromCarePlan.activity.reference
).description
set to “Uventet måling” which is Danish for unexpected measurement
A Communication (of ehealth-message profile) with
.status
set tocompleted
.subject
set to the same reference to Patient as used in the measurement resource’s.subject
.episodeOfCare
set to the same reference to EpisodeOfCare as used in the measurement resource’s.episodeOfCare
.category
set tomessage
.reasonCode
set toUnexpectedMeasurementResolving
.topic.reference
referencing the Task above.payload.episodeOfCare
set to “Uventet måling” which is Danish for unexpected measurement.title
set to “Uventet måling”.sender
referencing a special Device designating the automated processing service
Note that most of the above details do not constitute guaranteed content that can be used for searching for or determining whether unexpected measurement(s) has been submitted for a particular Patient. The guaranteed elements are Task.category
(withTask.episodeOfCare
) and Communication.reasonCode
(with Communication.subject
and Communication.episodeOfCare
).
Processing of Automated Processing Rules
When a measurement is submitted to the infrastructure, it triggers automated processing of rules described in the following. Each submitted measurement is related to an activity in a citizen plan represented as a CarePlan where each activity is a ServiceRequest. Which rule or rules are involved depend on the PlanDefinition and its comprised ActivityDefinition resources referenced from the CarePlan and ServiceRequest resources, see https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/1661141027/Creating+Care+Plans#Applying-a-PlanDefinition-to-create-CarePlan(s).
An automated processing rule is a Library where Library.type
is automated-processing
. The existing Library are listed in Library Resources. The automated processing rule Library eligible for a particular ServiceRequest are those zero, one or more Library related to the ActivityDefinition referenced by the ServiceRequest.
In the Plan editor of the Clinical Administration Application (see https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2063892483/eHealth+Applications#Clinical-Administration-Application-(Danish%3A-KAM-for-Klinisk-administrativ-modul)), it is possible to select which automated processing rule Library resources if any that shall be related to a plan template activity (ActivityDefinition).
Situation | Overrides Eligible Library? | Automated Processing Rules | Processing |
---|---|---|---|
Submitted measurement is an Observation with no value ( ServiceRequest references ActivityDefinition with no reference to Library or reference to any other than Null-rule Library | Yes | All Library are ignored and processing is performed as described | A Task is created with |
Submitted measurement is an Observation with no value ( ServiceRequest references ActivityDefinition with reference to Null-rule Library | No | Null-rule Library is evaluated and processing is performed as described | No Task is created. |
ServiceRequest references ActivityDefinition with reference to Null-rule Library | No | ||
ServiceRequest references ActivityDefinition with no Library references | Yes | The Fallback Library is evaluated and processing is performed as described | A Task is created with |
ServiceRequest references ActivityDefinition with reference to Fallback Library | No | ||
ServiceRequest references ActivityDefinition with reference to one or more other Library | No | Each Library is evaluated | Depends on the Library. |
One (or at least one) of the automated-processing type Library resources associated with an ActivityDefinition should create a Task that can draw adequate attention to a submitted and automatically processed measurement. The Null-rule Library is the one exception to this guideline/recommendation.
Library Rule Evaluation
For further details and to assist in understanding intended use and capabilities, please consult Example Library Resources .
For guidance in rule and Library governance and management, please consult Rule and Library Management .
Input
The Library.parameter
element specifies what resources are to be made available to the Library’s rule execution as input and what is returned as output. Typically, a measurement resource - be that an Observation, QuestionnaireResponse or Media - is provided as input as part of the evaluate
operation.
It is possible to state further input for both calculation-type Library (where Library.type
is logic-library
) and automated processing type Library (where Library.type
is automated-processing
). For the calculation-type, all input resources must be provided as part of the evaluate
operation.
For automated processing type, the following can be specified as input but are not provided as they are resolved by the Library service as part of establishing facts:
Resource Type | Description |
---|---|
Patient | Patient for which the measurement was applied. |
EpisodeOfCare | EpisodeOfCare to which the measurement is related. |
CarePlan | CarePlan to which the measurement is related. |
ServiceRequest | ServiceRequest referred from measurement (Observation|QuestionnaireResponse|Media) |
PlanDefinition | PlanDefinition to which the measurement is related. |
ActivityDefinition | ActivityDefinition to which the measurement is related. |
Questionnaire | Questionnaire to which a measurement of type QuestionnaireResponse is a response to. |
Establishing of Facts
If specified as input parameter, the following resources are fetched and made available to an automated processing type Library rule by the Library service. In the rule, the resources can be accessed by adding the variable declaration to the when
part.
Resource Type | Resolved As | Variable Declaration |
---|---|---|
Patient | Fetched as Patient referenced in |
|
EpisodeOfCare | Fetched as EpisodeOfCare referenced in |
|
CarePlan | Fetched as CarePlan where |
|
ServiceRequest | Fetched as ServiceRequest referenced in |
|
PlanDefinition | Fetched as PlanDefinition referenced in |
|
ActivityDefinition | Fetched as ActivityDefinition referenced in |
|
Questionnaire | Fetched as Questionnaire referenced in |
|
Execution of rule and output
For automated processing rules, there is a structure, AutomatedProcessingDTO
, which lets the rule control aspects of the outcome of evaluating the rule. By adding to the structure, the rule controls if and in what number ClinicalImpression, Task, and Communication resources are created. A special case is the property activateSelfTreatment which controls whether check on certain ServiceRequest resources should be made, possibly leading to update of status of eligible ServiceRequest resources (see further details in Activation of suspended Self-treatment type ServiceRequest ).
AutomatedProcessingDTO
Property | Type | Description |
---|---|---|
ClinicalImpressions | List of | Each entry is an instruction to create a resource, and each entry specifies certain details. |
Tasks | List of | Each entry is an instruction to create a resource, and each entry specifies certain details. |
activateSelfTreatment | boolean | Set to true instructs that sibling ServiceRequests of self-treatment kind should be actived if currently suspended. |
ClinicalImpressionDTO
Property | Type | Description |
---|---|---|
Code |
| Used for |
Description | String | Used for |
CodeableConceptFindings | List of | Used for |
ObservationFindings | List of | Used for |
Tasks | List of | Each entry is an instruction to create a Task resource, and each entry specifies certain details. Each created Task refers to the ClinicalImpression through |
FindingBasis | List of | Used for |
TaskDTO
Property | Type | Description |
---|---|---|
Category |
| Used for |
Description | String | Used for |
Priority | String | Used for It must be ensured that the priority is entered in lower-case as defined for |
RestrictionCategories | List of | Used for |
Communications | List of | Each entry is an instruction to create a Communication resource, and each entry specifies certain details. By default, the |
QuestionnaireResponseFindingBasisDTO
Property | Type | Description |
---|---|---|
LinkId | String | Used for |
Finding |
| Used for |
ValueString | String | One of the value elements are populated and used for |
ValueDecimal | Double | |
ValueInteger | Integer | |
ValueBoolean | Boolean | |
ValueCoding |
| |
AnswerSignificance |
| Used for |
AnswerSignificanceDTO
Property | Type | Description |
---|---|---|
Significance |
| Used for |
AnswerConditions | List of | Used for Must be list of size 1 or 2. |
AnswerConditionDTO
Property | Type | Description |
---|---|---|
Operator | String | Used for |
ValueString | String | One of the value elements are populated and used for |
ValueDecimal | Double | |
ValueInteger | Integer | |
ValueBoolean | Boolean | |
ValueCoding |
|
CommunicationDTO
Property | Type | Description |
---|---|---|
Categories | List of | Used for |
Text | String | Used for |
RestrictionCategories | List of | Used for |
CodingDTO
Property | Type | Description |
---|---|---|
system | String | Corresponds to |
code | String | Corresponds to |
display | String | Corresponds to |
It is the responsibility of the rule writer to ensure that a CodingDTO reflects a valid concept in a CodeSystem existing in the eHealth infrastructure and furthermore, that the concept is part of the expanded ValueSet for which there is a binding to the particular resource element where it is used.
ObservationDTO
Property | Type | Description |
---|---|---|
Status | String | Used for |
Code |
| Used for |
ValueString | String | One of the value elements are populated and used for |
ValueBoolean | Boolean | |
ValueQuantity |
|
Output from automated processing
For each automated processing type Library evaluated, the returned GuidanceResponse typically contains a AutomatedProcessingDTO
with instructions for further processing.
The handling is shown in the sequence diagram Automated Processing of Measurements - Handling.
Resources created
When populated by the Library in the AutomatedProcessingDTO
, it results in the following resources being created. Please note that Communication resources described below are subjected to the handling described in Taking applicable CommunicationRequest into account, which further influences the number of Communication resources created and their recipient.
For every ClinicalImpressionDTO
in AutomatedProcessingDTO.ClinicalImpressions
:
Resource | Element | Value |
---|---|---|
ClinicalImpression | code |
|
status |
| |
description |
| |
investigation.code | Coding with:
| |
investigation.item | One version-less reference to the measurement, one versioned referenced to the measurement | |
finding.itemCodeableConcept | Coding added for each | |
finding.itemReference | For each
| |
date | current date/time | |
subject | Same as | |
episodeOfCare | Same as | |
effective | Same as measurement effective (which is | |
ehealth-clinicalimpression-decisionContext | A reference to a contained Parameters with:
| |
ehealth-questionnaireresponse-finding-basis | For each
| |
For every | ||
Task | ehealth-task-responsible | List of CareTeam from the CarePlan |
ehealth-restriction-category |
| |
category |
| |
status |
| |
intent |
| |
priority |
| |
description |
| |
focus | The ClinicalImpression created for the current | |
episodeOfCare | Same as | |
authoredOn | current date/time | |
For every | ||
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
reasonCode | Coding for each | |
payload.content |
| |
ehealth-title |
| |
ehealth-restriction-category | Coding for each | |
subject | Same as GuidanceResponse (and CarePlan) | |
episodeOfCare | Same as GuidanceResponse (and CarePlan) | |
topic | Reference to Task created for current | |
sent | current date/time |
For every TaskDTO
in AutomatedProcessingDTO.Tasks
:
Resource | Element | Value |
---|---|---|
Task | ehealth-task-responsible | List of CareTeam from the CarePlan |
ehealth-restriction-category |
| |
category |
| |
status |
| |
intent |
| |
priority |
| |
description |
| |
focus | Reference to the measurement | |
episodeOfCare | Same as | |
authoredOn | current date/time | |
For every | ||
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
reasonCode | Coding for each | |
payload.content |
| |
ehealth-title |
| |
ehealth-restriction-category | Coding for each | |
subject | Same as GuidanceResponse (and CarePlan) | |
episodeOfCare | Same as GuidanceResponse (and CarePlan) | |
topic | Reference to Task created for current | |
sent | current date/time |
Taking applicable CommunicationRequest into account
When Communication resources (of ehealth-message profile) are created by automated processing, the intended receivers would typically be the one or more CareTeam designated as CarePlan.careTeam
on the involved CarePlan. As Communication can have at most a single CareTeam as recipient (through Communication.ehealth-communication-recipientCareTeam
), this involves duplication of the original Communication where the duplicates vary by recipient.
The recipient(s) and duplication made for Communication created by automated processing is influenced by CommunicationRequest. By creating appropriately crafted CommunicationRequest, a Practitioner can control whether:
to suppress automated processing’s default creation of a Communication for a particular CareTeam
to duplicate a Communication with the Patient as recipient
The handling is shown in the sequence diagram Automated Processing of Measurements - Create Communications.
See https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/edit-v2/2415034369 on what values to use when creating CommunicationRequest.
Activation of suspended Self-treatment type ServiceRequest
When the AutomatedProcessingDTO
specifies activation through the element activateSelfTreatment
set to true, automated processing performs a lookup for all sibling ServiceRequest resources which have:
ServiceRequest.status
set tosuspended
ServiceRequest.definition
referencing an ActivityDefinition whereActivityDefinition.topic
has valueself-treatment
.
The sibling ServiceRequest resources are those referenced fromCarePlan.activity.reference
for the same CarePlan that references the ServiceRequest referenced from the measurement (be that Observation, QuestionnaireResponse or Media).
For those ServiceRequest meeting the criteria above, the ServiceRequest.status
is updated to active
.
Automated Processing of Action Triggers and Trigger Conditions
Each submitted measurement references a ServiceRequest. As part of automated processing of a submitted measurement, the infrastructure examines whether the measurement constitutes fulfillment of trigger conditions that may be defined as action trigger for one or more of its sibling ServiceRequest. In each case where trigger conditions are met, the defined action trigger reaction is performed.
Trigger evaluation is skipped if the submitted measurement is an Observation with .dataAbsentReason
. This means that an Observation with .dataAbsentReason
will not fire any action triggers.
In the example below, the PlanDefinition contains an action trigger where activity “action[2]” has dependencies to “action[0]” and “action[1]”. Compared to the same setup at time of PlanDefinition$apply
(see https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/1661141027/Creating+Care+Plans#Trigger-Actions-and-Trigger-Conditions), the CarePlan and triggering ServiceRequest (SR0 and SR1 in the figure below) now have status
set to active
, presumably because all necessary adjustments and delivering of device etc. have been performed and an employee has changed the status.
When a measurement, here QuestionnaireResponse QR0, is submitted and subjected to automated processing, it is determined whether it plays any role in action triggers. In this case, the corresponding ServiceRequest SR0 is a triggering ServiceRequest, that is, its related ActivityDefinition has a trigger condition defined in the corresponding PlanDefinition. To optimize determining this, the triggering ServiceRequest SR0 (and similarly SR1) has ServiceRequest.meta.tag
set to trigger
automatically as part of PlanDefinition$apply
.
The automated processing follows this pseudo-algorithm:
On receiving a measurement:
If the measurement references a triggering ServiceRequest (if
ServiceRequest.meta.tag
is set totrigger
) continue, otherwise the check for action triggers is done.Resolve the CarePlan referencing the triggering ServiceRequest
Resolve the PlanDefinition referenced by the CarePlan
Resolve the triggering ActivityDefinition (referenced from triggering ServiceRequest) and its id in
PlanDefinition.action[y].id
Determine which depending ServiceRequest (one or more) is depending on the triggering ServiceRequest as follows:
For each
PlanDefinition.action[x].ehealth-actionTrigger
referring intriggerCondition.actionId
the triggeringPlanDefinition.action[y].id
:Resolve the depending ServiceRequest by comparing its reference to depending ActivityDefintion which must be referenced in the depending
PlanDefinition.action[x].definition
.
For each depending ServiceRequest, determine whether conditions have been met:
If the
ServiceRequest.ehealth-trigger-enablement
is other thanTRIGGER_ENABLED
then continue to next depending ServiceRequest, otherwise perform as follows:If the
ServiceRequest.status
ison-hold
continue, otherwise continue to next depending ServiceRequestIf the
PlanDefinition.action[x].ehealth-actionTrigger
hastriggerBehavior
set toone-or-more
Determine whether the
ehealth-triggerCondition
has been met (searching for measurements and comparing withtriggerCoundition.count
)
If the
PlanDefinition.action[x].ehealth-actionTrigger
hastriggerBehavior
set toall
or other triggering ServiceRequest may by defined for this depending ServiceRequestDetermine whether all
ehealth-triggerCondition
have been met (searching for measurements and comparing withtriggerCoundition.count
)Optimized by continuing to next depending ServiceRequest on first unmet condition found
For each depending ServiceRequest where conditions have been met, perform the actionTrigger’s reaction in
actionTrigger.action
This is changing
ServiceRequest.status
toactive
.The
ServiceRequest.occurrence
starting time is evaluated:If the occurrence starting time is in the past, then the starting time is set to now with possible adjustment as specified by
actionTrigger.offset
If the occurrence starting time is in the future, the starting time is kept with possible adjustment as specified by
actionTrigger.offset
Change
ServiceRequest.ehealth-trigger-enablement
toTRIGGER_DONE
The evaluation of starting time is tabulated below for the different types of ServiceRequest.occurrence
:
Type of | Criteria |
---|---|
| The |
| The duration of the The Finally the |
| If the |
Automated Processing of Missing Measurements
The infrastructure has a periodic check whether measurements are being submitted timely according to their CarePlan. The overall approach is to do bookkeeping of when the missing measurements check was last performed and rely on that missing measurements found during the previous window have been handled as part of that check. This way, any current check can consider the period between last check and now only.
The following paragraph applies to eHealth Infrastructure prior to Release 16
This missing measurements check is performed:
for all active CarePlan (with
status
set toactive
) across all Patient resourcesfor all active ServiceRequest (status set to active) resources referring to one of said CarePlan
With eHealth Infrastructure Release 16
The missing measurements check is performed:
for all CarePlan which have had
statusHistory
set toactive
at some pointfor all EpisodeOfCare referred by these CarePlan
for all ServiceRequest referred by these CarePlan
The total set of ServiceRequest considered are filtered so further missing measurement checks are performed for:
ServiceRequest that has active, historic and current effective status (see https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2524872705/Using+EpisodeOfCare+CarePlan+s+and+ServiceRequest+s#Determining-the-ServiceRequest-Effective-Status) period(s) that overlap with
ServiceRequest.occurrence[x]
within the missing measurement lookup periodActive historic and current effective status period(s) means period(s) where EpisodeOfCare, CarePlan and ServiceRequest must have
statusHistory
which areactive
at the same time.
Whether a particular ServiceRequest shall be subjected to the missing measurements check described below, depends on the activity type (copied from ActivityDefinition.code
to ServiceRequest.code
on $apply
). This is controlled by the infrastructure automated processing by lookup in the ConceptMap https://docs.ehealth.sundhed.dk/latest-released/ig/ConceptMap-activitydefinition-code-to-do-missing-measurement.html. In case an activity type is not found in the ConceptMap, the fallback is to subject the ServiceRequest to missing measurements check.
The following section applies to eHealth Infrastructure prior to Release 16
The criteria for a measurement found to be missing depends on how the measurement regime is specified, that is, what ServiceRequest.occurrence[x]
variant in use:
| Criteria |
---|---|
| Measurement not missing when Measurement missing when |
| Measurement not missing when Measurement missing when |
| Measurement not missing when the determined lookup period (see infobox below) has Measurement missing when the found number of measurements (Observation, QuestionnaireResponse or Media) is less than the expected number of times (see infobox below) within the lookup period determined (see infobox below). |
This applies for ServiceRequest.occurrence[x]
specified using occurrenceTiming
.
With Timing, it is possible to specify that an event (such as the activity described in a ServiceRequest) must be performed or happen a number of times within a certain period.
Timing.repeat.frequency
, Timing.repeat.period
and Timing.repeat.periodUnit
are used to determine the number of times as:
Timing.repeat.frequency
forTiming.repeat.periodUnit
set towk
(week) ord
(day)For example 3 is the number of times (per period) for a period of 2 weeks with frequency 3
Timing.repeat.frequency
* (24hrs/day /Timing.repeat.period
) forTiming.repeat.periodUnit
set toh
(hours)For example 6 is the number of times (per day) for a period of 8 hours with frequency 2
Timing.repeat.frequency
* (1440minutes/day /Timing.repeat.period
) forTiming.repeat.periodUnit
set tom
(minutes)For example 32 is the number of times (per day) for a period of 90 minutes with frequency 2
This applies for ServiceRequest
specified using Timing
.
A lookup period (of time) for measurements is determined as follows:
Period starting Midnight
Timing.repeat.period
days ago till current time represented as nearest past Midnight whenTiming.repeat.periodUnit
isd
(day)Period starting Midnight 1 day ago till current time represented as nearest past Midnight when
Timing.repeat.periodUnit
ish
(hours) orm
(minutes)Period starting Monday
Timing.repeat.period
weeks ago and endingTiming.repeat.period
weeks later whenTiming.repeat.periodUnit
iswk
(week)
The following section applies to eHealth Infrastructure Release 16
The criteria for a measurement found to be missing depends on how the measurement regime is specified, that is, what ServiceRequest.occurrence[x]
variant in use:
ServiceRequest.occurrence[x] Variant |
|
|
|
---|---|---|---|
Data Type | Timing constraints:
| ||
Time Criteria |
|
|
|
Effective Status Criteria |
|
|
|
The following section applies to eHealth Infrastructure Release 16
Example of active overlap for ServiceRequest.occurrenceTiming
with repeat.period
: 6 and repeat.periodUnit
: h (and repeat.duration
: 3 and repeat.durationUnit
: h).
As described in row “Time Criteria” for occurrenceTiming
, Timing.repeat.periodUnit
h (hours) will result in a lookup period starting from Midnight 1 day ago till current time represented as nearest past Midnight.
The resolved occurrences will be every 6 hours with a duration of 3 hours starting from Timing.repeat.boundsPeriod.start
. As the time component of boundsPeriod.start
is 10 AM that means the next resolved occurrence is 16 PM and the next 22 PM.
The first occurrence in the lookup period is 22-01 which shall be checked for missing measurement as EpisodeOfCare, CarePlan and ServiceRequest all had status
active
.The second occurrence in the lookup period is 04-07 which shall be checked for missing measurement as EpisodeOfCare, CarePlan and ServiceRequest had status
active
in a partial overlap during the resolved occurrence.The third occurrence in the lookup period is 10-13 shall not be checked for missing measurement as ServiceRequest had status
on-hold
for the whole occurrence.The fourth occurrence in the lookup period is 16-19 which shall be checked for missing measurement as EpisodeOfCare, CarePlan and ServiceRequest had status
active
has partial active overlap during the resolved occurrence.The fifth occurrence in the lookup period is 22-01 which shall not be checked for missing measurement as the end of the occurrence is outside the lookup period, that is, the citizen still has one hour past Midnight to submit measurement(s).
When a measurement is found to be missing, the following resources are prepared for creation:
Resource | Element | Value |
---|---|---|
Task |
| Coding for |
|
| |
|
| |
|
| |
|
| |
| List of CareTeam from the CarePlan | |
| Coding for | |
| The ServiceRequest | |
| Same as | |
| current date/time | |
Communication (of profile ehealth-message) |
| Coding for |
|
| |
| Coding for | |
|
| |
|
| |
| Coding for | |
| Same as CarePlan | |
| Same as CarePlan | |
| Reference to Task above | |
| current date/time |
Each Communication resource prepared for creation (with the content above), is subjected to handling of recipients described in Taking applicable CommunicationRequest into account.
Automated Creation of Reminder on Pending Measurement Activity
In the following, pending measurement activity is used broadly as a term for measuring and answering questionnaires that are supposed to happen.
In order to provide reminders to citizens on pending measurement activities, the eHealth Infrastructure performs periodic lookup. Currently, the periodic lookup is configured to be performed every second hour on the hour.
The periodic lookup for pending measurements considers two lookup time windows:
The current time window:
start datetime: calculated as datetime of next periodic lookup, reduced by the duration between lookups.
end datetime: calculated as datetime of next periodic lookup.
The previous time window:
start datetime: calculated as datetime of current periodic lookup, reduced by the duration between lookups.
end datetime: calculated as datetime of current periodic lookup.
For example: The periodic lookup runs at 08:00.
It has a current (lookup) time window of 08:10 to 10:10.
It has a previous (lookup) time window of 06:10 to 08:10.
For an activity to be considered pending, the ServiceRequest.occurrence[x]
must be within the ServiceRequest's effective active periods. The effective active periods for a ServiceRequest are the periods of time where it has status
set to active
at the same time as the EpisodeOfCare and CarePlan both have status
set to active
, see https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2524872705/Using+EpisodeOfCare+CarePlan+s+and+ServiceRequest+s#Determining-the-ServiceRequest-Effective-Status. In this particular case, the effective active periods are considered for historic & current status and future status changes, that is, the effective active periods are evaluated based on the statusHistory
and statusSchedule
elements of EpisodeOfCare, CarePlan and ServiceRequest. This is elaborated in the criteria table below.
The criteria for a ServiceRequest to have a pending measurement within the lookup time window depends on ServiceRequest.occurrence[x]
alternative used and are as given in the table below. The table’s Time Criteria and Effect Status Criteria, respectively, are elaborated and exemplified in similarly named subsections below.
|
|
|
|
---|---|---|---|
Data type |
|
|
|
Time Criteria |
|
|
|
Effective Status Criteria |
|
|
|
Time Criteria
The following three diagrams show 8 examples of ServiceRequest that use different variants of occurrenceDateTime
/occurrencePeriod
/occurrenceTiming
as the periodic lookup progresses along a timeline. This helps visualize when the above-mentioned criteria are satisfied and thus, when a reminder will be automatically generated for the pending activities.
O - Annotates a
dayOfWeek
/timeOfDay
-combinationX - Annotates the dateTime in an
occurrenceDateTime
Red - Annotates that the occurrence will not result in a reminder being generated in the current lookup time window.
Green - Annotates that the occurrence will result in a reminder being generated in the current lookup time window.
Current Time Window = t0
In the first diagram, the 1. ServiceRequest example is the only one to result in reminder generation
This is due to it being an
occurrencePeriod
with the start of the period being inside the previous time window.
Some things to note about the examples that will not result in reminder generation this lookup:
The 2. ServiceRequest example will not result in a reminder during this lookup time window as its start is after the beginning of the current time window. However, in the next lookup its situation should be the same as for the 1. ServiceRequest example above.
While 6. ServiceRequest has a
boundsPeriod
that starts before the current window, it is anoccurrenceTiming
and therefore also needs adayOfWeek
/timeOfDay
-combination within the current or previous time windows to result in reminder generation. This is not the case for the current lookup time window. However, in a later lookup it should result in a reminder when adayOfWeek
/timeOfDay
-combination coincides with a "current" time window.Additionally, while 7. ServiceRequest example has a
dayOfWeek
/timeOfDay
-combination within the current time window, theboundsPeriod
did not start before the current window, as is required.
Current Time Window = t+1
The periodic lookup has now progressed by one time frame and what was in the last lookup considered the “next” time window is now the current one.
In this lookup multiple of the occurrences result in the generation of reminders
2. ServiceRequest example is an
occurrencePeriod
and from the perspective of the current time window the start of the period is now in the previous time window3. ServiceRequest example is an
occurrenceTiming
. TheboundsPeriod
of the timing starts before the beginning of the current window, and additionally there is adayOfWeek
/timeOfDay
-combination within theboundsPeriod
and current time window.7. ServiceRequest example is very much like 3. ServiceRequest example, however, the
dayOfWeek
/timeOfDay
-combination is within the previous time window.When a
boundsPeriod
of a Timing starts in the previous time window, thedayOfWeek
/timeOfDay
-combinations from the previous time window will also result in reminder generation.
8. ServiceRequest example will also result in reminder generation during this lookup as it is now within the previous time window.
Current Time Window = t+2
The periodic lookup has now progressed by two time frames since the lookup shown in the first diagram.
In this lookup multiple of the occurrences result in the generation of reminders
4. ServiceRequest example will result in a reminder. When an
occurrencePeriod
starts and ends in the previous time window it will generate a reminder.5. ServiceRequest example is now in the same situation as 1. ServiceRequest example and 2. ServiceRequest example were earlier (period start in the previous time window and end after the beginning of the current time window).
6. ServiceRequest example will now result in a reminder as there is a
dayOfWeek
/timeOfDay
-combination in the current time window.
Effective Status Criteria
The following three diagrams visualize how ServiceRequest effective periods of status
set to active
are found and evaluated. The ServiceRequest, CarePlan and EpisodeOfCare all maintain a status history and schedule, which is used to find the active periods where all three related resources had/have status
value active
at the same time.
In the diagram below is an example of how the active periods are found for a resource, based on the
statusHistory
and astatusSchedule
.Marked with a vertical starting line and a following horizontal line are the period of a
status
(The color depends on status: yellow=draft, green=active, orange=on-hold)Dotted line represents an open ended period (in
statusHistory
this means that the status is the one currently held by the resource)
Marked with X are the
statusSchedule
of the resource, marking the intended change to a given status at that time (The color scheme is the same as for the periods).The vertical grey dotted lines show the bounds of the found active periods of the resource.
For the reminder check, a status period is considered as exclusive-end. This is because the end time of a period is the same as the start time of a new status, which at that time then takes precedent over the old status.
For the above example the active periods for the resource are found by:
First one is the started by the ongoing active period and ended by the first scheduled
on-hold
status.The second one is entirely outlined by the
statusSchedule
as it starts when the status is scheduled to becomeactive
and ends at the time of the next scheduled status change, in this case toon-hold
.
When the active periods for the individual related resources have been found, one can find the effective active periods of the ServiceRequest, which is the active periods that it has in common with its related CarePlan and EpisodeOfCare. This is visualized in the diagram below.
Periods 6 and 7 are the found effective active periods of the ServiceRequest - The other periods represent individual resources active periods.
The grey vertical dotted lines show which resource’s active period is the bounding factor for the effective active period.
For example: For Period 6 one can see that Period 4, the ServiceRequest active period, is much bigger than the effective active period. This is because of the late start of Period 3 in the CarePlan and the early end of Period 1 in the EpisodeOfCare, which becomes the bounding factor for the effective active period.
In the diagram below are 6 examples of ServiceRequest that use different variants of occurrenceDateTime
/occurrencePeriod
/occurrenceTiming
. This helps visualize when the earlier-mentioned criteria are satisfied for both the time windows and the active periods, and thus, when a reminder will be automatically generated for the pending activities.
The two active periods shown at the top of the time windows represent the periods of time where the ServiceRequest, CarePlan and EpisodeOfCare are all active and thus the time that the
ServiceRequest.occurrence[x]
should to some degree overlap.
The
ServiceRequest.occurrence[x]
examples marked green are the ones that will result in reminder generation. (Note: All examples adhere to the given time window criteria for reminder generation)The
occurrenceDateTime
in example 1 will NOT result in a reminder as it is not within an active period, even though it is in the previous time window.In example 2 on the other hand the
occurrenceDateTime
uphold both being within an active period and being in the previous time window and will therefore result in a reminder.The
occurrencePeriod
in example 3 will NOT result in reminder generation as it does not overlap any active period.The
occurrencePeriod
in example 4 overlaps with an active period. Therefore, even though the active period is after the current lookup time window, it results in a reminder being generated.For
occurrenceTiming
the it is the thedayOfWeek
/timeOfDay
-combinations that should be in an active period. For that reason example 5 will NOT result in reminder generation.Lastly, in example 6 the
occurrenceTiming
has adayOfWeek
/timeOfDay
-combination within an active period, which results in reminder generation.
Having identified a pending measurement, the infrastructure creates an ehealth-message type Communication with the Patient as recipient, unless such creation has been suppressed (see Controlling Creation of Messages).
Communication Element | Value |
---|---|
| Coding for |
|
|
|
|
|
|
|
|
| current date/time |
| Coding for No medium set when the |
| The Patient |
| Device reference for eHealth Infrastructure Device |
When possible, the created Communication leads to a NemSMS text notification to the Citizen. Prerequisite to this is that the citizen has subscribed to NemSMS and that the citizen has not suppressed generation of such message (see https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2415034369/Controlling+Creation+of+Messages#Controlling-Message-Creation-with-Patient-as-Recipient).
Validation of SSL orders when activating a CarePlan
When a CarePlan changes status
to active
, the infrastructure checks if any related SSL orders are still undelivered. If this is the case, then the Patient may still be missing necessary equipment. The infrastructure creates a task with category: OpenSSLOrder for the CareTeam to check if any equipment is missing and if necessary delay the activation of the CarePlan or adjust the measurement regime for specific measurement.
Automated Application of Planned Changes (EpisodeOfCare, CarePlan and ServiceRequest)
Scheduled changes in EpisodeOfCare, CarePlan and ServiceRequest are applied during an automatic job which runs at a regular interval.
Upon job execution, the job finds all ServiceRequest, CarePlan and EpisodesOfCare that have unhandled
statusSchedule
orteamSchedule
entries planned for a timestamp between this execution and the previous one.The scheduled changes are then applied to the resources, so that they are up to date with their latest scheduled change.
Task Created by the Infrastructure
The Infrastructure automatically creates Task resources of profile ehealth-task in different situations.
Overview of Task created by the Infrastructure
The following table provides an overview of Tasks produced by the Infrastructure. For more detailed information follow the link in the reference column.
Situation/trigger | Task.category | Reference |
---|---|---|
Measurement submitted at unexpected time | UnexpectedMeasurementResolving | |
Missing measurement | MissingMeasurementResolving | |
Measurement submitted with Data Absent Reason | MeasurementForAssessmentAbsentValue | |
Automated processing rule: FallbackRule | MeasurementForAssessment | |
Automated processing rule: Assessment of Absolute Reference Ranges
| MeasurementForAssessment | |
Automated processing rule: Assessment of Absolute Reference Ranges
| MeasurementForAssessment | |
Automated processing rule: Assessment of Absolute Reference Ranges
| Creates two tasks:
| |
Automated processing rule: Assessment of Absolute Reference Ranges
| Creates two tasks:
| |
Automated processing rule: Assessment of Relative Reference Ranges
| MeasurementForAssessment | |
Automated processing rule: Assessment of Relative Reference Ranges
| MeasurementForAssessmentNotTriaged | |
Automated processing rule: Assessment of Relative Reference Ranges
| Creates two tasks:
| |
Automated processing rule: Assessment of Relative Reference Ranges
| Creates two tasks:
| |
Automated processing rule: Assessment of Questionnaire Response | MeasurementForAssessment | |
Automated processing rule: Assessment of Questionnaire Response
| MeasurementForAssessmentNotTriaged | |
Automated processing rule: Assessment of TeleCare Nord COPD Questionnaire | MeasurementForAssessment | |
When a CarePlan has been activated and there is an open SSL Order | OpenSSLOrder | |
When expiration date for device calibration has exceeded | CalibrationNeeded |
Task Created for Calibration of Equipment
Some equipment needs to be periodically calibrated to ensure precise measurements. The Device service runs a nightly job that checks if any devices are in need of calibration. If that is the case then a Task is created with category
set to CalibrationNeeded
. The Task is assigned to the CareTeam(s) for the CarePlan that currently uses the Device.
Communication Created by the Infrastructure
The Infrastructure automatically creates Communication resources of profile ehealth-message in different situations.
Overview of Communication created by the Infrastructure
The following table provides an overview of Communication (of profile ehealth-message) produced by the Infrastructure and how creation and suppression of creation can be controlled with CommunicationRequest.
For information regarding how to control creation and content of Communcations see Controlling Creation of Messages .
The table does not provide all elements of neither Communication nor CommunicationRequest. Please consult particular sections corresponding to the situations for details. Element <some element name> describes what values are used in a Communication in the specific situation.
Situation/trigger | Created by Default | Opt-in Supported | Opt-out Supported | Element category | Element reasonCode | Element restriction-category | Element medium | Element recipient | Element recipientCareteam |
---|---|---|---|---|---|---|---|---|---|
Measurement submitted at unexpected time | No | Yes | No |
|
|
| One Communication for each CareTeam associated with the CarePlan and have opted in. | ||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Automated processing rule requests Communication(s) to be made. | Yes | No | Yes |
| Can vary with the automated processing rule. See exection of rule and output in https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/538935313/Behind+the+Scenes#Execution-of-rule-and-output . | One Communication for each CareTeam associated with the CarePlan which has not opted out. | |||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Missing measurement | Yes | No | Yes |
|
|
| One Communication for each CareTeam associated with the CarePlan which has not opted out. | ||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Creation of EpisodeOfCare | Yes | No | Yes |
|
| No value assigned | One Communication for each CareTeam associated with the CarePlan which has not opted out. | ||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Creation of CarePlan ($apply) | Yes | No | Yes |
|
| No value assigned | One Communication for each CareTeam associated with the CarePlan which has not opted out. | ||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Change in CarePlan of CareTeam, scheduled CareTeam, status or scheduled status | Yes | No | Yes |
|
| No value assigned | One Communication for each CareTeam associated with the CarePlan which has not opted out. | ||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Change in EpisodeOfCare of CareTeam, scheduled CareTeam, status or scheduled status | Yes | No | Yes |
|
| No value assigned | One Communication for each CareTeam in EpisodeOfCare.team which has not opted out. | ||
No | Yes | No | Default: none Can be overridden with CommunicationRequest | Patient | |||||
Reminder to submit measurement | Yes | No | Yes |
|
| No value assigned |
Can be overridden with CommunicationRequest | Patient | |
If a contract has a reminder days setup and a matching order/orderline have an agreedDateFrom – reminder days = current day | Yes | No | No |
|
|
|
| Patient |
Currently, there are no automated processing rules - neither ready for production or slated for production - that specifies or requests creation of Communication.
Communication Created on Creation of EpisodeOfCare and CarePlan
When an EpisodeOfCare is created with $create-episode-of-care, two ehealth-message type Communication are automatically created. These correspond to the Communication created for change of EpisodeOfCare status and team, respectively.
When a CarePlan is created with $apply performed on a PlanDefinition, two ehealth-message type Communication are automatically created. These correspond to the Communication created for change of CarePlan status and team, respectively. Such a pair of Communication is created for each sub-CarePlan.
Communication Created on Change of EpisodeOfCare and CarePlan Status, CareTeam, Scheduled Status and/or Scheduled CareTeam
The EpisodeOfCare and CarePlan have been extended with elements ehealth-episodeofcare-statusschedule
and ehealth-teamschedule
which capture:
planned changes in
EpisodeOfCare.status
andEpisodeOfCare.team
planned changes in
CarePlan.status
andCarePlan.careTeam
When one of the following elements in CarePlan/EpisodeOfCare is changed, then an ehealth-message type Communication is automatically created.
status
team
ehealth-episodeofcare-statusschedule
health-teamschedule
Communication created with Patient as recipient
Resource | Element | Value |
---|---|---|
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
payload.content | One of:
| |
ehealth-title | One of:
| |
topic | Reference to EpisodeOfCare or CarePlan, depending on situation | |
sent | current date/time | |
recipient | The Patient | |
sender | Device reference for eHealth Infrastructure Device |
Communication created with CareTeam as recipient
Resource | Element | Value |
---|---|---|
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
payload.content | One of:
| |
ehealth-title | One of:
| |
topic | Reference to EpisodeOfCare or CarePlan, depending on situation | |
sent | current date/time | |
ehealth-communication-recipientCareTeam | The CareTeam | |
sender | Device reference for eHealth Infrastructure Device |
Communication Created as Reminder for Participation in Appointment
Communication with Patient as recipient
Resource | Element | Value |
---|---|---|
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
payload.content | One of:
(Unless otherwise stated by matching CommunicationRequest) | |
sent | current date/time | |
medium | Coding for | |
recipient | The Patient | |
sender | Device reference for eHealth Infrastructure Device |
Communication with CareTeam as recipient
Resource | Element | Value |
---|---|---|
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
payload.content | One of:
(Unless otherwise stated by matching CommunicationRequest) | |
sent | current date/time | |
medium | Coding for | |
recipient | The CareTeam | |
sender | Device reference for eHealth Infrastructure Device |
Communication Created as NemSMS Notification on Message Type Communication
Communication with Patient as recipient
Resource | Element | Value |
---|---|---|
Communication (of profile ehealth-message) | category | Coding for |
status |
| |
payload.content | “Du har modtaget en ny besked. Se den i din telemedicinske løsning.” | |
about | The Communication resource that caused this notification | |
sent | current date/time | |
recipient | The Patient | |
sender | Device reference for eHealth Infrastructure Patient |
Sharing through Registering Documents in National Document Sharing Infrastructure
Some FHIR resources in the eHealth Infrastructure are assembled to volatile FHIR Compositions (as described in https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2242281473/Performing+Document+Query+and+Retrieve+and+Using+Transformations#Preparing-Transformations-by-Assembling-Required-FHIR-Resources), transformed to Danish profiles of Clinical Document Architecture (CDA) documents (as described in https://ehealth-dk.atlassian.net/wiki/spaces/EDTW/pages/2242281473/Performing+Document+Query+and+Retrieve+and+Using+Transformations#Transformation-Details), and registered in the national health document sharing archives. This way, the health data registered can be accessed by the patient and other healthcare professionals through other health systems whilst subjected to various access controls and audit logging.
This description focuses on the criteria for this registering to take place.
Document Registering of Measurements
Submitted measurements, whether in the form Observation, QuestionnaireResponse or Media, are each associated with a ServiceRequest. As part of being evaluated by a Practitioner, each measurement can be approved for sharing in the form of a ClinicalImpression with element ehealth-clinicalimpression-decision
set to a Coding for approved-for-sharing
.
The criteria for registering a measurement as document are:
The
ServiceRequest.ehealth-sharingPolicy
must specify sharing allowed and, currently, that this is sharing with a national health archive as destinationThere must exist a ClinicalImpression referring to the measurement with
ClinicalImpression.ehealth-clinicalimpression-decision
set to a Coding forapproved-for-sharing
The measurement must be an Observation or QuestionnaireResponse
For a QuestionnaireResponse it must be a response to a Questionnaire:
for which a representation as Danish profile of CDA Questionnaire Form Definition Document (QFDD) exists
for which the location of the QFDD is known in the infrastructure.
For an Observation, it must not specify a data absent reason (
.dataAbsentReason
). Observations without a value can't be document shared with CDA Personal Health Monitoring Report (PHMR).
An Observation is registered as a Danish profile of the CDA Personal Health Monitoring Report (PHMR) document and a QuestionnaireResponse as a Danish profile of the CDA Questionnaire Response Document (QRD) document.
How must the location of externally accessible QFDD be known to the infrastructure? There shall be a:
FHIR Composition (profile ehealth-composition) with:
Composition.section.entry
which is a reference to the FHIR Questionnaire corresponding to the QFDD representationComposition.section.entry
which is a reference to a DocumentReference (theReference.type
shall be"DocumentReference"
)
FHIR DocumentReference (profile ehealth-documentreference) referenced as above with:
DocumentReference.content.attachment.url which is expected to provide the location of the QFDD
Document Registering of Appointments
A created or updated Appointment (whether of profile ehealth-appointment or ehealth-videoappointment) are registered as the Danish profile of the CDA Appointment Document (APD), provided that criteria are met.
The criteria for registering an Appointment resource are:
The
Appointment.ehealth-legalBasis
must be present and designate a legal basis for which national document sharing infrastructure has been established - currently this is the case for Healthcare Act only.The
Appointment.ehealth-releasebleResource
must, if present, be set to true.The Appointment has exactly one Patient as participant
Importing of Organization Data
The periodic importing of Organization data is described in Organization import and synchronization .