eHealth Infrastructure (v2019.6)

StructureDefinition: ehealth-library - Detailed Descriptions

Definitions for the ehealth-library Profile.

1. Library
Definition

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.

Control0..*
InvariantsDefined on this element
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: 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())
dom-4: 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())
2. Library.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

3. Library.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
4. Library.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

5. Library.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Max Binding: All Languages
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

6. Library.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

7. Library.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

8. Library.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices on Library.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
9. Library.extension:intendedAudience
SliceNameintendedAudience
Definition

Specifies that the library is only intended for use in the specified organisations. Leave blank if the library is intended for global use.

Control0..* This element is affected by the following invariants: ele-1
TypeExtension(intendedAudience) (Extension Type: Reference)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. Library.extension:revision
SliceNamerevision
Definition

Optional Extension Element - found in all resources.

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(revision) (Extension Type: string)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
11. Library.extension:modifierRole
SliceNamemodifierRole
Definition

Maintainers of the library. Identifies practitioners, care teams and organizations and their responsibility as maintainers.

Control1..1 This element is affected by the following invariants: ele-1
TypeExtension(modifierRole) (Extension Type: Choice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
12. Library.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

13. Library.url
Definition

An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see Technical and Business Versions.

Control0..1
Typeuri
Requirements

Allows the library to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version.

14. Library.identifier
Definition

A formal identifier that is used to identify this library when it is represented in other formats, or referenced in a specification, model, design or an instance. e.g. CMS or NQF identifiers for a measure artifact. Note that at least one identifier is required for non-experimental active artifacts.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, e.g., to identify this library outside of FHIR, where it is not possible to use the logical URI.

15. Library.version
Definition

The identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the library author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active artifacts.

NoteThis is a business versionId, not a resource version id (see discussion)
Control1..1
Typestring
Comments

There may be different library instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a refrence to a particular business version of the library with the format [url]|[version].

16. Library.name
Definition

A natural language name identifying the library. This name should be usable as an identifier for the module by machine processing applications such as code generation.

Control0..1
Typestring
Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alpha-numeric type name to ensure that it is computable friendly.

17. Library.title
Definition

A short, descriptive, user-friendly title for the library.

Control0..1
Typestring
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

18. Library.status
Definition

The status of this library. Enables tracking the life-cycle of the content.

Control1..1
BindingThe lifecycle status of a Value Set or Concept Map.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue
Comments

Allows filtering of librarys that are appropriate for use vs. not.
This is labeled as "Is Modifier" because applications should not use a retired library without due consideration.

19. Library.experimental
Definition

A boolean value to indicate that this library is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

Control0..1
Typeboolean
Is Modifiertrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level library.

Comments

Allows filtering of library that are appropriate for use vs. not. This is labeled as "Is Modifier" because applications should not use an experimental library in production.

20. Library.type
Definition

Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, Module Definition, or Automated Processing.

Control1..1
BindingThe codes SHALL be taken from LibraryType
TypeCodeableConcept
21. Library.date
Definition

The date (and optionally time) when the library was published. The date must change if and when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the library changes.

Control0..1
TypedateTime
Alternate NamesRevision Date
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the library. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

22. Library.publisher
Definition

The name of the individual or organization that published the library.

Control0..1
Typestring
Requirements

Helps establish the "authority/credibility" of the library. May also allow for contact.

Comments

Usually an organization, but may be an individual. The publisher (or steward) of the library is the organization or individual primarily responsible for the maintenance and upkeep of the library. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the library. This item SHOULD be populated unless the information is available from context.

23. Library.description
Definition

A free text natural language description of the library from a consumer's perspective.

Control0..1
Typemarkdown
Comments

This description can be used to capture details such as why the library was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the library as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the profile is presumed to be the predominant language in the place the profile was created).

24. Library.purpose
Definition

Explaination of why this library is needed and why it has been designed as it has.

Control0..1
Typemarkdown
Comments

This element does not describe the usage of the library Instead it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this library.

25. Library.usage
Definition

A detailed description of how the library is used from a clinical perspective.

Control0..1
Typestring
26. Library.approvalDate
Definition

The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

Control0..1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes / editorial corrections.

27. Library.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.

Control0..1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this is usually after the approval date.

28. Library.effectivePeriod
Definition

The period during which the library content was or is planned to be in active use.

Control0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of a the library are or are expected to be used instead.

Comments

The effective period for a library determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

29. Library.useContext
Definition

The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate library instances.

Control0..*
TypeUsageContext
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation whether all or any of the contexts apply.

30. Library.jurisdiction
Definition

A legal or geographic region in which the library is intended to be used.

Control0..*
BindingCountries and regions within which this artifact is targeted for use
The codes SHALL be taken from Jurisdiction ValueSet; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

It may be possible for the library to be used in jurisdictions other than those for which it was originally designed or intended.

31. Library.topic
Definition

Descriptive topics related to the content of the library. Topics provide a high-level categorization of the library that can be useful for filtering and searching.

Control0..*
BindingHigh-level categorization of the definition, used for searching, sorting, and filtering
For example codes, see DefinitionTopic
TypeCodeableConcept
Requirements

Repositories must be able to determine how to categorize the library so that it can be found by topical searches.

32. Library.contributor
Definition

A contributor to the content of the library, including authors, editors, reviewers, and endorsers.

Control0..*
TypeContributor
Requirements

Consumers of the content must be able to quickly determine who contributed to the content of the library.

33. Library.contact
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactDetail
Comments

May be a web site, an email address, a telephone number, etc.

34. Library.copyright
Definition

A copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.

Control0..1
Typemarkdown
Requirements

Consumers must be able to determine any legal restrictions on the use of the library and/or its content.

Alternate NamesLicense, Restrictions
35. Library.relatedArtifact
Definition

Related artifacts such as additional documentation, justification, or bibliographic references.

Control0..*
TypeRelatedArtifact
Requirements

Libraries must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

Comments

Each related artifact is either an attachment, or a reference to another resource, but not both.

36. Library.parameter
Definition

The parameter element defines parameters used by the library.

Control1..*
TypeParameterDefinition
37. Library.dataRequirement
Definition

Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.

Control0..*
TypeDataRequirement
38. Library.content
Definition

The content of the library as an Attachment. The content may be a reference to a url, or may be directly embedded as a base-64 string. Either way, the contentType of the attachment determines how to interpret the content.

Control0..*
TypeAttachment