eHealth Infrastructure
3.3.0 - release Denmark flag

This page is part of the FUT Infrastructure (v3.3.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: ehealth-library

Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library Version: 3.3.0
Active as of 2024-11-05 Computable Name: ehealth-library

Introduction

The Library resource is a general-purpose container for knowledge asset definitions. It can be used to describe and expose existing knowledge assets such as logic libraries and information model descriptions, as well as to describe a collection of knowledge assets.

Scope and Usage

In scope of the eHealth Infrastructure, the Library resource is used for:

  • specifying clinical decision rules
    • used for calculating situational context
    • used for calculating operational context
    • used for evaluating measurements and triaging based on this evaluation
  • specifying input and output parameters for clinical decision rules

Defining clinical decision rules

The clinical decision rules are defined as JBoss Drools rules and are stored in the content structure as a base64 encoded string. When defining the rule it is important that the rule package is set to "rules".

Input and output parameters used by the rule should be defined in the parameters structure with the use element set to the appropriate type of parameter. Only one output type should be defined. In the rule logic the output parameter should be defined as a global variable with the name "result".

It is important that the input and output parameters defined in the Library resource corresponds to the input and output parameters defined in the clinical decision rule logic. The eHealth infrastructure wont be able to execute a rule if any inconsistency exists.

When defining a rule to be used for evaluation of Observation resources, it is possible to specify that historical Observation resources with the same ServiceRequest reference should be used as input to the rule. This is done using the dataRequirement structure where the dateFilter.valueDuration is set. Observation resources where the effective element is overlapping this duration is given as input to the rule.

Invoke clinical decision rules

The clinical decision rules used for calculating situational and operational context can be invoked using the evaluate operation on the specific Library resource. Evaluation of submitted measurements will be invoked automatic and asynchronous. The eHealth Infrastructure will create the relevant ClinicalImpression, Task and Communication resources based on the automatic evaluation of submitted measurements.

Use of Library resources at time of decision support rules invocation

The decision support rule Library can be associated with a CarePlan / ServiceRequest through their references to PlanDefinition / ActivityDefinition resources. When a measurement is submitted in scope of a CarePlan, the answer values in a submitted QuestionnaireResponse can be found and passed in as parameters to the decision support rule as specified by the Library resources.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library Library
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... revision 1..1 string Business revision
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
.... modifierRole 1..1 (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... version 1..1 string Business version of the library
... type 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type (required)
.... code 1..1 Coding Type of context being specified
Binding: http://ehealth.sundhed.dk/vs/usage-context-type (required)
... jurisdiction 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction (required)
... parameter 1..* ParameterDefinition Parameters defined by the library

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Library.typerequiredLibraryType
http://ehealth.sundhed.dk/vs/library-type
from this IG
Library.useContext.coderequiredhttp://ehealth.sundhed.dk/vs/usage-context-type
http://ehealth.sundhed.dk/vs/usage-context-type
Library.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... revision 1..1 string Business revision
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
.... modifierRole 1..1 (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type (required)
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction (required)
... parameter 1..* ParameterDefinition Parameters defined by the library

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typerequiredLibraryType
http://ehealth.sundhed.dk/vs/library-type
from this IG
Library.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... revision 1..1 string Business revision
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
.... modifierRole 1..1 (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the library
... version Σ 1..1 string Business version of the library
... name ΣC 0..1 string Name for this library (computer friendly)
... title Σ 0..1 string Name for this library (human friendly)
... subtitle 0..1 string Subordinate title of the library
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type (required)
... subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the library
... useContext Σ 0..* UsageContext The context that the content is intended to support
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code Σ 1..1 Coding Type of context being specified
Binding: http://ehealth.sundhed.dk/vs/usage-context-type (required)
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction (required)
... purpose 0..1 markdown Why this library is defined
... usage 0..1 string Describes the clinical usage of the library
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed
... effectivePeriod Σ 0..1 Period When the library is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... parameter 1..* ParameterDefinition Parameters defined by the library
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content Σ 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typerequiredLibraryType
http://ehealth.sundhed.dk/vs/library-type
from this IG
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
Library.useContext.coderequiredhttp://ehealth.sundhed.dk/vs/usage-context-type
http://ehealth.sundhed.dk/vs/usage-context-type
Library.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
Library.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

Differential View

This structure is derived from Library

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library Library
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... revision 1..1 string Business revision
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
.... modifierRole 1..1 (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... version 1..1 string Business version of the library
... type 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type (required)
.... code 1..1 Coding Type of context being specified
Binding: http://ehealth.sundhed.dk/vs/usage-context-type (required)
... jurisdiction 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction (required)
... parameter 1..* ParameterDefinition Parameters defined by the library

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Library.typerequiredLibraryType
http://ehealth.sundhed.dk/vs/library-type
from this IG
Library.useContext.coderequiredhttp://ehealth.sundhed.dk/vs/usage-context-type
http://ehealth.sundhed.dk/vs/usage-context-type
Library.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... revision 1..1 string Business revision
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
.... modifierRole 1..1 (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type (required)
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction (required)
... parameter 1..* ParameterDefinition Parameters defined by the library

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typerequiredLibraryType
http://ehealth.sundhed.dk/vs/library-type
from this IG
Library.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Library C 0..* Library Represents a library of quality improvement components
lib-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... intendedAudience 0..* Reference(ehealth-organization) {r} The intended audience of the resource
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience
.... revision 1..1 string Business revision
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision
.... modifierRole 1..1 (Complex) Modifier role
URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 0..1 uri Canonical identifier for this library, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the library
... version Σ 1..1 string Business version of the library
... name ΣC 0..1 string Name for this library (computer friendly)
... title Σ 0..1 string Name for this library (human friendly)
... subtitle 0..1 string Subordinate title of the library
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ 0..1 boolean For testing purposes, not real usage
... type Σ 1..1 CodeableConcept logic-library | model-definition | asset-collection | module-definition
Binding: Library Type (required)
... subject[x] 0..1 Type of individual the library content is focused on
Binding: SubjectType (extensible): The possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).

.... subjectCodeableConcept CodeableConcept
.... subjectReference Reference(Group)
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the library
... useContext Σ 0..* UsageContext The context that the content is intended to support
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... code Σ 1..1 Coding Type of context being specified
Binding: http://ehealth.sundhed.dk/vs/usage-context-type (required)
.... value[x] Σ 1..1 Value that defines the context
Binding: Context of Use ValueSet (example): A code that defines the specific value for the context being specified.

..... valueCodeableConcept CodeableConcept
..... valueQuantity Quantity
..... valueRange Range
..... valueReference Reference(PlanDefinition | ResearchStudy | InsurancePlan | HealthcareService | Group | Location | Organization)
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for library (if applicable)
Binding: Jurisdiction (required)
... purpose 0..1 markdown Why this library is defined
... usage 0..1 string Describes the clinical usage of the library
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the library was approved by publisher
... lastReviewDate 0..1 date When the library was last reviewed
... effectivePeriod Σ 0..1 Period When the library is expected to be used
... topic 0..* CodeableConcept E.g. Education, Treatment, Assessment, etc.
Binding: DefinitionTopic (example): High-level categorization of the definition, used for searching, sorting, and filtering.


... author 0..* ContactDetail Who authored the content
... editor 0..* ContactDetail Who edited the content
... reviewer 0..* ContactDetail Who reviewed the content
... endorser 0..* ContactDetail Who endorsed the content
... relatedArtifact 0..* RelatedArtifact Additional documentation, citations, etc.
... parameter 1..* ParameterDefinition Parameters defined by the library
... dataRequirement 0..* DataRequirement What data is referenced by this library
... content Σ 0..* Attachment Contents of the library, either embedded or referenced

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Library.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Library.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
Library.typerequiredLibraryType
http://ehealth.sundhed.dk/vs/library-type
from this IG
Library.subject[x]extensibleSubjectType
http://hl7.org/fhir/ValueSet/subject-type
from the FHIR Standard
Library.useContext.coderequiredhttp://ehealth.sundhed.dk/vs/usage-context-type
http://ehealth.sundhed.dk/vs/usage-context-type
Library.useContext.value[x]exampleContext of Use ValueSet
http://hl7.org/fhir/ValueSet/use-context
from the FHIR Standard
Library.jurisdictionrequiredJurisdiction
http://ehealth.sundhed.dk/vs/jurisdiction
from this IG
Library.topicexampleDefinitionTopic
http://hl7.org/fhir/ValueSet/definition-topic
from the FHIR Standard

 

Other representations of profile: CSV, Excel, Schematron