Skip to main content

Library

PropertyValue
Publisher
NameLibrary
URLhttp://hl7.org/fhir/StructureDefinition/Library
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
Library0..*LibraryThe 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.
Library.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Library.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Library.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Library.language0..1codeThe base language in which the resource is written.
Library.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can 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.
Library.contained0..*ResourceThese 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.
Library.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Library.modifierExtension0..*ExtensionMay 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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Library.url0..1uriAn absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this library is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the library is stored on different servers.
Library.identifier0..*IdentifierA 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.
Library.version0..1stringThe 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.
Library.name0..1stringA 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.
Library.title0..1stringA short, descriptive, user-friendly title for the library.
Library.subtitle0..1stringAn explanatory or alternate title for the library giving additional information about its content.
Library.status1..1codeThe status of this library. Enables tracking the life-cycle of the content.
Library.experimental0..1booleanA 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.
Library.type1..1CodeableConceptIdentifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
Library.subject[x]0..1CodeableConceptA code or group definition that describes the intended subject of the contents of the library.
Library.date0..1dateTimeThe date (and optionally time) when the library was published. The date must change 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.
Library.publisher0..1stringThe name of the organization or individual that published the library.
Library.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
Library.description0..1markdownA free text natural language description of the library from a consumer's perspective.
Library.useContext0..*UsageContextThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate library instances.
Library.jurisdiction0..*CodeableConceptA legal or geographic region in which the library is intended to be used.
Library.purpose0..1markdownExplanation of why this library is needed and why it has been designed as it has.
Library.usage0..1stringA detailed description of how the library is used from a clinical perspective.
Library.copyright0..1markdownA copyright statement relating to the library and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the library.
Library.approvalDate0..1dateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Library.lastReviewDate0..1dateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Library.effectivePeriod0..1PeriodThe period during which the library content was or is planned to be in active use.
Library.topic0..*CodeableConceptDescriptive 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.
Library.author0..*ContactDetailAn individiual or organization primarily involved in the creation and maintenance of the content.
Library.editor0..*ContactDetailAn individual or organization primarily responsible for internal coherence of the content.
Library.reviewer0..*ContactDetailAn individual or organization primarily responsible for review of some aspect of the content.
Library.endorser0..*ContactDetailAn individual or organization responsible for officially endorsing the content for use in some setting.
Library.relatedArtifact0..*RelatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.
Library.parameter0..*ParameterDefinitionThe parameter element defines parameters used by the library.
Library.dataRequirement0..*DataRequirementDescribes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
Library.content0..*AttachmentThe 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.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
composed-ofreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='composed-of').resource
content-typetokenThe type of content in the library (e.g. text/cql)Library.content.contentType
contexttokenA use context assigned to the library(Library.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the library(Library.useContext.value.ofType(Quantity)) / (Library.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the libraryLibrary.useContext.code
datedateThe library publication dateLibrary.date
depends-onreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='depends-on').resource
derived-fromreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='derived-from').resource
descriptionstringThe description of the libraryLibrary.description
effectivedateThe time during which the library is intended to be in useLibrary.effectivePeriod
identifiertokenExternal identifier for the libraryLibrary.identifier
jurisdictiontokenIntended jurisdiction for the libraryLibrary.jurisdiction
namestringComputationally friendly name of the libraryLibrary.name
predecessorreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='predecessor').resource
publisherstringName of the publisher of the libraryLibrary.publisher
statustokenThe current status of the libraryLibrary.status
successorreferenceWhat resource is being referencedLibrary.relatedArtifact.where(type='successor').resource
titlestringThe human-friendly name of the libraryLibrary.title
topictokenTopics associated with the moduleLibrary.topic
typetokenThe type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)Library.type
urluriThe uri that identifies the libraryLibrary.url
versiontokenThe business version of the libraryLibrary.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the libraryLibrary.useContext
context-type-valuecompositeA use context type and value assigned to the libraryLibrary.useContext