Package org.hl7.fhir.dstu2016may.model

Class Library

java.lang.Object

org.hl7.fhir.dstu2016may.model.Base

org.hl7.fhir.dstu2016may.model.BaseResource

org.hl7.fhir.dstu2016may.model.Resource

org.hl7.fhir.dstu2016may.model.DomainResource

org.hl7.fhir.dstu2016may.model.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 DomainResource

The Library resource provides a representation container for knowledge artifact component definitions. It is effectively an exposure of the header information for a CQL/ELM library.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Library.LibraryCodeSystemComponent
static class	Library.LibraryLibraryComponent
static class	Library.LibraryModelComponent
static class	Library.LibraryValueSetComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Library.LibraryCodeSystemComponent>	codeSystem	A code system definition used within the library.
protected List<DataRequirement>	dataRequirement	The dataRequirement element specifies a data requirement used by some expression within the library.
static ca.uhn.fhir.rest.gclient.StringClientParam	DESCRIPTION	Fluent Client search parameter constant for description
protected Attachment	document	The content of the library as an Attachment.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<Library.LibraryLibraryComponent>	library	A library element describes a library referenced by this library.
protected List<Library.LibraryModelComponent>	model	A model element describes the model and version used by the library.
protected ModuleMetadata	moduleMetadata	The metadata for the library, including publishing, life-cycle, version, documentation, and supporting evidence.
protected List<ParameterDefinition>	parameter	The parameter element defines parameters used by the library.
static String	SP_DESCRIPTION	Search parameter: description
static String	SP_IDENTIFIER	Search parameter: identifier
static String	SP_STATUS	Search parameter: status
static String	SP_TITLE	Search parameter: title
static String	SP_TOPIC	Search parameter: topic
static String	SP_VERSION	Search parameter: version
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
static ca.uhn.fhir.rest.gclient.StringClientParam	TITLE	Fluent Client search parameter constant for title
static ca.uhn.fhir.rest.gclient.TokenClientParam	TOPIC	Fluent Client search parameter constant for topic
protected List<Library.LibraryValueSetComponent>	valueSet	A value set definition referenced by the library.
static ca.uhn.fhir.rest.gclient.StringClientParam	VERSION	Fluent Client search parameter constant for version

Fields inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu2016may.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Library()	Constructor
Library(Attachment document)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Library.LibraryCodeSystemComponent	addCodeSystem()
Library	addCodeSystem(Library.LibraryCodeSystemComponent t)
DataRequirement	addDataRequirement()
Library	addDataRequirement(DataRequirement t)
Library.LibraryLibraryComponent	addLibrary()
Library	addLibrary(Library.LibraryLibraryComponent t)
Library.LibraryModelComponent	addModel()
Library	addModel(Library.LibraryModelComponent t)
ParameterDefinition	addParameter()
Library	addParameter(ParameterDefinition t)
Library.LibraryValueSetComponent	addValueSet()
Library	addValueSet(Library.LibraryValueSetComponent t)
Library	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
List<Library.LibraryCodeSystemComponent>	getCodeSystem()
List<DataRequirement>	getDataRequirement()
Attachment	getDocument()
List<Library.LibraryLibraryComponent>	getLibrary()
List<Library.LibraryModelComponent>	getModel()
ModuleMetadata	getModuleMetadata()
List<ParameterDefinition>	getParameter()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
List<Library.LibraryValueSetComponent>	getValueSet()
boolean	hasCodeSystem()
boolean	hasDataRequirement()
boolean	hasDocument()
boolean	hasLibrary()
boolean	hasModel()
boolean	hasModuleMetadata()
boolean	hasParameter()
boolean	hasValueSet()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)	make an instance of a property.
Library	setDocument(Attachment value)
Library	setModuleMetadata(ModuleMetadata value)
void	setProperty(int hash, String name, Base value)
void	setProperty(String name, Base value)
protected Library	typedCopy()

Methods inherited from class org.hl7.fhir.dstu2016may.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText

Methods inherited from class org.hl7.fhir.dstu2016may.model.Resource

copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu2016may.model.BaseResource

getStructureFhirVersionEnum, setId

Methods inherited from class org.hl7.fhir.dstu2016may.model.Base

castToActionDefinition, castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToModuleMetadata, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Detail

moduleMetadata

protected ModuleMetadata moduleMetadata

The metadata for the library, including publishing, life-cycle, version, documentation, and supporting evidence.

model

protected List<Library.LibraryModelComponent> model

A model element describes the model and version used by the library.

library

protected List<Library.LibraryLibraryComponent> library

A library element describes a library referenced by this library.

codeSystem

protected List<Library.LibraryCodeSystemComponent> codeSystem

A code system definition used within the library.

valueSet

protected List<Library.LibraryValueSetComponent> valueSet

A value set definition referenced by the library.

parameter

protected List<ParameterDefinition> parameter

The parameter element defines parameters used by the library.

dataRequirement

protected List<DataRequirement> dataRequirement

The dataRequirement element specifies a data requirement used by some expression within the library.

document

