3.1. Logical models
Logical Models represent data structures, and contain data elements and their constraints and relationships. They allow data requirements to be described from a functional perspective. In this IG, the functional model is represented by FHIR Logical Models (note that this link redirects to the R5 specification, as there is no dedicated page for Logical Models in the R4 specification). These use FHIR to capture the data structures (namely by specifying a StructureDefinition and underlying ElementDefinitions, for each data structure), but they are not (directly) attached to FHIR resources.
The Logical Models contain all functional concepts, including corresponding datatype, terminology binding (if applicable) and an id.
- For each concept, an id is assigned by MedMij based on the corresponding element in the Mercurius dataset defined by Palga. These ids are also added as mappings in the FHIR profiles, and therefore form the linking pin between Logical Models and FHIR profiles.
- For each concept it is indicated whether it is repeating (i.e. by setting its maximum cardinality to
1or*). Moreover, for each concept it is indicated whether it is (conditionally) required by setting the minimum cardinality to1(or adding a constraint which specifies when the concept is required). - The FHIR datatypes are used in the Logical Models, even though these might bring 'physical' constraints, formats, etc. into the abstract logical data models which are not intended or applicable on the logical level. For instance, elements of the Attachment datatype need to satisfy the att-1 constraint, which states that the element SHALL have a
contentType, provided the element has non-emptydata. Even though this constraint makes sense on a technical level, the aforementioned attributescontentTypeanddataare not present in a logical data model. Therefore, such constraints may be 'ignored' in the Logical Models; instead, these constraints are taken into account in the corresponding FHIR profiles. - Since the Logical Models defined in this IG are meant to represent the use case,
.abstractis set to false. - For all Logical Models the scope is implicitly set to a single patient (with the exception of the Patient Logical Model, in which the scope is explicit). This relation is not explicitly modeled, similar to the approach of the zibs.
3.1.1. Report
| LmTask (pt-lm-Task) | Element | ||
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| ActivityDefinition | C | 0..1 | Reference(ActivityDefinition) |
| BasedOn | C | 0..1 | Reference(ServiceRequest) |
| Status | 0..1 | code | |
| Priority | 0..1 | code | |
| Description | 0..1 | string | |
| ExecutionPeriod | C | 0..1 | Period |
| Requester | C | 0..1 | Reference(Practitioner) |
| Restriction | 0..1 | BackboneElement | |
| id | 0..1 | string | |
| extension | C | 0..* | Extension |
| modifierExtension | Σ ?! C | 0..* | Extension |
| Repetitions | 0..1 | positiveInt | |
| Period | C | 0..1 | Period |
--- We have skipped the narrative for better readability of the resource ---
</text>
</telecom>
</contact>
<description value="Patient-specific task that tells a patient what to do as part of a digital care activity. A Task is shown in the patient’s task list and supports tracking progress and completion over time." />
<purpose value="To represent a patient-facing task for a digital activity, so the patient can see what is expected, when it should be done, and whether it is open or completed. A Task can represent either a main task or a subtask within the same activity." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<definition value="Patient-specific task that tells a patient what to do as part of a digital care activity. A Task is shown in the patient’s task list and supports tracking progress and completion over time." />
</element>
</type>
</element>
<short value="Clinical order that triggered this patient task. May include patient-specific instructions and the requested schedule." />
<definition value="Clinical order that triggered this patient task. May include patient-specific instructions and the requested schedule." />
</type>
</element>
<short value="Current state of the Task in the workflow (e.g., requested, received, accepted, in-progress, completed, cancelled)." />
<definition value="Current state of the Task in the workflow (e.g., requested, received, accepted, in-progress, completed, cancelled)." />
</type>
</element>
<definition value="Indicates how urgent it is to perform the activity (e.g., routine, urgent, asap)." />
</type>
</element>
<short value="Short instruction for the patient describing what to do. Keep the text concise and readable on mobile." />
<definition value="Short instruction for the patient describing what to do. Keep the text concise and readable on mobile." />
</type>
</element>
<definition value="Time window in which the task should be performed (start/end), if applicable." />
</type>
</element>
</type>
</element>
<short value="Optional rules for repetition and limits, if the task must be performed multiple times." />
<definition value="Optional rules for repetition and limits, if the task must be performed multiple times." />
</type>
</element>
</type>
</element>
</type>
</element>
</differential>
</StructureDefinition>
{
--- We have skipped the narrative for better readability of the resource ---
},
{
}
],
"description": "Patient-specific task that tells a patient what to do as part of a digital care activity. A Task is shown in the patient’s task list and supports tracking progress and completion over time.",
"purpose": "To represent a patient-facing task for a digital activity, so the patient can see what is expected, when it should be done, and whether it is open or completed. A Task can represent either a main task or a subtask within the same activity.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
{
"definition": "Patient-specific task that tells a patient what to do as part of a digital care activity. A Task is shown in the patient’s task list and supports tracking progress and completion over time.",
"Taak"
]
},
{
"DigtaleActiviteit"
],
{
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
]
}
]
},
{
"short": "Clinical order that triggered this patient task. May include patient-specific instructions and the requested schedule.",
"definition": "Clinical order that triggered this patient task. May include patient-specific instructions and the requested schedule.",
"GebaseerdOp"
],
{
}
]
},
{
"short": "Current state of the Task in the workflow (e.g., requested, received, accepted, in-progress, completed, cancelled).",
"definition": "Current state of the Task in the workflow (e.g., requested, received, accepted, in-progress, completed, cancelled).",
"Status"
],
]
},
{
"Prioriteit"
],
]
},
{
"short": "Short instruction for the patient describing what to do. Keep the text concise and readable on mobile.",
"definition": "Short instruction for the patient describing what to do. Keep the text concise and readable on mobile.",
"Omschrijving"
],
]
},
{
"Periode"
],
]
},
{
"Aanvrager"
],
{
}
]
},
{
"definition": "Optional rules for repetition and limits, if the task must be performed multiple times.",
"Herhaling"
],
]
},
{
"AantalKeer"
],
]
},
{
"binnenPeriode"
],
]
}
]
}
}
3.1.2. Report
--- We have skipped the narrative for better readability of the resource ---
</text>
</telecom>
</contact>
<description value="Reusable definition of a digital activity (module) that can be selected by a healthcare professional and presented to a patient as part of the care process. The activity describes what the patient will do (e.g., read information, complete a questionnaire, perform a home measurement) and provides the information needed to start or access the activity when applicable." />
<purpose value="To describe a reusable digital activity that can be selected and assigned by a healthcare professional to support the care process for a patient. The activity provides patient-facing content or actions (e.g., information, questionnaires, or home measurements)." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<definition value="Reusable definition of a digital activity (module) that can be selected by a healthcare professional and presented to a patient as part of the care process. The activity describes what the patient will do (e.g., read information, complete a questionnaire, perform a home measurement) and provides the information needed to start or access the activity when applicable." />
</element>
</type>
</element>
<short value="Lifecycle status of the digital activity (e.g., draft, active, retired). A retired activity can no longer be selected or assigned." />
<definition value="Lifecycle status of the digital activity (e.g., draft, active, retired). A retired activity can no longer be selected or assigned." />
</type>
</element>
<short value="Organization responsible for the content/functionality of this digital activity and its maintenance." />
<definition value="Organization responsible for the content/functionality of this digital activity and its maintenance." />
</type>
</element>
</type>
</element>
<short value="Generic recommendation for how often/when the activity is typically performed. Patient-specific scheduling belongs in the clinical order (e.g., ServiceRequest)." />
<definition value="Generic recommendation for how often/when the activity is typically performed. Patient-specific scheduling belongs in the clinical order (e.g., ServiceRequest)." />
</type>
</element>
</differential>
</StructureDefinition>
{
--- We have skipped the narrative for better readability of the resource ---
},
{
}
],
"description": "Reusable definition of a digital activity (module) that can be selected by a healthcare professional and presented to a patient as part of the care process. The activity describes what the patient will do (e.g., read information, complete a questionnaire, perform a home measurement) and provides the information needed to start or access the activity when applicable.",
"purpose": "To describe a reusable digital activity that can be selected and assigned by a healthcare professional to support the care process for a patient. The activity provides patient-facing content or actions (e.g., information, questionnaires, or home measurements).",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
{
"definition": "Reusable definition of a digital activity (module) that can be selected by a healthcare professional and presented to a patient as part of the care process. The activity describes what the patient will do (e.g., read information, complete a questionnaire, perform a home measurement) and provides the information needed to start or access the activity when applicable.",
"Digitale Activiteit"
]
},
{
"Titel"
],
]
},
{
"short": "Lifecycle status of the digital activity (e.g., draft, active, retired). A retired activity can no longer be selected or assigned.",
"definition": "Lifecycle status of the digital activity (e.g., draft, active, retired). A retired activity can no longer be selected or assigned.",
"Status"
],
]
},
{
"short": "Organization responsible for the content/functionality of this digital activity and its maintenance.",
"definition": "Organization responsible for the content/functionality of this digital activity and its maintenance.",
]
},
{
"Omschrijving"
],
]
},
{
"short": "Generic recommendation for how often/when the activity is typically performed. Patient-specific scheduling belongs in the clinical order (e.g., ServiceRequest).",
"definition": "Generic recommendation for how often/when the activity is typically performed. Patient-specific scheduling belongs in the clinical order (e.g., ServiceRequest).",
"Tijdschema"
],
]
}
]
}
}
3.1.3. Report
Command 'tree' could not render: Resource was not found for 'canonical=http://medmij.nl/fhir/StructureDefinition/pt-lm-Endpoint'
Command 'xml' could not render: Resource was not found for 'canonical=http://medmij.nl/fhir/StructureDefinition/pt-lm-Endpoint'
Command 'json' could not render: Resource was not found for 'canonical=http://medmij.nl/fhir/StructureDefinition/pt-lm-Endpoint'
3.1.4. Report
--- We have skipped the narrative for better readability of the resource ---
</text>
</telecom>
</contact>
<description value="Patient-specific clinical order for a digital activity, created by a healthcare professional for a patient." />
<purpose value="To represent a healthcare professional’s clinical order to start or perform a specific digital activity for a patient. The ServiceRequest captures the intended schedule and patient-specific instructions and can serve as the basis for one or more patient-facing Tasks that track execution and completion." />
<copyright value="Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise." />
<definition value="Patient-specific clinical order for a digital activity, created by a healthcare professional for a patient." />
</element>
<short value="Patient-oriented instructions that may differ from or add to the generic activity information (e.g., fasting measurements, preferred timing, preparation steps). These instructions should be shown alongside the Task(s) created from this order." />
<definition value="Patient-oriented instructions that may differ from or add to the generic activity information (e.g., fasting measurements, preferred timing, preparation steps). These instructions should be shown alongside the Task(s) created from this order." />
</type>
</element>
<short value="Requested schedule for performing the activity (e.g., duration, frequency, time of day)." />
<definition value="Requested schedule for performing the activity (e.g., duration, frequency, time of day)." />
</type>
</element>
</type>
</element>
</differential>
</StructureDefinition>
{
--- We have skipped the narrative for better readability of the resource ---
},
{
}
],
"description": "Patient-specific clinical order for a digital activity, created by a healthcare professional for a patient.",
"purpose": "To represent a healthcare professional’s clinical order to start or perform a specific digital activity for a patient. The ServiceRequest captures the intended schedule and patient-specific instructions and can serve as the basis for one or more patient-facing Tasks that track execution and completion.",
"copyright": "Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise.",
{
"definition": "Patient-specific clinical order for a digital activity, created by a healthcare professional for a patient.",
"Zorgopdracht"
]
},
{
"short": "Patient-oriented instructions that may differ from or add to the generic activity information (e.g., fasting measurements, preferred timing, preparation steps). These instructions should be shown alongside the Task(s) created from this order.",
"definition": "Patient-oriented instructions that may differ from or add to the generic activity information (e.g., fasting measurements, preferred timing, preparation steps). These instructions should be shown alongside the Task(s) created from this order.",
"PatiëntenInstructie"
],
]
},
{
"short": "Requested schedule for performing the activity (e.g., duration, frequency, time of day).",
"definition": "Requested schedule for performing the activity (e.g., duration, frequency, time of day).",
"Tijdschema"
],
]
},
{
"Aanvrager"
],
{
}
]
}
]
}
}