description: 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.
package_name: hl7.fhir.r5.examples
derivation: specialization
name: Library
type: Library
elements:
  description: {isModifier: false, short: Natural language description of the library, type: markdown, mustSupport: false, isSummary: true, index: 16}
  date: {isModifier: false, short: Date last changed, type: dateTime, mustSupport: false, isSummary: true, index: 13}
  dataRequirement: {isModifier: false, short: What data is referenced by this library, type: DataRequirement, mustSupport: false, array: true, isSummary: false, index: 32}
  endorser: {isModifier: false, short: Who endorsed the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 29}
  publisher: {isModifier: false, short: Name of the publisher/steward (organization or individual), type: string, mustSupport: false, isSummary: true, index: 14}
  approvalDate: {isModifier: false, short: When the library was approved by publisher, type: date, mustSupport: false, isSummary: false, index: 22}
  jurisdiction:
    isModifier: false
    short: Intended jurisdiction for library (if applicable)
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/jurisdiction'}
    isSummary: true
    index: 18
  purpose: {isModifier: false, short: Why this library is defined, type: markdown, mustSupport: false, isSummary: false, index: 19}
  content: {isModifier: false, short: 'Contents of the library, either embedded or referenced', type: Attachment, mustSupport: false, array: true, isSummary: true, index: 33}
  subjectCodeableConcept: {isModifier: false, short: Type of individual the library content is focused on, type: CodeableConcept, mustSupport: false, meaningWhenMissing: Patient, choiceOf: subject, isSummary: false, index: 11}
  name: {isModifier: false, short: Name for this library (computer friendly), type: string, mustSupport: false, isSummary: true, index: 3}
  useContext: {isModifier: false, short: The context that the content is intended to support, type: UsageContext, mustSupport: false, array: true, isSummary: true, index: 17}
  copyright: {isModifier: false, short: Use and/or publishing restrictions, type: markdown, mustSupport: false, isSummary: false, index: 21}
  type:
    isModifier: false
    short: logic-library | model-definition | asset-collection | module-definition
    type: CodeableConcept
    mustSupport: false
    binding: {strength: extensible, valueSet: 'http://hl7.org/fhir/ValueSet/library-type'}
    isSummary: true
    index: 8
  experimental: {isModifier: false, short: 'For testing purposes, not real usage', type: boolean, mustSupport: false, meaningWhenMissing: 'If absent, this resource is treated as though it is not experimental.', isSummary: true, index: 7}
  topic:
    isModifier: false
    short: E.g. Education, Treatment, Assessment, etc.
    type: CodeableConcept
    mustSupport: false
    array: true
    binding: {strength: example, valueSet: 'http://hl7.org/fhir/ValueSet/definition-topic'}
    isSummary: false
    index: 25
  title: {isModifier: false, short: Name for this library (human friendly), type: string, mustSupport: false, isSummary: true, index: 4}
  author: {isModifier: false, short: Who authored the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 26}
  usage: {isModifier: false, short: Describes the clinical usage of the library, type: string, mustSupport: false, isSummary: false, index: 20}
  status:
    isModifier: true
    short: draft | active | retired | unknown
    index: 6
    type: code
    mustSupport: false
    binding: {strength: required, valueSet: 'http://hl7.org/fhir/ValueSet/publication-status|5.0.0-ballot'}
    isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    isSummary: true
  subtitle: {isModifier: false, short: Subordinate title of the library, type: string, mustSupport: false, isSummary: false, index: 5}
  url:
    constraint:
      cnl-1: {human: 'URL should not contain | or # - these characters make processing canonical references problematic', source: 'http://hl7.org/fhir/StructureDefinition/Library', severity: warning, expression: 'url.matches(''([^|#])*'')'}
    isModifier: false
    short: Canonical identifier for this library, represented as a URI (globally unique)
    type: uri
    mustSupport: false
    isSummary: true
    index: 0
  identifier: {isModifier: false, short: Additional identifier for the library, type: Identifier, mustSupport: false, array: true, isSummary: true, index: 1}
  lastReviewDate: {isModifier: false, short: When the library was last reviewed, type: date, mustSupport: false, isSummary: false, index: 23}
  editor: {isModifier: false, short: Who edited the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 27}
  reviewer: {isModifier: false, short: Who reviewed the content, type: ContactDetail, mustSupport: false, array: true, isSummary: false, index: 28}
  version: {isModifier: false, short: Business version of the library, type: string, mustSupport: false, isSummary: true, index: 2}
  relatedArtifact: {isModifier: false, short: 'Additional documentation, citations, etc.', type: RelatedArtifact, mustSupport: false, array: true, isSummary: false, index: 30}
  contact: {isModifier: false, short: Contact details for the publisher, type: ContactDetail, mustSupport: false, array: true, isSummary: true, index: 15}
  subjectReference:
    isModifier: false
    short: Type of individual the library content is focused on
    index: 12
    refers: ['http://hl7.org/fhir/StructureDefinition/Group']
    type: Reference
    mustSupport: false
    meaningWhenMissing: Patient
    choiceOf: subject
    isSummary: false
  subject:
    isModifier: false
    short: Type of individual the library content is focused on
    mustSupport: false
    choices: [subjectCodeableConcept, subjectReference]
    meaningWhenMissing: Patient
    isSummary: false
    index: 10
  parameter: {isModifier: false, short: Parameters defined by the library, type: ParameterDefinition, mustSupport: false, array: true, isSummary: false, index: 31}
  effectivePeriod: {isModifier: false, short: When the library is expected to be used, type: Period, mustSupport: false, isSummary: true, index: 24}
package_version: 5.0.0-ballot
class: resource
kind: resource
url: http://hl7.org/fhir/StructureDefinition/Library
base: http://hl7.org/fhir/StructureDefinition/DomainResource
version: 5.0.0-ballot
required: [status, type]