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:
    Serialized Form
    • Field Detail

      • url

        protected UriType url
        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 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.
      • identifier

        protected List<Identifier> 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.
      • version

        protected StringType version
        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.
      • name

        protected StringType name
        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.
      • title

        protected StringType title
        A short, descriptive, user-friendly title for the library.
      • subtitle

        protected StringType subtitle
        An explanatory or alternate title for the library giving additional information about its content.
      • experimental

        protected BooleanType experimental
        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.
      • type

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

        protected DataType subject
        A code or group definition that describes the intended subject of the contents of the library.
      • date

        protected DateTimeType date
        The 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.
      • publisher

        protected StringType publisher
        The name of the organization or individual that published the library.
      • contact

        protected List<ContactDetail> contact
        Contact details to assist a user in finding and communicating with the publisher.
      • description

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

        protected List<UsageContext> useContext
        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.
      • purpose

        protected MarkdownType purpose
        Explanation 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.
      • copyright

        protected MarkdownType copyright
        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.
      • approvalDate

        protected DateType 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

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

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

        protected List<CodeableConcept> 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.
      • author

        protected List<ContactDetail> author
        An individiual or organization primarily involved in the creation and maintenance of the content.
      • editor

        protected List<ContactDetail> editor
        An individual or organization primarily responsible for internal coherence of the content.
      • reviewer

        protected List<ContactDetail> reviewer
        An individual or organization primarily responsible for review of some aspect of the content.
      • endorser

        protected List<ContactDetail> endorser
        An individual or organization responsible for officially endorsing the content for use in some setting.
      • dataRequirement

        protected List<DataRequirement> 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_COMPOSED_OF

        public static final String SP_COMPOSED_OF
        Search parameter: composed-of

        Description: What resource is being referenced
        Type: reference
        Path: Library.relatedArtifact.where(type='composed-of').resource

        See Also:
        Constant Field Values
      • 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.where(type='composed-of').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_CONTENT_TYPE

        public static final String SP_CONTENT_TYPE
        Search parameter: content-type

        Description: The type of content in the library (e.g. text/cql)
        Type: token
        Path: Library.content.contentType

        See Also:
        Constant Field Values
      • CONTENT_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTENT_TYPE
        Fluent Client search parameter constant for content-type

        Description: The type of content in the library (e.g. text/cql)
        Type: token
        Path: Library.content.contentType

      • SP_CONTEXT_QUANTITY

        public static final String SP_CONTEXT_QUANTITY
        Search parameter: context-quantity

        Description: A quantity- or range-valued use context assigned to the library
        Type: quantity
        Path: (Library.useContext.value as Quantity) | (Library.useContext.value as Range)

        See Also:
        Constant Field Values
      • CONTEXT_QUANTITY

        public static final ca.uhn.fhir.rest.gclient.QuantityClientParam CONTEXT_QUANTITY
        Fluent Client search parameter constant for context-quantity

        Description: A quantity- or range-valued use context assigned to the library
        Type: quantity
        Path: (Library.useContext.value as Quantity) | (Library.useContext.value as Range)

      • SP_CONTEXT_TYPE_QUANTITY

        public static final String SP_CONTEXT_TYPE_QUANTITY
        Search parameter: context-type-quantity

        Description: A use context type and quantity- or range-based value assigned to the library
        Type: composite
        Path: Library.useContext

        See Also:
        Constant Field Values
      • CONTEXT_TYPE_QUANTITY

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.QuantityClientParam> CONTEXT_TYPE_QUANTITY
        Fluent Client search parameter constant for context-type-quantity

        Description: A use context type and quantity- or range-based value assigned to the library
        Type: composite
        Path: Library.useContext

      • SP_CONTEXT_TYPE_VALUE

        public static final String SP_CONTEXT_TYPE_VALUE
        Search parameter: context-type-value

        Description: A use context type and value assigned to the library
        Type: composite
        Path: Library.useContext

        See Also:
        Constant Field Values
      • CONTEXT_TYPE_VALUE

        public static final ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,​ca.uhn.fhir.rest.gclient.TokenClientParam> CONTEXT_TYPE_VALUE
        Fluent Client search parameter constant for context-type-value

        Description: A use context type and value assigned to the library
        Type: composite
        Path: Library.useContext

      • SP_CONTEXT_TYPE

        public static final String SP_CONTEXT_TYPE
        Search parameter: context-type

        Description: A type of use context assigned to the library
        Type: token
        Path: Library.useContext.code

        See Also:
        Constant Field Values
      • CONTEXT_TYPE

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam CONTEXT_TYPE
        Fluent Client search parameter constant for context-type

        Description: A type of use context assigned to the library
        Type: token
        Path: Library.useContext.code

      • SP_CONTEXT

        public static final String SP_CONTEXT
        Search parameter: context

        Description: A use context assigned to the library
        Type: token
        Path: (Library.useContext.value as CodeableConcept)

        See Also:
        Constant Field Values
      • CONTEXT

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

        Description: A use context assigned to the library
        Type: token
        Path: (Library.useContext.value as CodeableConcept)

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

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

        See Also:
        Constant Field Values
      • 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_DEPENDS_ON

        public static final String SP_DEPENDS_ON
        Search parameter: depends-on

        Description: What resource is being referenced
        Type: reference
        Path: Library.relatedArtifact.where(type='depends-on').resource

        See Also:
        Constant Field Values
      • 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.where(type='depends-on').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_DERIVED_FROM

        public static final String SP_DERIVED_FROM
        Search parameter: derived-from

        Description: What resource is being referenced
        Type: reference
        Path: Library.relatedArtifact.where(type='derived-from').resource

        See Also:
        Constant Field Values
      • 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.where(type='derived-from').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".
      • 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_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:
        Constant Field Values
      • 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_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

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

        See Also:
        Constant Field Values
      • 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_JURISDICTION

        public static final String SP_JURISDICTION
        Search parameter: jurisdiction

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

        See Also:
        Constant Field Values
      • 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_NAME

        public static final String SP_NAME
        Search parameter: name

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

        See Also:
        Constant Field Values
      • 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_PREDECESSOR

        public static final String SP_PREDECESSOR
        Search parameter: predecessor

        Description: What resource is being referenced
        Type: reference
        Path: Library.relatedArtifact.where(type='predecessor').resource

        See Also:
        Constant Field Values
      • 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.where(type='predecessor').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_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:
        Constant Field Values
      • 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_STATUS

        public static final String SP_STATUS
        Search parameter: status

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

        See Also:
        Constant Field Values
      • 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

      • SP_SUCCESSOR

        public static final String SP_SUCCESSOR
        Search parameter: successor

        Description: What resource is being referenced
        Type: reference
        Path: Library.relatedArtifact.where(type='successor').resource

        See Also:
        Constant Field Values
      • 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.where(type='successor').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_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:
        Constant Field Values
      • 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_TOPIC

        public static final String SP_TOPIC
        Search parameter: topic

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

        See Also:
        Constant Field Values
      • 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_TYPE

        public static final String SP_TYPE
        Search parameter: type

        Description: The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)
        Type: token
        Path: Library.type

        See Also:
        Constant Field Values
      • TYPE

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

        Description: The type of the library (e.g. logic-library, model-definition, asset-collection, module-definition)
        Type: token
        Path: Library.type

      • 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:
        Constant Field Values
      • 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_VERSION

        public static final String SP_VERSION
        Search parameter: version

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

        See Also:
        Constant Field Values
      • 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