FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Clinical Decision Support icon Work Group Maturity Level: 0Trial Use Use Context: Country: World, Country: World

Definitions for the logiclibrary Profile.

Library
Element IdLibrary
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.

Short DisplayRepresents a library of quality improvement components
Cardinality1..1
Invariants
Inherited by this element
cnl-0WarningName should be usable as an identifier for the module by machine processing applications such as code generationname.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){1,254}')
Library.id
Element IdLibrary.id
Definition

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

Short DisplayLogical id of this artifact
Cardinality0..1
Typeid
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Library.meta
Element IdLibrary.meta
Definition

The 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.

Short DisplayMetadata about the resource
Cardinality0..1
TypeMeta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.implicitRules
Element IdLibrary.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short DisplayA set of rules under which this content was created
Cardinality0..1
Typeuri
Is Modifiertrue (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation)
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.language
Element IdLibrary.language
Definition

The base language in which the resource is written.

Short DisplayLanguage of the resource content
Cardinality0..1
Terminology BindingIETF language tag
The codes SHOULD be taken from Common 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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.text
Element IdLibrary.text
Definition

A 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.

Short DisplayText summary of the resource, for human interpretation
Cardinality0..1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have a 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 information is added later.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.contained
Element IdLibrary.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

Short DisplayContained, inline Resources
Cardinality0..*
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. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels.

Library.extension
Element IdLibrary.extension
Definition

An Extension

Short DisplayExtension
Cardinality0..*
TypeExtension
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Library.extension(knowledgeCapability)
Element IdLibrary.extension:knowledgeCapability
Definition

Defines a knowledge capability afforded by this knowledge artifact.

Short Displayshareable | computable | publishable | executable
Cardinality0..*
TypeExtension(knowledgeCapability)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Library.extension(knowledgeRepresentationLevel)
Element IdLibrary.extension:knowledgeRepresentationLevel
Definition

Defines a knowledge representation level provided by this knowledge artifact.

Short Displaynarrative | semi-structured | structured | executable
Cardinality0..*
TypeExtension(knowledgeRepresentationLevel)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Library.extension(artifactComment)
Element IdLibrary.extension:artifactComment
Definition

A comment containing additional documentation, a review comment, usage guidance, or other relevant information from a particular user.

Short DisplayAdditional documentation, review, or usage guidance
Cardinality0..*
TypeExtension(artifactComment)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Library.extension(directReferenceCode)
Element IdLibrary.extension:directReferenceCode
Definition

Defines a code directly referenced by artifact logic, as opposed to a value set. Direct reference codes may be the target of data requirements.

Short DisplayA code directly referenced by the artifact
Cardinality0..*
TypeExtension(directReferenceCode)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Library.modifierExtension
Element IdLibrary.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 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).

Short DisplayExtensions that cannot be ignored
Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
Library.url
Element IdLibrary.url
Definition

An 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 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.

Short DisplayCanonical identifier for this library, represented as a URI (globally unique)
Cardinality1..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.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
Inherited by this element
cnl-1WarningURL should not contain | or # - these characters make processing canonical references problematicurl.matches('([^|#])*')
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.identifier
Element IdLibrary.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.

Short DisplayAdditional identifier for the library
Cardinality0..*
TypeIdentifier
Must Supporttrue
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, and can then identify this library outside of FHIR, where it is not possible to use the logical URI.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.version
Element IdLibrary.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.

Short DisplayBusiness version of the library
Cardinality1..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 reference to a particular business version of the library with the format [url]|[version]. The version SHOULD NOT contain a '#' - see Business Version.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.name
Element IdLibrary.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.

Short DisplayName for this library (computer friendly)
Cardinality1..1 This element is affected by the following invariants: cnl-0
Typestring
Requirements

Support human navigation and code generation.

Comments

The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.title
Element IdLibrary.title
Definition

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

Short DisplayName for this library (human friendly)
Cardinality0..1
Typestring
Must Supporttrue
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.subtitle
Element IdLibrary.subtitle
Definition

An explanatory or alternate title for the library giving additional information about its content.

Short DisplaySubordinate title of the library
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.status
Element IdLibrary.status
Definition

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

Short Displaydraft | active | retired | unknown
Cardinality1..1
Terminology BindingThe lifecycle status of an artifact.
The codes SHALL be taken from PublicationStatus
Typecode
Is Modifiertrue (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration)
Comments

