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.
In scope of the eHealth Infrastructure, the Library resource is used for:
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 ProcedureRequest 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.
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.
The decision support rule Library can be associated with a CarePlan / ProcedureRequest 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.
The official URL for this profile is:
http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library
This profile builds on Library.
This profile was published on Fri Nov 08 13:01:00 UTC 2019 as a draft by ehealth.sundhed.dk.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Library
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 0..* | A general-purpose container for knowledge asset definitions. | ||
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
ehealth-intendedAudience | 0..* | Reference() | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
ehealth-revision | 1..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision | |
ehealth-modifier-role | 1..1 | (Complex) | Maintainers of the library. Identifies practitioners, care teams and organizations and their responsibility as maintainers. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
version | 1..1 | string | ||
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | automated-processing Binding: LibraryType (required) | |
parameter | 1..* | ParameterDefinition | ||
Documentation for this format |
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 0..* | A general-purpose container for knowledge asset definitions. | |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-intendedAudience | I | 0..* | Reference() | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience |
ehealth-revision | I | 1..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision |
ehealth-modifier-role | I | 1..1 | (Complex) | Maintainers of the library. Identifies practitioners, care teams and organizations and their responsibility as maintainers. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Logical URI to reference this library (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | Σ | 0..1 | string | Name for this library (computer friendly) |
title | Σ | 0..1 | string | Name for this library (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | automated-processing Binding: LibraryType (required) |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | Σ | 0..1 | markdown | Natural language description of the library |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
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 |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
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 | |
Documentation for this format |
This structure is derived from Library
Differential View
This structure is derived from Library
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | 0..* | A general-purpose container for knowledge asset definitions. | ||
extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
ehealth-intendedAudience | 0..* | Reference() | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
ehealth-revision | 1..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision | |
ehealth-modifier-role | 1..1 | (Complex) | Maintainers of the library. Identifies practitioners, care teams and organizations and their responsibility as maintainers. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role | |
version | 1..1 | string | ||
type | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | automated-processing Binding: LibraryType (required) | |
parameter | 1..* | ParameterDefinition | ||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Library | I | 0..* | A general-purpose container for knowledge asset definitions. | |
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: Common Languages (extensible) Max Binding: All Languages | |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
ehealth-intendedAudience | I | 0..* | Reference() | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience |
ehealth-revision | I | 1..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-revision |
ehealth-modifier-role | I | 1..1 | (Complex) | Maintainers of the library. Identifies practitioners, care teams and organizations and their responsibility as maintainers. URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-modifier-role |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
url | Σ | 0..1 | uri | Logical URI to reference this library (globally unique) |
identifier | Σ | 0..* | Identifier | Additional identifier for the library |
version | Σ | 1..1 | string | Business version of the library |
name | Σ | 0..1 | string | Name for this library (computer friendly) |
title | Σ | 0..1 | string | Name for this library (human friendly) |
status | ?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required) |
experimental | ?!Σ | 0..1 | boolean | For testing purposes, not real usage |
type | Σ | 1..1 | CodeableConcept | logic-library | model-definition | asset-collection | module-definition | automated-processing Binding: LibraryType (required) |
date | Σ | 0..1 | dateTime | Date this was last changed |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
description | Σ | 0..1 | markdown | Natural language description of the library |
purpose | 0..1 | markdown | Why this library is defined | |
usage | 0..1 | string | Describes the clinical usage of the library | |
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 |
useContext | Σ | 0..* | UsageContext | Context the content is intended to support |
jurisdiction | Σ | 0..* | CodeableConcept | Intended jurisdiction for library (if applicable) Binding: Jurisdiction ValueSet (extensible) |
topic | 0..* | CodeableConcept | E.g. Education, Treatment, Assessment, etc Binding: DefinitionTopic (example) | |
contributor | 0..* | Contributor | A content contributor | |
contact | Σ | 0..* | ContactDetail | Contact details for the publisher |
copyright | 0..1 | markdown | Use and/or publishing restrictions | |
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 | |
Documentation for this format |
Path | Conformance | ValueSet |
Library.language | extensible | Common Languages Max Binding: All Languages |
Library.status | required | PublicationStatus |
Library.type | required | LibraryType |
Library.jurisdiction | extensible | Jurisdiction ValueSet |
Library.topic | example | DefinitionTopic |
Id | Path | Details | Requirements |
dom-2 | Library | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-1 | Library | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
dom-4 | Library | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-3 | Library | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Library.extension | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
ext-1 | Library.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |