Class Library

All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Library extends MetadataResource
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.
See Also:
  • Field Details

    • identifier

      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.
    • type

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

      protected MarkdownType purpose
      Explaination of why this library is needed and why it has been designed as it has.
    • usage

      protected StringType usage
      A detailed description of how the library is used from a clinical perspective.
    • approvalDate

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

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

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

      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.
    • contributor

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

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

      The parameter element defines parameters used by the library.
    • dataRequirement

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

      protected List<Attachment> content
      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.
    • SP_DATE

      public static final String SP_DATE
      Search parameter: date

      Description: The library publication date
      Type: date
      Path: Library.date

      See Also:
    • DATE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
      Fluent Client search parameter constant for date

      Description: The library publication date
      Type: date
      Path: Library.date

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: External identifier for the library
      Type: token
      Path: Library.identifier

      See Also:
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: External identifier for the library
      Type: token
      Path: Library.identifier

    • SP_SUCCESSOR

      public static final String SP_SUCCESSOR
      Search parameter: successor

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

      See Also:
    • SUCCESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUCCESSOR
      Fluent Client search parameter constant for successor

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

    • INCLUDE_SUCCESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:successor".
    • SP_JURISDICTION

      public static final String SP_JURISDICTION
      Search parameter: jurisdiction

      Description: Intended jurisdiction for the library
      Type: token
      Path: Library.jurisdiction

      See Also:
    • JURISDICTION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam JURISDICTION
      Fluent Client search parameter constant for jurisdiction

      Description: Intended jurisdiction for the library
      Type: token
      Path: Library.jurisdiction

    • SP_DESCRIPTION

      public static final String SP_DESCRIPTION
      Search parameter: description

      Description: The description of the library
      Type: string
      Path: Library.description

      See Also:
    • DESCRIPTION

      public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
      Fluent Client search parameter constant for description

      Description: The description of the library
      Type: string
      Path: Library.description

    • SP_DERIVED_FROM

      public static final String SP_DERIVED_FROM
      Search parameter: derived-from

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

      See Also:
    • DERIVED_FROM

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DERIVED_FROM
      Fluent Client search parameter constant for derived-from

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

    • INCLUDE_DERIVED_FROM

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:derived-from".
    • SP_PREDECESSOR

      public static final String SP_PREDECESSOR
      Search parameter: predecessor

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

      See Also:
    • PREDECESSOR

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PREDECESSOR
      Fluent Client search parameter constant for predecessor

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

    • INCLUDE_PREDECESSOR

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:predecessor".
    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: The human-friendly name of the library
      Type: string
      Path: Library.title

      See Also:
    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: The human-friendly name of the library
      Type: string
      Path: Library.title

    • SP_COMPOSED_OF

      public static final String SP_COMPOSED_OF
      Search parameter: composed-of

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

      See Also:
    • COMPOSED_OF

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam COMPOSED_OF
      Fluent Client search parameter constant for composed-of

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

    • INCLUDE_COMPOSED_OF

      public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:composed-of".
    • SP_VERSION

      public static final String SP_VERSION
      Search parameter: version

      Description: The business version of the library
      Type: token
      Path: Library.version

      See Also:
    • VERSION

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
      Fluent Client search parameter constant for version

      Description: The business version of the library
      Type: token
      Path: Library.version

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the library
      Type: uri
      Path: Library.url

      See Also:
    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the library
      Type: uri
      Path: Library.url

    • SP_EFFECTIVE

      public static final String SP_EFFECTIVE
      Search parameter: effective

      Description: The time during which the library is intended to be in use
      Type: date
      Path: Library.effectivePeriod

      See Also:
    • EFFECTIVE

      public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
      Fluent Client search parameter constant for effective

      Description: The time during which the library is intended to be in use
      Type: date
      Path: Library.effectivePeriod

    • SP_DEPENDS_ON

      public static final String SP_DEPENDS_ON
      Search parameter: depends-on

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

      See Also:
    • DEPENDS_ON

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEPENDS_ON
      Fluent Client search parameter constant for depends-on

      Description: What resource is being referenced
      Type: reference
      Path: Library.relatedArtifact.resource

    • INCLUDE_DEPENDS_ON

      public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:depends-on".
    • SP_NAME

      public static final String SP_NAME
      Search parameter: name

      Description: Computationally friendly name of the library
      Type: string
      Path: Library.name

      See Also:
    • NAME

      public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
      Fluent Client search parameter constant for name

      Description: Computationally friendly name of the library
      Type: string
      Path: Library.name

    • SP_PUBLISHER

      public static final String SP_PUBLISHER
      Search parameter: publisher

      Description: Name of the publisher of the library
      Type: string
      Path: Library.publisher

      See Also:
    • PUBLISHER

      public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
      Fluent Client search parameter constant for publisher

      Description: Name of the publisher of the library
      Type: string
      Path: Library.publisher

    • SP_TOPIC

      public static final String SP_TOPIC
      Search parameter: topic

      Description: Topics associated with the module
      Type: token
      Path: Library.topic

      See Also:
    • TOPIC

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam TOPIC
      Fluent Client search parameter constant for topic

      Description: Topics associated with the module
      Type: token
      Path: Library.topic

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: The current status of the library
      Type: token
      Path: Library.status

      See Also:
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: The current status of the library
      Type: token
      Path: Library.status

  • Constructor Details

  • Method Details