Allows filtering of libraries that are appropriate for use vs. not.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.experimental
Element IdLibrary.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.

Short DisplayFor testing purposes, not real usage
Cardinality1..1
Typeboolean
Requirements

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

Comments

Allows filtering of librarys that are appropriate for use versus not.

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.type
Element IdLibrary.type
Definition

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

Short Displaylogic-library | model-definition | asset-collection | module-definition
Cardinality1..1
Terminology BindingThe type of knowledge asset this library contains.
The codes SHALL be taken from LibraryType; other codes may be used where these codes are not suitable
TypeCodeableConcept
Pattern Value<valueCodeableConcept xmlns="http://hl7.org/fhir">
  <coding>
    <system value="http://terminology.hl7.org/CodeSystem/library-type"/>
    <code value="module-definition"/>
  </coding>
</valueCodeableConcept>
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.subject[x]
Element IdLibrary.subject[x]
Definition

A code or group definition that describes the intended subject of the contents of the library.

Short DisplayType of individual the library content is focused on
Cardinality0..1
Terminology BindingThe possible types of subjects for a library (E.g. Patient, Practitioner, Organization, Location, etc.).
The codes SHALL be taken from Participant Resource Types; other codes may be used where these codes are not suitable
TypeChoice of: CodeableConcept, Reference(Group)
[x] NoteSee Choice of Datatypes for further information about how to use [x]
Must Supporttrue
Meaning if MissingPatient
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.date
Element IdLibrary.date
Definition

The date (and optionally time) when the library was last significantly changed. 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.

Short DisplayDate last changed
Cardinality0..1
TypedateTime
Must Supporttrue
Alternate NamesRevision Date
Comments

The date is often not tracked until the resource is published, but may be present on draft content. 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.publisher
Element IdLibrary.publisher
Definition

The name of the organization or individual responsible for the release and ongoing maintenance of the library.

Short DisplayName of the publisher/steward (organization or individual)
Cardinality1..1
Typestring
Requirements

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

Alternate Namessteward
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.contact
Element IdLibrary.contact
Definition

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

Short DisplayContact details for the publisher
Cardinality0..*
TypeContactDetail
Must Supporttrue
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.description
Element IdLibrary.description
Definition

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

Short DisplayNatural language description of the library
Cardinality1..1
Typemarkdown
Alternate Namesscope
Comments

This description can be used to capture details such as 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 library is presumed to be the predominant language in the place the library was created).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.useContext
Element IdLibrary.useContext
Definition

The 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.

Short DisplayThe context that the content is intended to support
Cardinality0..*
TypeUsageContext
Must Supporttrue
Requirements

Assist in searching for appropriate content.

Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.jurisdiction
Element IdLibrary.jurisdiction
Definition

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

Short DisplayIntended jurisdiction for library (if applicable)
Cardinality0..*
Terminology 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
Must Supporttrue
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.purpose
Element IdLibrary.purpose
Definition

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

Short DisplayWhy this library is defined
Cardinality0..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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.usage
Element IdLibrary.usage
Definition

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

Short DisplayDescribes the clinical usage of the library
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.copyright
Element IdLibrary.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.

Short DisplayUse and/or publishing restrictions
Cardinality0..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
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.approvalDate
Element IdLibrary.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.

Short DisplayWhen the library was approved by publisher
Cardinality0..1
Typedate
Comments

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.lastReviewDate
Element IdLibrary.lastReviewDate
Definition

The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

Short DisplayWhen the library was last reviewed
Cardinality0..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 date follows the original approval date.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.effectivePeriod
Element IdLibrary.effectivePeriod
Definition

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

Short DisplayWhen the library is expected to be used
Cardinality0..1
TypePeriod
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.topic
Element IdLibrary.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.

Short DisplayE.g. Education, Treatment, Assessment, etc.
Cardinality0..*
Terminology 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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.author
Element IdLibrary.author
Definition

An individiual or organization primarily involved in the creation and maintenance of the content.

Short DisplayWho authored the content
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.editor
Element IdLibrary.editor
Definition

An individual or organization primarily responsible for internal coherence of the content.

Short DisplayWho edited the content
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.reviewer
Element IdLibrary.reviewer
Definition

An individual or organization primarily responsible for review of some aspect of the content.

Short DisplayWho reviewed the content
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.endorser
Element IdLibrary.endorser
Definition

An individual or organization responsible for officially endorsing the content for use in some setting.

Short DisplayWho endorsed the content
Cardinality0..*
TypeContactDetail
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact
Element IdLibrary.relatedArtifact
Definition

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

Short DisplayAdditional documentation, citations, etc.
Cardinality0..*
TypeRelatedArtifact
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:type
Library.relatedArtifact(dependency)
Element IdLibrary.relatedArtifact:dependency
Definition

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

Short DisplayAdditional documentation, citations, etc.
Cardinality0..*
TypeRelatedArtifact
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.id
Element IdLibrary.relatedArtifact:dependency.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1
Typeid
Library.relatedArtifact.extension
Element IdLibrary.relatedArtifact:dependency.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Library.relatedArtifact.type
Element IdLibrary.relatedArtifact:dependency.type
Definition

The type of relationship to the related artifact.

Short Displaydocumentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of | part-of | amends | amended-with | appends | appended-with | cites | cited-by | comments-on | comment-in | contains | contained-in | corrects | correction-in | replaces | replaced-with | retracts | retracted-by | signs | similar-to | supports | supported-with | transforms | transformed-into | transformed-with | documents | specification-of | created-with | cite-as
Cardinality1..1
Terminology Binding
The codes SHALL be taken from RelatedArtifactType
Typecode
Must Supporttrue
Comments

The presence of both sides of a relationship type (e.g. successor and predecessor) is required to support use cases where one side of a relationship is not represented in FHIR. However, this feature SHALL NOT be used to create bi-directional resource links in FHIR instances. Specifically, following the methodology of "new points to old" and "many points to one", when using related artifact elements to describe and reference FHIR resources, the type element SHALL be drawn from the fhir-related-artifact-type ValueSet.

Fixed Valuedepends-on
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.classifier
Element IdLibrary.relatedArtifact:dependency.classifier
Definition

Provides additional classifiers of the related artifact.

Short DisplayAdditional classifiers
Cardinality0..*
Terminology Binding
For example codes, see CitationArtifactClassifier
TypeCodeableConcept
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.label
Element IdLibrary.relatedArtifact:dependency.label
Definition

A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index.

Short DisplayShort label
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.display
Element IdLibrary.relatedArtifact:dependency.display
Definition

A brief description of the document or knowledge resource being referenced, suitable for display to a consumer.

Short DisplayBrief description of the related artifact
Cardinality0..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.citation
Element IdLibrary.relatedArtifact:dependency.citation
Definition

A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format.

Short DisplayBibliographic citation for the artifact
Cardinality0..1
Typemarkdown
Comments

Additional structured information about citations should be captured as extensions.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.document
Element IdLibrary.relatedArtifact:dependency.document
Definition

The document being referenced, represented as an attachment. This is exclusive with the resource element.

Short DisplayWhat document is being referenced
Cardinality0..1
TypeAttachment
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.resource
Element IdLibrary.relatedArtifact:dependency.resource
Definition

The related artifact, such as a library, value set, profile, or other knowledge resource.

Short DisplayWhat artifact is being referenced
Cardinality1..1
Typecanonical(CodeSystem)
Must Supporttrue
Comments

If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.resourceReference
Element IdLibrary.relatedArtifact:dependency.resourceReference
Definition

The related artifact, if the artifact is not a canonical resource, or a resource reference to a canonical resource.

Short DisplayWhat artifact, if not a conformance resource
Cardinality0..1
TypeReference(Resource)
Comments

If both resource and resourceReference are present, they SHOULD be consistent and reference the same resource. Although relatedArtifact is intended to support references to definitional resources, there are cases where non-definitional resources can be definitional (such as Location where the kind is mode). Related artifacts SHOULD be used to reference definitional resources, and profiles SHOULD be used to make that explicit for particular use cases.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.publicationStatus
Element IdLibrary.relatedArtifact:dependency.publicationStatus
Definition

The publication status of the artifact being referred to.

Short Displaydraft | active | retired | unknown
Cardinality0..1
Terminology Binding
The codes SHALL be taken from PublicationStatus
Typecode
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.relatedArtifact.publicationDate
Element IdLibrary.relatedArtifact:dependency.publicationDate
Definition

The date of publication of the artifact being referred to.

Short DisplayDate of publication of the artifact being referred to
Cardinality0..1
Typedate
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.parameter
Element IdLibrary.parameter
Definition

The parameter element defines parameters used by the library.

Short DisplayParameters defined by the library
Cardinality0..*
TypeParameterDefinition
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.dataRequirement
Element IdLibrary.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.

