Cqllibrary

@POJOBoilerplate
class Cqllibrary(val id: Option[String], val url: Option[UriStr], val meta: Option[Meta], val text: Option[Narrative], val name: Option[String], `type`: CodeableConcept, val date: Option[FHIRDateTime], val title: Option[String], val usage: Option[String], val topic: LitSeq[CodeableConcept], val status: PUBLICATION_STATUS, val author: LitSeq[ContactDetail], val editor: LitSeq[ContactDetail], val version: Option[String], val contact: LitSeq[ContactDetail], val purpose: Option[Markdown], val content: LitSeq[Attachment], val language: Option[LANGUAGES], val subtitle: Option[String], val reviewer: LitSeq[ContactDetail], val endorser: LitSeq[ContactDetail], val contained: LitSeq[Resource], val extension: LitSeq[Extension], val publisher: Option[String], val copyright: Option[Markdown], val parameter: LitSeq[ParameterDefinition], val identifier: LitSeq[Identifier], val subject: Option[SubjectChoice], val useContext: LitSeq[UsageContext], val description: Option[Markdown], val experimental: Option[Boolean], val jurisdiction: LitSeq[CodeableConcept], val approvalDate: Option[FHIRDate], val implicitRules: Option[UriStr], val lastReviewDate: Option[FHIRDate], val effectivePeriod: Option[Period], val relatedArtifact: LitSeq[RelatedArtifact], val dataRequirement: LitSeq[DataRequirement], val modifierExtension: LitSeq[Extension], val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]) extends Library

Represents a CQL logic library

Subclass of hl7.model.Library (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.)

Value Params
`type`
  • Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
approvalDate
  • The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
author
  • An individiual or organization primarily involved in the creation and maintenance of the content.
contact
  • Contact details to assist a user in finding and communicating with the publisher.
contained
  • These 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.
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.
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.
dataRequirement
  • Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.
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.
description
  • A free text natural language description of the library from a consumer's perspective.
editor
  • An individual or organization primarily responsible for internal coherence of the content.
effectivePeriod
  • The period during which the library content was or is planned to be in active use.
endorser
  • An individual or organization responsible for officially endorsing the content for use in some setting.
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.
extension
  • May 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.
id
  • The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
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.
implicitRules
  • 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.
jurisdiction
  • A legal or geographic region in which the library is intended to be used.
language
  • The base language in which the resource is written.
lastReviewDate
  • The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
meta
  • 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.
modifierExtension
  • 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).
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.
parameter
  • The parameter element defines parameters used by the library.
publisher
  • The name of the organization or individual that published the library.
purpose
  • Explanation of why this library is needed and why it has been designed as it has.
relatedArtifact
  • Related artifacts such as additional documentation, justification, or bibliographic references.
reviewer
  • An individual or organization primarily responsible for review of some aspect of the content.
status
  • The status of this library. Enables tracking the life-cycle of the content.
subject
  • A code or group definition that describes the intended subject of the contents of the library.
subtitle
  • An explanatory or alternate title for the library giving additional information about its content.
text
  • 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.
title
  • A short, descriptive, user-friendly title for the library.
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.
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.
usage
  • A detailed description of how the library is used from a clinical perspective.
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.
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.
Constructor

Inherits all params from parent.

Companion
object
class Library
class DomainResource
class Resource
class FHIRObject
trait FHIRComponent
trait Utils
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object extensions
Inherited from
FHIRObject
object ids
Inherited from
FHIRObject

Inherited types

type FieldToElementLookup = TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
Inherited from
FHIRObject

Value members

Inherited methods

final
def >>[T](fn: T => T)(implicit tt: LTag[T]): Cqllibrary

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

Slower than nodalMap, but should work with subtypes (e.g. PositiveInt). If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_] or an Option[_]
  • It may require a type parameter sometimes (e.g. sampleResource >>[BUNDLE_TYPE] { (_: BUNDLE_TYPE) => BUNDLE_TYPE.SEARCHSET } )
Inherited from
FHIRObject
final
def >>=[T, F[_] : Monad](fn: T => F[T])(implicit evidence$7: Monad[F], tt: LTag[T]): F[Cqllibrary]
Inherited from
FHIRObject
final
def ^^[From, To](fn: From => To)(implicit tt: LTag[From]): LitSeq[To]

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Extract values of type From, and map to LitSeq[To] using fn: From => To. Unlike >>, this is safe even if From is a Choice[], a LitSeq[] or an Option[_] Quite slow, slower than nodalExtract