protected Attachment document

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 content is expected to be a CQL or ELM document.

SP_TOPIC

public static final String SP_TOPIC

Search parameter: topic

Description: Topics associated with the module
Type: token
Path: Library.moduleMetadata.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.moduleMetadata.topic

SP_TITLE

public static final String SP_TITLE

Search parameter: title

Description: Text search against the title
Type: string
Path: Library.moduleMetadata.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: Text search against the title
Type: string
Path: Library.moduleMetadata.title

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: Status of the module
Type: token
Path: Library.moduleMetadata.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: Status of the module
Type: token
Path: Library.moduleMetadata.status

SP_DESCRIPTION

public static final String SP_DESCRIPTION

Search parameter: description

Description: Text search against the description
Type: string
Path: Library.moduleMetadata.description

See Also:

Constant Field Values

DESCRIPTION

public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION

Fluent Client search parameter constant for description

Description: Text search against the description
Type: string
Path: Library.moduleMetadata.description

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Logical identifier for the module (e.g. CMS-143)
Type: token
Path: Library.moduleMetadata.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: Logical identifier for the module (e.g. CMS-143)
Type: token
Path: Library.moduleMetadata.identifier

SP_VERSION

public static final String SP_VERSION

Search parameter: version

Description: Version of the module (e.g. 1.0.0)
Type: string
Path: Library.moduleMetadata.version

See Also:

Constant Field Values

VERSION

public static final ca.uhn.fhir.rest.gclient.StringClientParam VERSION

Fluent Client search parameter constant for version

Description: Version of the module (e.g. 1.0.0)
Type: string
Path: Library.moduleMetadata.version

Constructor Detail

Library

public Library()

Constructor

Library

public Library(Attachment document)

Constructor

Method Detail

getModuleMetadata

public ModuleMetadata getModuleMetadata()

Returns:

moduleMetadata (The metadata for the library, including publishing, life-cycle, version, documentation, and supporting evidence.)

hasModuleMetadata

public boolean hasModuleMetadata()

setModuleMetadata

public Library setModuleMetadata(ModuleMetadata value)

Parameters:

value - moduleMetadata (The metadata for the library, including publishing, life-cycle, version, documentation, and supporting evidence.)

getModel

public List<Library.LibraryModelComponent> getModel()

Returns:

model (A model element describes the model and version used by the library.)

hasModel

public boolean hasModel()

addModel

public Library.LibraryModelComponent addModel()

Returns:

model (A model element describes the model and version used by the library.)

addModel

public Library addModel(Library.LibraryModelComponent t)

getLibrary

public List<Library.LibraryLibraryComponent> getLibrary()

Returns:

library (A library element describes a library referenced by this library.)

hasLibrary

public boolean hasLibrary()

addLibrary

public Library.LibraryLibraryComponent addLibrary()

Returns:

library (A library element describes a library referenced by this library.)

addLibrary

public Library addLibrary(Library.LibraryLibraryComponent t)

getCodeSystem

public List<Library.LibraryCodeSystemComponent> getCodeSystem()

Returns:

codeSystem (A code system definition used within the library.)

hasCodeSystem

public boolean hasCodeSystem()

addCodeSystem

public Library.LibraryCodeSystemComponent addCodeSystem()

Returns:

codeSystem (A code system definition used within the library.)

addCodeSystem

public Library addCodeSystem(Library.LibraryCodeSystemComponent t)

getValueSet

public List<Library.LibraryValueSetComponent> getValueSet()

Returns:

valueSet (A value set definition referenced by the library.)

hasValueSet

public boolean hasValueSet()

addValueSet

public Library.LibraryValueSetComponent addValueSet()

Returns:

valueSet (A value set definition referenced by the library.)

addValueSet

public Library addValueSet(Library.LibraryValueSetComponent t)

getParameter

public List<ParameterDefinition> getParameter()

Returns:

parameter (The parameter element defines parameters used by the library.)

hasParameter

public boolean hasParameter()

addParameter

public ParameterDefinition addParameter()

Returns:

parameter (The parameter element defines parameters used by the library.)

addParameter

public Library addParameter(ParameterDefinition t)

getDataRequirement

public List<DataRequirement> getDataRequirement()

Returns:

dataRequirement (The dataRequirement element specifies a data requirement used by some expression within the library.)

hasDataRequirement

public boolean hasDataRequirement()

addDataRequirement

public DataRequirement addDataRequirement()

Returns:

dataRequirement (The dataRequirement element specifies a data requirement used by some expression within the library.)

addDataRequirement

public Library addDataRequirement(DataRequirement t)

getDocument

public Attachment getDocument()

Returns:

document (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 content is expected to be a CQL or ELM document.)

hasDocument

public boolean hasDocument()

setDocument

public Library setDocument(Attachment value)

Parameters:

value - document (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 content is expected to be a CQL or ELM document.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public void setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Description copied from class: Base

make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property

Overrides:

makeProperty in class DomainResource

Returns:

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public Library copy()

Specified by:

copy in class DomainResource

typedCopy

protected Library typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource