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 Summary
Fields Modifier and Type Field Description protected DateTypeapprovalDateThe date on which the resource content was approved by the publisher.protected List<ContactDetail>authorAn individiual or organization primarily involved in the creation and maintenance of the content.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCOMPOSED_OFFluent Client search parameter constant for composed-ofprotected List<ContactDetail>contactContact details to assist a user in finding and communicating with the publisher.protected List<Attachment>contentThe content of the library as an Attachment.static ca.uhn.fhir.rest.gclient.TokenClientParamCONTENT_TYPEFluent Client search parameter constant for content-typestatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXTFluent Client search parameter constant for contextstatic ca.uhn.fhir.rest.gclient.QuantityClientParamCONTEXT_QUANTITYFluent Client search parameter constant for context-quantitystatic ca.uhn.fhir.rest.gclient.TokenClientParamCONTEXT_TYPEFluent Client search parameter constant for context-typestatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.QuantityClientParam>CONTEXT_TYPE_QUANTITYFluent Client search parameter constant for context-type-quantitystatic ca.uhn.fhir.rest.gclient.CompositeClientParam<ca.uhn.fhir.rest.gclient.TokenClientParam,ca.uhn.fhir.rest.gclient.TokenClientParam>CONTEXT_TYPE_VALUEFluent Client search parameter constant for context-type-valueprotected MarkdownTypecopyrightA copyright statement relating to the library and/or its contents.protected List<DataRequirement>dataRequirementDescribes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.protected DateTimeTypedateThe date (and optionally time) when the library was published.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDEPENDS_ONFluent Client search parameter constant for depends-onstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamDERIVED_FROMFluent Client search parameter constant for derived-fromprotected MarkdownTypedescriptionA free text natural language description of the library from a consumer's perspective.static ca.uhn.fhir.rest.gclient.StringClientParamDESCRIPTIONFluent Client search parameter constant for descriptionprotected List<ContactDetail>editorAn individual or organization primarily responsible for internal coherence of the content.static ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVEFluent Client search parameter constant for effectiveprotected PeriodeffectivePeriodThe period during which the library content was or is planned to be in active use.protected List<ContactDetail>endorserAn individual or organization responsible for officially endorsing the content for use in some setting.protected BooleanTypeexperimentalA 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.protected List<Identifier>identifierA 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.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_COMPOSED_OFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DEPENDS_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_DERIVED_FROMConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PREDECESSORConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUCCESSORConstant for fluent queries to be used to add include statements.protected List<CodeableConcept>jurisdictionA legal or geographic region in which the library is intended to be used.static ca.uhn.fhir.rest.gclient.TokenClientParamJURISDICTIONFluent Client search parameter constant for jurisdictionprotected DateTypelastReviewDateThe date on which the resource content was last reviewed.protected StringTypenameA natural language name identifying the library.static ca.uhn.fhir.rest.gclient.StringClientParamNAMEFluent Client search parameter constant for nameprotected List<ParameterDefinition>parameterThe parameter element defines parameters used by the library.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPREDECESSORFluent Client search parameter constant for predecessorprotected StringTypepublisherThe name of the organization or individual that published the library.static ca.uhn.fhir.rest.gclient.StringClientParamPUBLISHERFluent Client search parameter constant for publisherprotected MarkdownTypepurposeExplanation of why this library is needed and why it has been designed as it has.protected List<RelatedArtifact>relatedArtifactRelated artifacts such as additional documentation, justification, or bibliographic references.protected List<ContactDetail>reviewerAn individual or organization primarily responsible for review of some aspect of the content.static StringSP_COMPOSED_OFSearch parameter: composed-ofstatic StringSP_CONTENT_TYPESearch parameter: content-typestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_CONTEXT_QUANTITYSearch parameter: context-quantitystatic StringSP_CONTEXT_TYPESearch parameter: context-typestatic StringSP_CONTEXT_TYPE_QUANTITYSearch parameter: context-type-quantitystatic StringSP_CONTEXT_TYPE_VALUESearch parameter: context-type-valuestatic StringSP_DATESearch parameter: datestatic StringSP_DEPENDS_ONSearch parameter: depends-onstatic StringSP_DERIVED_FROMSearch parameter: derived-fromstatic StringSP_DESCRIPTIONSearch parameter: descriptionstatic StringSP_EFFECTIVESearch parameter: effectivestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_JURISDICTIONSearch parameter: jurisdictionstatic StringSP_NAMESearch parameter: namestatic StringSP_PREDECESSORSearch parameter: predecessorstatic StringSP_PUBLISHERSearch parameter: publisherstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUCCESSORSearch parameter: successorstatic StringSP_TITLESearch parameter: titlestatic StringSP_TOPICSearch parameter: topicstatic StringSP_TYPESearch parameter: typestatic StringSP_URLSearch parameter: urlstatic StringSP_VERSIONSearch parameter: versionprotected Enumeration<Enumerations.PublicationStatus>statusThe status of this library.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected DataTypesubjectA code or group definition that describes the intended subject of the contents of the library.protected StringTypesubtitleAn explanatory or alternate title for the library giving additional information about its content.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUCCESSORFluent Client search parameter constant for successorprotected StringTypetitleA short, descriptive, user-friendly title for the library.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for titleprotected List<CodeableConcept>topicDescriptive topics related to the content of the library.static ca.uhn.fhir.rest.gclient.TokenClientParamTOPICFluent Client search parameter constant for topicprotected CodeableConcepttypeIdentifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.static ca.uhn.fhir.rest.gclient.TokenClientParamTYPEFluent Client search parameter constant for typeprotected UriTypeurlAn 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.static ca.uhn.fhir.rest.gclient.UriClientParamURLFluent Client search parameter constant for urlprotected StringTypeusageA detailed description of how the library is used from a clinical perspective.protected List<UsageContext>useContextThe content was developed with a focus and intent of supporting the contexts that are listed.protected StringTypeversionThe identifier that is used to identify this version of the library when it is referenced in a specification, model, design or instance.static ca.uhn.fhir.rest.gclient.TokenClientParamVERSIONFluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Library()ConstructorLibrary(Enumerations.PublicationStatus status, CodeableConcept type)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.MetadataResource
copyValues, getApprovalDateMax, getAuthorMax, getEditorMax, getEffectivePeriodMax, getEndorserMax, getLastReviewDateMax, getRelatedArtifactMax, getReviewerMax, getTopicMax
-
Methods inherited from class org.hl7.fhir.r5.model.CanonicalResource
copyValues, getContactMax, getCopyrightMax, getDateMax, getDescriptionMax, getExperimentalMax, getIdentifierMax, getJurisdictionMax, getNameMax, getPublisherMax, getPurposeMax, getStatusMax, getTitleMax, getUrlMax, getUseContextMax, getVersionedUrl, getVersionMax, getVUrl, present, supportsCopyright, toString
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
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.
-
status
protected Enumeration<Enumerations.PublicationStatus> status
The status of this library. Enables tracking the life-cycle of the 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.
-
jurisdiction
protected List<CodeableConcept> jurisdiction
A legal or geographic region in which the library is intended to be used.
-
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.
-
relatedArtifact
protected List<RelatedArtifact> relatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.
-
parameter
protected List<ParameterDefinition> parameter
The parameter element defines parameters used by the library.
-
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-ofDescription: 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-ofDescription: 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-typeDescription: 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-typeDescription: 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-quantityDescription: 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-quantityDescription: 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-quantityDescription: 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-quantityDescription: 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-valueDescription: 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-valueDescription: 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-typeDescription: 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-typeDescription: 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: contextDescription: 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 contextDescription: 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: dateDescription: 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 dateDescription: The library publication date
Type: date
Path: Library.date
-
SP_DEPENDS_ON
public static final String SP_DEPENDS_ON
Search parameter: depends-onDescription: 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-onDescription: 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-fromDescription: 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-fromDescription: 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".
-
SP_DESCRIPTION
public static final String SP_DESCRIPTION
Search parameter: descriptionDescription: The description of the library
Type: string
Path: Library.description
- See Also:
- Constant Field Values
-
DESCRIPTION
public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
Fluent Client search parameter constant for descriptionDescription: The description of the library
Type: string
Path: Library.description
-
SP_EFFECTIVE
public static final String SP_EFFECTIVE
Search parameter: effectiveDescription: 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 effectiveDescription: 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: identifierDescription: 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 identifierDescription: External identifier for the library
Type: token
Path: Library.identifier
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: jurisdictionDescription: 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 jurisdictionDescription: Intended jurisdiction for the library
Type: token
Path: Library.jurisdiction
-
SP_NAME
public static final String SP_NAME
Search parameter: nameDescription: 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 nameDescription: Computationally friendly name of the library
Type: string
Path: Library.name
-
SP_PREDECESSOR
public static final String SP_PREDECESSOR
Search parameter: predecessorDescription: 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 predecessorDescription: 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: publisherDescription: 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 publisherDescription: Name of the publisher of the library
Type: string
Path: Library.publisher
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: 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 statusDescription: The current status of the library
Type: token
Path: Library.status
-
SP_SUCCESSOR
public static final String SP_SUCCESSOR
Search parameter: successorDescription: 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 successorDescription: 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: titleDescription: 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 titleDescription: The human-friendly name of the library
Type: string
Path: Library.title
-
SP_TOPIC
public static final String SP_TOPIC
Search parameter: topicDescription: 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 topicDescription: Topics associated with the module
Type: token
Path: Library.topic
-
SP_TYPE
public static final String SP_TYPE
Search parameter: typeDescription: 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 typeDescription: 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: urlDescription: 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 urlDescription: The uri that identifies the library
Type: uri
Path: Library.url
-
SP_VERSION
public static final String SP_VERSION
Search parameter: versionDescription: 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 versionDescription: The business version of the library
Type: token
Path: Library.version
-
-
Constructor Detail
-
Library
public Library()
Constructor
-
Library
public Library(Enumerations.PublicationStatus status, CodeableConcept type)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Specified by:
getUrlElementin classCanonicalResource- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Specified by:
hasUrlElementin classCanonicalResource
-
hasUrl
public boolean hasUrl()
- Specified by:
hasUrlin classCanonicalResource
-
setUrlElement
public Library setUrlElement(UriType value)
- Specified by:
setUrlElementin classCanonicalResource- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Specified by:
getUrlin classCanonicalResource- Returns:
- 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.
-
setUrl
public Library setUrl(String value)
- Specified by:
setUrlin classCanonicalResource- Parameters:
value- 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.
-
getIdentifier
public List<Identifier> getIdentifier()
- Specified by:
getIdentifierin classCanonicalResource- Returns:
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.)
-
setIdentifier
public Library setIdentifier(List<Identifier> theIdentifier)
- Specified by:
setIdentifierin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
- Specified by:
hasIdentifierin classCanonicalResource
-
addIdentifier
public Identifier addIdentifier()
- Specified by:
addIdentifierin classCanonicalResource
-
addIdentifier
public Library addIdentifier(Identifier t)
- Specified by:
addIdentifierin classCanonicalResource
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Specified by:
getIdentifierFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getVersionElement
public StringType getVersionElement()
- Specified by:
getVersionElementin classCanonicalResource- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
hasVersionElement
public boolean hasVersionElement()
- Specified by:
hasVersionElementin classCanonicalResource
-
hasVersion
public boolean hasVersion()
- Specified by:
hasVersionin classCanonicalResource
-
setVersionElement
public Library setVersionElement(StringType value)
- Specified by:
setVersionElementin classCanonicalResource- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value
-
getVersion
public String getVersion()
- Specified by:
getVersionin classCanonicalResource- Returns:
- 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.
-
setVersion
public Library setVersion(String value)
- Specified by:
setVersionin classCanonicalResource- Parameters:
value- 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.
-
getNameElement
public StringType getNameElement()
- Specified by:
getNameElementin classCanonicalResource- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
hasNameElement
public boolean hasNameElement()
- Specified by:
hasNameElementin classCanonicalResource
-
hasName
public boolean hasName()
- Specified by:
hasNamein classCanonicalResource
-
setNameElement
public Library setNameElement(StringType value)
- Specified by:
setNameElementin classCanonicalResource- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value
-
getName
public String getName()
- Specified by:
getNamein classCanonicalResource- Returns:
- 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.
-
setName
public Library setName(String value)
- Specified by:
setNamein classCanonicalResource- Parameters:
value- 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.
-
getTitleElement
public StringType getTitleElement()
- Specified by:
getTitleElementin classCanonicalResource- Returns:
title(A short, descriptive, user-friendly title for the library.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
public boolean hasTitleElement()
- Specified by:
hasTitleElementin classCanonicalResource
-
hasTitle
public boolean hasTitle()
- Specified by:
hasTitlein classCanonicalResource
-
setTitleElement
public Library setTitleElement(StringType value)
- Specified by:
setTitleElementin classCanonicalResource- Parameters:
value-title(A short, descriptive, user-friendly title for the library.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
public String getTitle()
- Specified by:
getTitlein classCanonicalResource- Returns:
- A short, descriptive, user-friendly title for the library.
-
setTitle
public Library setTitle(String value)
- Specified by:
setTitlein classCanonicalResource- Parameters:
value- A short, descriptive, user-friendly title for the library.
-
getSubtitleElement
public StringType getSubtitleElement()
- Returns:
subtitle(An explanatory or alternate title for the library giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
hasSubtitleElement
public boolean hasSubtitleElement()
-
hasSubtitle
public boolean hasSubtitle()
-
setSubtitleElement
public Library setSubtitleElement(StringType value)
- Parameters:
value-subtitle(An explanatory or alternate title for the library giving additional information about its content.). This is the underlying object with id, value and extensions. The accessor "getSubtitle" gives direct access to the value
-
getSubtitle
public String getSubtitle()
- Returns:
- An explanatory or alternate title for the library giving additional information about its content.
-
setSubtitle
public Library setSubtitle(String value)
- Parameters:
value- An explanatory or alternate title for the library giving additional information about its content.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Specified by:
getStatusElementin classCanonicalResource- Returns:
status(The status of this library. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
- Specified by:
hasStatusElementin classCanonicalResource
-
hasStatus
public boolean hasStatus()
- Specified by:
hasStatusin classCanonicalResource
-
setStatusElement
public Library setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Specified by:
setStatusElementin classCanonicalResource- Parameters:
value-status(The status of this library. Enables tracking the life-cycle of the content.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Enumerations.PublicationStatus getStatus()
- Specified by:
getStatusin classCanonicalResource- Returns:
- The status of this library. Enables tracking the life-cycle of the content.
-
setStatus
public Library setStatus(Enumerations.PublicationStatus value)
- Specified by:
setStatusin classCanonicalResource- Parameters:
value- The status of this library. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Specified by:
getExperimentalElementin classCanonicalResource- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
hasExperimentalElement
public boolean hasExperimentalElement()
- Specified by:
hasExperimentalElementin classCanonicalResource
-
hasExperimental
public boolean hasExperimental()
- Specified by:
hasExperimentalin classCanonicalResource
-
setExperimentalElement
public Library setExperimentalElement(BooleanType value)
- Specified by:
setExperimentalElementin classCanonicalResource- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value
-
getExperimental
public boolean getExperimental()
- Specified by:
getExperimentalin classCanonicalResource- Returns:
- 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.
-
setExperimental
public Library setExperimental(boolean value)
- Specified by:
setExperimentalin classCanonicalResource- Parameters:
value- 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.
-
getType
public CodeableConcept getType()
- Returns:
type(Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.)
-
hasType
public boolean hasType()
-
setType
public Library setType(CodeableConcept value)
- Parameters:
value-type(Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.)
-
getSubject
public DataType getSubject()
- Returns:
subject(A code or group definition that describes the intended subject of the contents of the library.)
-
getSubjectCodeableConcept
public CodeableConcept getSubjectCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
subject(A code or group definition that describes the intended subject of the contents of the library.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectCodeableConcept
public boolean hasSubjectCodeableConcept()
-
getSubjectReference
public Reference getSubjectReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
subject(A code or group definition that describes the intended subject of the contents of the library.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubjectReference
public boolean hasSubjectReference()
-
hasSubject
public boolean hasSubject()
-
setSubject
public Library setSubject(DataType value)
- Parameters:
value-subject(A code or group definition that describes the intended subject of the contents of the library.)
-
getDateElement
public DateTimeType getDateElement()
- Specified by:
getDateElementin classCanonicalResource- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
public boolean hasDateElement()
- Specified by:
hasDateElementin classCanonicalResource
-
hasDate
public boolean hasDate()
- Specified by:
hasDatein classCanonicalResource
-
setDateElement
public Library setDateElement(DateTimeType value)
- Specified by:
setDateElementin classCanonicalResource- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
public Date getDate()
- Specified by:
getDatein classCanonicalResource- Returns:
- 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.
-
setDate
public Library setDate(Date value)
- Specified by:
setDatein classCanonicalResource- Parameters:
value- 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.
-
getPublisherElement
public StringType getPublisherElement()
- Specified by:
getPublisherElementin classCanonicalResource- Returns:
publisher(The name of the organization or individual that published the library.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
hasPublisherElement
public boolean hasPublisherElement()
- Specified by:
hasPublisherElementin classCanonicalResource
-
hasPublisher
public boolean hasPublisher()
- Specified by:
hasPublisherin classCanonicalResource
-
setPublisherElement
public Library setPublisherElement(StringType value)
- Specified by:
setPublisherElementin classCanonicalResource- Parameters:
value-publisher(The name of the organization or individual that published the library.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value
-
getPublisher
public String getPublisher()
- Specified by:
getPublisherin classCanonicalResource- Returns:
- The name of the organization or individual that published the library.
-
setPublisher
public Library setPublisher(String value)
- Specified by:
setPublisherin classCanonicalResource- Parameters:
value- The name of the organization or individual that published the library.
-
getContact
public List<ContactDetail> getContact()
- Specified by:
getContactin classCanonicalResource- Returns:
contact(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public Library setContact(List<ContactDetail> theContact)
- Specified by:
setContactin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContact
public boolean hasContact()
- Specified by:
hasContactin classCanonicalResource
-
addContact
public ContactDetail addContact()
- Specified by:
addContactin classCanonicalResource
-
addContact
public Library addContact(ContactDetail t)
- Specified by:
addContactin classCanonicalResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Specified by:
getContactFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
contact, creating it if it does not already exist {3}
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Specified by:
getDescriptionElementin classCanonicalResource- Returns:
description(A free text natural language description of the library from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
public boolean hasDescriptionElement()
- Specified by:
hasDescriptionElementin classCanonicalResource
-
hasDescription
public boolean hasDescription()
- Specified by:
hasDescriptionin classCanonicalResource
-
setDescriptionElement
public Library setDescriptionElement(MarkdownType value)
- Specified by:
setDescriptionElementin classCanonicalResource- Parameters:
value-description(A free text natural language description of the library from a consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
public String getDescription()
- Specified by:
getDescriptionin classCanonicalResource- Returns:
- A free text natural language description of the library from a consumer's perspective.
-
setDescription
public Library setDescription(String value)
- Specified by:
setDescriptionin classCanonicalResource- Parameters:
value- A free text natural language description of the library from a consumer's perspective.
-
getUseContext
public List<UsageContext> getUseContext()
- Specified by:
getUseContextin classCanonicalResource- Returns:
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.)
-
setUseContext
public Library setUseContext(List<UsageContext> theUseContext)
- Specified by:
setUseContextin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Specified by:
hasUseContextin classCanonicalResource
-
addUseContext
public UsageContext addUseContext()
- Specified by:
addUseContextin classCanonicalResource
-
addUseContext
public Library addUseContext(UsageContext t)
- Specified by:
addUseContextin classCanonicalResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Specified by:
getUseContextFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
useContext, creating it if it does not already exist {3}
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Specified by:
getJurisdictionin classCanonicalResource- Returns:
jurisdiction(A legal or geographic region in which the library is intended to be used.)
-
setJurisdiction
public Library setJurisdiction(List<CodeableConcept> theJurisdiction)
- Specified by:
setJurisdictionin classCanonicalResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Specified by:
hasJurisdictionin classCanonicalResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Specified by:
addJurisdictionin classCanonicalResource
-
addJurisdiction
public Library addJurisdiction(CodeableConcept t)
- Specified by:
addJurisdictionin classCanonicalResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Specified by:
getJurisdictionFirstRepin classCanonicalResource- Returns:
- The first repetition of repeating field
jurisdiction, creating it if it does not already exist {3}
-
getPurposeElement
public MarkdownType getPurposeElement()
- Specified by:
getPurposeElementin classCanonicalResource- Returns:
purpose(Explanation of why this library is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
hasPurposeElement
public boolean hasPurposeElement()
- Specified by:
hasPurposeElementin classCanonicalResource
-
hasPurpose
public boolean hasPurpose()
- Specified by:
hasPurposein classCanonicalResource
-
setPurposeElement
public Library setPurposeElement(MarkdownType value)
- Specified by:
setPurposeElementin classCanonicalResource- Parameters:
value-purpose(Explanation of why this library is needed and why it has been designed as it has.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the value
-
getPurpose
public String getPurpose()
- Specified by:
getPurposein classCanonicalResource- Returns:
- Explanation of why this library is needed and why it has been designed as it has.
-
setPurpose
public Library setPurpose(String value)
- Specified by:
setPurposein classCanonicalResource- Parameters:
value- Explanation of why this library is needed and why it has been designed as it has.
-
getUsageElement
public StringType getUsageElement()
- Returns:
usage(A detailed description of how the library is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
hasUsageElement
public boolean hasUsageElement()
-
hasUsage
public boolean hasUsage()
-
setUsageElement
public Library setUsageElement(StringType value)
- Parameters:
value-usage(A detailed description of how the library is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the value
-
getUsage
public String getUsage()
- Returns:
- A detailed description of how the library is used from a clinical perspective.
-
setUsage
public Library setUsage(String value)
- Parameters:
value- A detailed description of how the library is used from a clinical perspective.
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- Specified by:
getCopyrightElementin classCanonicalResource- Returns:
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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
hasCopyrightElement
public boolean hasCopyrightElement()
- Specified by:
hasCopyrightElementin classCanonicalResource
-
hasCopyright
public boolean hasCopyright()
- Specified by:
hasCopyrightin classCanonicalResource
-
setCopyrightElement
public Library setCopyrightElement(MarkdownType value)
- Specified by:
setCopyrightElementin classCanonicalResource- Parameters:
value-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.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the value
-
getCopyright
public String getCopyright()
- Specified by:
getCopyrightin classCanonicalResource- Returns:
- 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.
-
setCopyright
public Library setCopyright(String value)
- Specified by:
setCopyrightin classCanonicalResource- Parameters:
value- 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.
-
getApprovalDateElement
public DateType getApprovalDateElement()
- Specified by:
getApprovalDateElementin classMetadataResource- Returns:
approvalDate(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
hasApprovalDateElement
public boolean hasApprovalDateElement()
- Specified by:
hasApprovalDateElementin classMetadataResource
-
hasApprovalDate
public boolean hasApprovalDate()
- Specified by:
hasApprovalDatein classMetadataResource
-
setApprovalDateElement
public Library setApprovalDateElement(DateType value)
- Specified by:
setApprovalDateElementin classMetadataResource- Parameters:
value-approvalDate(The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.). This is the underlying object with id, value and extensions. The accessor "getApprovalDate" gives direct access to the value
-
getApprovalDate
public Date getApprovalDate()
- Specified by:
getApprovalDatein classMetadataResource- Returns:
- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
setApprovalDate
public Library setApprovalDate(Date value)
- Specified by:
setApprovalDatein classMetadataResource- Parameters:
value- The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
-
getLastReviewDateElement
public DateType getLastReviewDateElement()
- Specified by:
getLastReviewDateElementin classMetadataResource- Returns:
lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
hasLastReviewDateElement
public boolean hasLastReviewDateElement()
- Specified by:
hasLastReviewDateElementin classMetadataResource
-
hasLastReviewDate
public boolean hasLastReviewDate()
- Specified by:
hasLastReviewDatein classMetadataResource
-
setLastReviewDateElement
public Library setLastReviewDateElement(DateType value)
- Specified by:
setLastReviewDateElementin classMetadataResource- Parameters:
value-lastReviewDate(The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the value
-
getLastReviewDate
public Date getLastReviewDate()
- Specified by:
getLastReviewDatein classMetadataResource- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
setLastReviewDate
public Library setLastReviewDate(Date value)
- Specified by:
setLastReviewDatein classMetadataResource- Parameters:
value- The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
-
getEffectivePeriod
public Period getEffectivePeriod()
- Specified by:
getEffectivePeriodin classMetadataResource- Returns:
effectivePeriod(The period during which the library content was or is planned to be in active use.)
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
- Specified by:
hasEffectivePeriodin classMetadataResource
-
setEffectivePeriod
public Library setEffectivePeriod(Period value)
- Specified by:
setEffectivePeriodin classMetadataResource- Parameters:
value-effectivePeriod(The period during which the library content was or is planned to be in active use.)
-
getTopic
public List<CodeableConcept> getTopic()
- Specified by:
getTopicin classMetadataResource- Returns:
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.)
-
setTopic
public Library setTopic(List<CodeableConcept> theTopic)
- Specified by:
setTopicin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasTopic
public boolean hasTopic()
- Specified by:
hasTopicin classMetadataResource
-
addTopic
public CodeableConcept addTopic()
- Specified by:
addTopicin classMetadataResource
-
addTopic
public Library addTopic(CodeableConcept t)
- Specified by:
addTopicin classMetadataResource
-
getTopicFirstRep
public CodeableConcept getTopicFirstRep()
- Specified by:
getTopicFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
topic, creating it if it does not already exist {3}
-
getAuthor
public List<ContactDetail> getAuthor()
- Specified by:
getAuthorin classMetadataResource- Returns:
author(An individiual or organization primarily involved in the creation and maintenance of the content.)
-
setAuthor
public Library setAuthor(List<ContactDetail> theAuthor)
- Specified by:
setAuthorin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAuthor
public boolean hasAuthor()
- Specified by:
hasAuthorin classMetadataResource
-
addAuthor
public ContactDetail addAuthor()
- Specified by:
addAuthorin classMetadataResource
-
addAuthor
public Library addAuthor(ContactDetail t)
- Specified by:
addAuthorin classMetadataResource
-
getAuthorFirstRep
public ContactDetail getAuthorFirstRep()
- Specified by:
getAuthorFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
author, creating it if it does not already exist {3}
-
getEditor
public List<ContactDetail> getEditor()
- Specified by:
getEditorin classMetadataResource- Returns:
editor(An individual or organization primarily responsible for internal coherence of the content.)
-
setEditor
public Library setEditor(List<ContactDetail> theEditor)
- Specified by:
setEditorin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEditor
public boolean hasEditor()
- Specified by:
hasEditorin classMetadataResource
-
addEditor
public ContactDetail addEditor()
- Specified by:
addEditorin classMetadataResource
-
addEditor
public Library addEditor(ContactDetail t)
- Specified by:
addEditorin classMetadataResource
-
getEditorFirstRep
public ContactDetail getEditorFirstRep()
- Specified by:
getEditorFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
editor, creating it if it does not already exist {3}
-
getReviewer
public List<ContactDetail> getReviewer()
- Specified by:
getReviewerin classMetadataResource- Returns:
reviewer(An individual or organization primarily responsible for review of some aspect of the content.)
-
setReviewer
public Library setReviewer(List<ContactDetail> theReviewer)
- Specified by:
setReviewerin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReviewer
public boolean hasReviewer()
- Specified by:
hasReviewerin classMetadataResource
-
addReviewer
public ContactDetail addReviewer()
- Specified by:
addReviewerin classMetadataResource
-
addReviewer
public Library addReviewer(ContactDetail t)
- Specified by:
addReviewerin classMetadataResource
-
getReviewerFirstRep
public ContactDetail getReviewerFirstRep()
- Specified by:
getReviewerFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
reviewer, creating it if it does not already exist {3}
-
getEndorser
public List<ContactDetail> getEndorser()
- Specified by:
getEndorserin classMetadataResource- Returns:
endorser(An individual or organization responsible for officially endorsing the content for use in some setting.)
-
setEndorser
public Library setEndorser(List<ContactDetail> theEndorser)
- Specified by:
setEndorserin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEndorser
public boolean hasEndorser()
- Specified by:
hasEndorserin classMetadataResource
-
addEndorser
public ContactDetail addEndorser()
- Specified by:
addEndorserin classMetadataResource
-
addEndorser
public Library addEndorser(ContactDetail t)
- Specified by:
addEndorserin classMetadataResource
-
getEndorserFirstRep
public ContactDetail getEndorserFirstRep()
- Specified by:
getEndorserFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
endorser, creating it if it does not already exist {3}
-
getRelatedArtifact
public List<RelatedArtifact> getRelatedArtifact()
- Specified by:
getRelatedArtifactin classMetadataResource- Returns:
relatedArtifact(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
public Library setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
- Specified by:
setRelatedArtifactin classMetadataResource- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRelatedArtifact
public boolean hasRelatedArtifact()
- Specified by:
hasRelatedArtifactin classMetadataResource
-
addRelatedArtifact
public RelatedArtifact addRelatedArtifact()
- Specified by:
addRelatedArtifactin classMetadataResource
-
addRelatedArtifact
public Library addRelatedArtifact(RelatedArtifact t)
- Specified by:
addRelatedArtifactin classMetadataResource
-
getRelatedArtifactFirstRep
public RelatedArtifact getRelatedArtifactFirstRep()
- Specified by:
getRelatedArtifactFirstRepin classMetadataResource- Returns:
- The first repetition of repeating field
relatedArtifact, creating it if it does not already exist {3}
-
getParameter
public List<ParameterDefinition> getParameter()
- Returns:
parameter(The parameter element defines parameters used by the library.)
-
setParameter
public Library setParameter(List<ParameterDefinition> theParameter)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasParameter
public boolean hasParameter()
-
addParameter
public ParameterDefinition addParameter()
-
addParameter
public Library addParameter(ParameterDefinition t)
-
getParameterFirstRep
public ParameterDefinition getParameterFirstRep()
- Returns:
- The first repetition of repeating field
parameter, creating it if it does not already exist {3}
-
getDataRequirement
public List<DataRequirement> getDataRequirement()
- Returns:
dataRequirement(Describes a set of data that must be provided in order to be able to successfully perform the computations defined by the library.)
-
setDataRequirement
public Library setDataRequirement(List<DataRequirement> theDataRequirement)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDataRequirement
public boolean hasDataRequirement()
-
addDataRequirement
public DataRequirement addDataRequirement()
-
addDataRequirement
public Library addDataRequirement(DataRequirement t)
-
getDataRequirementFirstRep
public DataRequirement getDataRequirementFirstRep()
- Returns:
- The first repetition of repeating field
dataRequirement, creating it if it does not already exist {3}
-
getContent
public List<Attachment> getContent()
- Returns:
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.)
-
setContent
public Library setContent(List<Attachment> theContent)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContent
public boolean hasContent()
-
addContent
public Attachment addContent()
-
addContent
public Library addContent(Attachment t)
-
getContentFirstRep
public Attachment getContentFirstRep()
- Returns:
- The first repetition of repeating field
content, creating it if it does not already exist {3}
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classMetadataResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classMetadataResource
-
copy
public Library copy()
- Specified by:
copyin classMetadataResource
-
copyValues
public void copyValues(Library dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-