Inherited from
FHIRObject
final
def ^^^[T](implicit tt: LTag[T]): LitSeq[T]
Inherited from
FHIRObject
def companionClassName[T](tag: LTag[T]): String
Inherited from
Utils
def companionOf[T <: FHIRObject : ClassTag](implicit evidence$1: ClassTag[T], tag: LTag[T]): CompanionFor[T]
Inherited from
Utils
def constructor: Constructor[_]
Inherited from
FHIRComponent
def decodeMethodFor[T <: FHIRObject : ClassTag](implicit evidence$2: ClassTag[T], tag: LTag[T], params: DecoderParams): HCursor => Try[T]
Inherited from
Utils
override
def equals(obj: Any): Boolean
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def fields: Seq[FHIRComponentField[_]]
Inherited from
FHIRObject
def getFieldByClass[T](name: String, clazz: Class[T]): LitSeq[T]
Inherited from
FHIRComponent
def getFieldByType[T : LTag](name: String): LitSeq[T]
Inherited from
FHIRComponent
def getIdentifier: Option[String]
Inherited from
Resource
def getMostSpecificIdentifier: Option[String]
Inherited from
Resource
def getVersionedIdentifier: Option[String]
Inherited from
Resource
override
def hashCode(): Int
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def modifyField[T : LTag, Up >: Cqllibrary <: FHIRObject](fieldName: String, modify: T => T)(implicit evidence$5: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def modifyFieldUnsafe[T, Up >: Cqllibrary <: FHIRObject](fieldName: String, modify: T => T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
final
def nodalExtract[From, To](klass: Class[From], fn: From => To): LitSeq[To]

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Convenience alias for nodalGetByClass andThen map to LitSeq[To] using fn: From => To.

Inherited from
FHIRObject
final
def nodalGetByClass[Target](klass: Class[Target]): LitSeq[Target]

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Extract values of type From Unlike nodalMap, this is safe even if From is a Choice[_], a LitSeq[_] or an Option[_], however there remains a caveat with 'subtyped' types (eg PositiveInt), in that we can't differentiate them from the parent class Quite slow but faster than ^^

Inherited from
FHIRObject
final
def nodalMap[T](klass: Class[T], fn: T => T): Cqllibrary

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

Bit faster than >>, but still much slower than using update$foo when possible. If you must use it, then:

  • T should not be a Choice[_], a LitSeq[_], an Option[_], or any 'subtyped' type (eg PositiveInt). You should ensure, if T is a supertype of multiple valid choice values (e.g. T =:= Object), that the return value of fn retains the same type as the input value.
Inherited from
FHIRObject
def setFromField[T, UpType >: Cqllibrary <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(newVal: T): UpType
Inherited from
FHIRObject
def thisClassName: String
Inherited from
FHIRObject
def toClass[T](klass: Class[T]): Option[T]
Inherited from
FHIRObject
override
def toString: String
Definition Classes
FHIRObject -> Any
Inherited from
FHIRObject
def toType[T](implicit ct: ClassTag[T]): Option[T]
Inherited from
FHIRObject
def updateFromField[T, UpType >: Cqllibrary <: FHIRObject : LTag](field: FHIRComponentFieldMeta[T])(fn: T => T): UpType
Inherited from
FHIRObject
def updatePrimitiveAttributes(fn: FieldToElementLookup => FieldToElementLookup): Cqllibrary
Inherited from
FHIRObject
def withField[T : LTag, Up >: Cqllibrary <: FHIRObject](fieldName: String, value: T)(implicit evidence$6: LTag[T], ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withFieldUnsafe[T, Up >: Cqllibrary <: FHIRObject](fieldName: String, value: T)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withFields[Up >: Cqllibrary <: FHIRObject](replacementFields: (String, Any)*)(implicit ct: ClassTag[Up], tt: LTag[Up]): Up
Inherited from
FHIRObject
def withPrimitiveAttributes(a: FieldToElementLookup): Cqllibrary
Inherited from
FHIRObject

Concrete fields

override
val `type`: CodeableConcept
override
val approvalDate: Option[FHIRDate]
override
val author: LitSeq[ContactDetail]
override
val contact: LitSeq[ContactDetail]
override
val contained: LitSeq[Resource]
override
val content: LitSeq[Attachment]
override
val dataRequirement: LitSeq[DataRequirement]
override
val date: Option[FHIRDateTime]
override
val description: Option[Markdown]
override
val editor: LitSeq[ContactDetail]
override
val effectivePeriod: Option[Period]
override
val endorser: LitSeq[ContactDetail]
override
val experimental: Option[Boolean]
override
val extension: LitSeq[Extension]
override
val id: Option[String]
override
val identifier: LitSeq[Identifier]
override
val implicitRules: Option[UriStr]
override
val jurisdiction: LitSeq[CodeableConcept]
override
val language: Option[LANGUAGES]
override
val lastReviewDate: Option[FHIRDate]
override
val meta: Option[Meta]
override
val modifierExtension: LitSeq[Extension]
override
val name: Option[String]
override
val parameter: LitSeq[ParameterDefinition]
override
val primitiveAttributes: TreeMap[FHIRComponentFieldMeta[_], PrimitiveElementInfo]
override
val publisher: Option[String]
override
val purpose: Option[Markdown]
override
val relatedArtifact: LitSeq[RelatedArtifact]
override
val reviewer: LitSeq[ContactDetail]
override
val status: PUBLICATION_STATUS
override
val subject: Option[SubjectChoice]
override
val subtitle: Option[String]
override
val text: Option[Narrative]
override
val thisTypeName: String
override
val title: Option[String]
override
val topic: LitSeq[CodeableConcept]
override
val url: Option[UriStr]
override
val usage: Option[String]
override
val useContext: LitSeq[UsageContext]
override
val version: Option[String]

Inherited fields

val companion: CompanionFor[Cqllibrary]
Inherited from
FHIRObject