eHealth Infrastructure
latest - ci-build
eHealth Infrastructure
latest - ci-build
eHealth Infrastructure - Local Development build (vlatest) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library | Version: latest | |||
| Active as of 2024-05-08 | Computable Name: ehealth-library | |||
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 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.
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 / 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Library
| Path | Conformance | ValueSet | URI |
| Library.type | required | LibraryTypehttp://ehealth.sundhed.dk/vs/library-typefrom this IG | |
| Library.useContext.code | required | http://ehealth.sundhed.dk/vs/usage-context-typehttp://ehealth.sundhed.dk/vs/usage-context-type | |
| Library.jurisdiction | required | Jurisdictionhttp://ehealth.sundhed.dk/vs/jurisdictionfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Library | C | 0..* | Library | Represents a library of quality improvement components |
  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 |
| version | Σ | 1..1 | string | Business version of the library |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Library.type | required | LibraryTypehttp://ehealth.sundhed.dk/vs/library-typefrom this IG | |
| Library.jurisdiction | required | Jurisdictionhttp://ehealth.sundhed.dk/vs/jurisdictionfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components | ||||
| 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.
| |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Library.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Library.type | required | LibraryTypehttp://ehealth.sundhed.dk/vs/library-typefrom this IG | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| Library.useContext.code | required | http://ehealth.sundhed.dk/vs/usage-context-typehttp://ehealth.sundhed.dk/vs/usage-context-type | ||||
| Library.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextfrom the FHIR Standard | ||||
| Library.jurisdiction | required | Jurisdictionhttp://ehealth.sundhed.dk/vs/jurisdictionfrom this IG | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard |
This structure is derived from Library
Differential View
This structure is derived from Library
| Path | Conformance | ValueSet | URI |
| Library.type | required | LibraryTypehttp://ehealth.sundhed.dk/vs/library-typefrom this IG | |
| Library.useContext.code | required | http://ehealth.sundhed.dk/vs/usage-context-typehttp://ehealth.sundhed.dk/vs/usage-context-type | |
| Library.jurisdiction | required | Jurisdictionhttp://ehealth.sundhed.dk/vs/jurisdictionfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components |
| 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 |
| version | Σ | 1..1 | string | Business version of the library |
| 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 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | |
| Library.type | required | LibraryTypehttp://ehealth.sundhed.dk/vs/library-typefrom this IG | |
| Library.jurisdiction | required | Jurisdictionhttp://ehealth.sundhed.dk/vs/jurisdictionfrom this IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Library | C | 0..* | Library | Represents a library of quality improvement components | ||||
| 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.
| |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Library.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Library.status | required | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1from the FHIR Standard | ||||
| Library.type | required | LibraryTypehttp://ehealth.sundhed.dk/vs/library-typefrom this IG | ||||
| Library.subject[x] | extensible | SubjectTypehttp://hl7.org/fhir/ValueSet/subject-typefrom the FHIR Standard | ||||
| Library.useContext.code | required | http://ehealth.sundhed.dk/vs/usage-context-typehttp://ehealth.sundhed.dk/vs/usage-context-type | ||||
| Library.useContext.value[x] | example | Context of Use ValueSethttp://hl7.org/fhir/ValueSet/use-contextfrom the FHIR Standard | ||||
| Library.jurisdiction | required | Jurisdictionhttp://ehealth.sundhed.dk/vs/jurisdictionfrom this IG | ||||
| Library.topic | example | DefinitionTopichttp://hl7.org/fhir/ValueSet/definition-topicfrom the FHIR Standard |
This structure is derived from Library
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ Den telemedicinske infrastruktur (eHealth Infrastructure). Package dk.ehealth.sundhed.fhir.ig.core#latest based on FHIR 4.0.1. Generated 2024-05-08
