eHealth Infrastructure (v2019.5.2)
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:
A Library resource defining a decision support rule is really capturing metadata about
the rule rather than the rule logic itself. The rule is identified by identifier, version,
and ehealth-revision while the input and output parameters are specified in the structure named parameter.
In order to support organizations in defining of Library for use in their organizational context,
the element intendedAudience has been added.
This kind of Library has type set to logic-library (Coding system omitted).
A separate Library is used for defining what values to pass in as input parameters when invoking a decision support rule (as defined by another Library resource).
The Library defining the binding identifies the decision support rule Library resource
through the extension basedOn. The binding between the decision support rule parameters and
the source from which to get a value is defined in the extension parameterBinding.
It is important that the binding defines value sources for each of the input parameters defined in the decision support rule Library resource and that the parameter names and types are correct.
In the parameterBinding elements, a Questionnaire can be referenced through the element
resource and identified with identifier, version and ehealth-revision. The particular questionnaire
question to use as binding for a decision support rule parameter is specified in linkId.
This kind of Library has type set to module-definition (Coding system omitted).
The binding and decision support rule Library resources 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 Wed May 29 18:05:58 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
Summary
Mandatory: 4 elements
Extensions
This structure refers to these extensions:
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-library-basedOn | 0..1 | Reference(eHealth Library) {r} | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-basedOn | |
| ehealth-intendedAudience | 0..* | Reference(eHealth Organization) {r} | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
 ehealth-library-parameterBinding | 0..* | (Complex) | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterBinding | |
| 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 | ||
 parameter | 1..* | ParameterDefinition | ||
 extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| ehealth-library-parameterName | 0..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterName | |
| 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) | |
| 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-library-basedOn | 0..1 | Reference(eHealth Library) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-basedOn | |
| ehealth-intendedAudience | 0..* | Reference(eHealth Organization) {r} | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
| ehealth-library-parameterBinding | 0..* | (Complex) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterBinding | |
| ehealth-revision | 1..1 | string | Extension 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 | |
 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 Binding: LibraryType (extensible) |
| 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 | |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-library-parameterName | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterName | |
| name | Σ | 0..1 | code | Name used to access the parameter value |
| use | Σ | 1..1 | code | in | out Binding: OperationParameterUse (required) |
| min | Σ | 0..1 | integer | Minimum cardinality |
| max | Σ | 0..1 | string | Maximum cardinality (a number of *) |
| documentation | Σ | 0..1 | string | A brief description of the parameter |
| type | Σ | 1..1 | code | What type of value Binding: FHIRAllTypes (required) |
 profile | Σ | 0..1 | Reference(StructureDefinition) | What profile the value is expected to be |
| 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
Summary
Mandatory: 4 elements
Extensions
This structure refers to these extensions:
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-library-basedOn | 0..1 | Reference(eHealth Library) {r} | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-basedOn | |
| ehealth-intendedAudience | 0..* | Reference(eHealth Organization) {r} | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
| ehealth-library-parameterBinding | 0..* | (Complex) | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterBinding | |
| 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 | ||
| parameter | 1..* | ParameterDefinition | ||
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| ehealth-library-parameterName | 0..1 | string | Optional Extensions Element URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterName | |
| 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) | |
| 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-library-basedOn | 0..1 | Reference(eHealth Library) {r} | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-basedOn | |
| ehealth-intendedAudience | 0..* | Reference(eHealth Organization) {r} | The intended audience of the library URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-intendedAudience | |
| ehealth-library-parameterBinding | 0..* | (Complex) | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterBinding | |
| ehealth-revision | 1..1 | string | Extension 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 | |
| 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 Binding: LibraryType (extensible) |
| 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 | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| ehealth-library-parameterName | 0..1 | string | Extension URL: http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-library-parameterName | |
| name | Σ | 0..1 | code | Name used to access the parameter value |
| use | Σ | 1..1 | code | in | out Binding: OperationParameterUse (required) |
| min | Σ | 0..1 | integer | Minimum cardinality |
| max | Σ | 0..1 | string | Maximum cardinality (a number of *) |
| documentation | Σ | 0..1 | string | A brief description of the parameter |
| type | Σ | 1..1 | code | What type of value Binding: FHIRAllTypes (required) |
| profile | Σ | 0..1 | Reference(StructureDefinition) | What profile the value is expected to be |
| 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 | Name | Conformance | ValueSet |
| Library.language | Common Languages | extensible | Common Languages |
| Library.status | PublicationStatus | required | PublicationStatus |
| Library.type | LibraryType | extensible | LibraryType |
| Library.jurisdiction | Jurisdiction ValueSet | extensible | Jurisdiction ValueSet |
| Library.topic | DefinitionTopic | example | DefinitionTopic |
| Library.parameter.use | OperationParameterUse | required | OperationParameterUse |
| Library.parameter.type | FHIRAllTypes | required | FHIRAllTypes |
| 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() |