Short DisplayWhat data is referenced by this library
Cardinality0..*
TypeDataRequirement
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content
Element IdLibrary.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.

Short DisplayContents of the library, either embedded or referenced
Cardinality0..*
TypeAttachment
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.id
Element IdLibrary.content.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short DisplayUnique id for inter-element referencing
Cardinality0..1
Typeid
Library.content.extension
Element IdLibrary.content.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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.

Short DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: value:url
Library.content.contentType
Element IdLibrary.content.contentType
Definition

Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.

Short DisplayMime type of the content, with charset etc.
Cardinality0..1
Terminology BindingBCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
The codes SHALL be taken from Mime Types
Typecode
Must Supporttrue
Requirements

Processors of the data need to be able to know how to interpret the data.

Example
General:text/plain; charset=UTF-8, image/png
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.language
Element IdLibrary.content.language
Definition

The human language of the content. The value can be any valid value according to BCP 47.

Short DisplayHuman language of the content (BCP-47)
Cardinality0..1
Terminology BindingIETF language tag
The codes SHOULD be taken from Common Languages
Typecode
Requirements

Users need to be able to choose between the languages in a set of attachments.

Example
General:en-AU
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.data
Element IdLibrary.content.data
Definition

The actual data of the attachment - a sequence of bytes, base64 encoded.

Short DisplayData inline, base64ed
Cardinality0..1
Typebase64Binary
Must Supporttrue
Requirements

The data needs to able to be transmitted inline.

Comments

The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.url
Element IdLibrary.content.url
Definition

A location where the data can be accessed.

Short DisplayUri where the data can be found
Cardinality0..1
Typeurl
Requirements

The data needs to be transmitted by reference.

Comments

If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.

Example
General:http://www.acme.com/logo-small.png
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.size
Element IdLibrary.content.size
Definition

The number of bytes of data that make up this attachment (before base64 encoding, if that is done).

Short DisplayNumber of bytes of content (if url provided)
Cardinality0..1
Typeinteger64
Requirements

Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.

Comments

The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.hash
Element IdLibrary.content.hash
Definition

The calculated hash of the data using SHA-1. Represented using base64.

Short DisplayHash of the data (sha-1, base64ed)
Cardinality0..1
Typebase64Binary
Requirements

Included so that applications can verify that the contents of a location have not changed due to technical failures (e.g., storage rot, transport glitch, incorrect version).

Comments

The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded. The hash is not intended to support digital signatures. Where protection against malicious threats a digital signature should be considered, see Provenance.signature for mechanism to protect a resource with a digital signature.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.title
Element IdLibrary.content.title
Definition

A label or set of text to display in place of the data.

Short DisplayLabel to display in place of the data
Cardinality0..1
Typestring
Requirements

Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.

Comments

May sometimes be derived from the source filename.

Example
General:Official Corporate Logo
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.creation
Element IdLibrary.content.creation
Definition

The date that the attachment was first created.

Short DisplayDate attachment was first created
Cardinality0..1
TypedateTime
Requirements

This is often tracked as an integrity issue for use of the attachment.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.height
Element IdLibrary.content.height
Definition

Height of the image in pixels (photo/video).

Short DisplayHeight of the image in pixels (photo/video)
Cardinality0..1
TypepositiveInt
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.width
Element IdLibrary.content.width
Definition

Width of the image in pixels (photo/video).

Short DisplayWidth of the image in pixels (photo/video)
Cardinality0..1
TypepositiveInt
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.frames
Element IdLibrary.content.frames
Definition

The number of frames in a photo. This is used with a multi-page fax, or an imaging acquisition context that takes multiple slices in a single image, or an animated gif. If there is more than one frame, this SHALL have a value in order to alert interface software that a multi-frame capable rendering widget is required.

Short DisplayNumber of frames if > 1 (photo)
Cardinality0..1
TypepositiveInt
Comments

if the number of frames is not supplied, the value may be unknown. Applications should not assume that there is only one frame unless it is explicitly stated.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.duration
Element IdLibrary.content.duration
Definition

The duration of the recording in seconds - for audio and video.

Short DisplayLength in seconds (audio / video)
Cardinality0..1
Typedecimal
Comments

The duration might differ from occurrencePeriod if recording was paused.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
Library.content.pages
Element IdLibrary.content.pages
Definition

The number of pages when printed.

Short DisplayNumber of printed pages
Cardinality0..1
TypepositiveInt
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())