
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 DateType
approvalDate
The date on which the resource content was approved by the publisher.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
COMPOSED_OF
Fluent Client search parameter constant for composed-ofprotected List<Attachment>
content
The content of the library as an Attachment.protected List<Contributor>
contributor
A contributor to the content of the library, including authors, editors, reviewers, and endorsers.protected MarkdownType
copyright
A copyright statement relating to the library and/or its contents.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.static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
DEPENDS_ON
Fluent Client search parameter constant for depends-onstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
DERIVED_FROM
Fluent Client search parameter constant for derived-fromstatic ca.uhn.fhir.rest.gclient.StringClientParam
DESCRIPTION
Fluent Client search parameter constant for descriptionstatic ca.uhn.fhir.rest.gclient.DateClientParam
EFFECTIVE
Fluent Client search parameter constant for effectiveprotected Period
effectivePeriod
The period during which the library content was or is planned to be in active use.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.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.TokenClientParam
JURISDICTION
Fluent Client search parameter constant for jurisdictionprotected DateType
lastReviewDate
The date on which the resource content was last reviewed.static ca.uhn.fhir.rest.gclient.StringClientParam
NAME
Fluent Client search parameter constant for nameprotected List<ParameterDefinition>
parameter
The parameter element defines parameters used by the library.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PREDECESSOR
Fluent Client search parameter constant for predecessorstatic ca.uhn.fhir.rest.gclient.StringClientParam
PUBLISHER
Fluent Client search parameter constant for publisherprotected MarkdownType
purpose
Explaination of why this library is needed and why it has been designed as it has.protected List<RelatedArtifact>
relatedArtifact
Related artifacts such as additional documentation, justification, or bibliographic references.static String
SP_COMPOSED_OF
Search parameter: composed-ofstatic String
SP_DATE
Search parameter: datestatic String
SP_DEPENDS_ON
Search parameter: depends-onstatic String
SP_DERIVED_FROM
Search parameter: derived-fromstatic String
SP_DESCRIPTION
Search parameter: descriptionstatic String
SP_EFFECTIVE
Search parameter: effectivestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_JURISDICTION
Search parameter: jurisdictionstatic String
SP_NAME
Search parameter: namestatic String
SP_PREDECESSOR
Search parameter: predecessorstatic String
SP_PUBLISHER
Search parameter: publisherstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUCCESSOR
Search parameter: successorstatic String
SP_TITLE
Search parameter: titlestatic String
SP_TOPIC
Search parameter: topicstatic String
SP_URL
Search parameter: urlstatic String
SP_VERSION
Search parameter: versionstatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUCCESSOR
Fluent Client search parameter constant for successorstatic ca.uhn.fhir.rest.gclient.StringClientParam
TITLE
Fluent Client search parameter constant for titleprotected List<CodeableConcept>
topic
Descriptive topics related to the content of the library.static ca.uhn.fhir.rest.gclient.TokenClientParam
TOPIC
Fluent Client search parameter constant for topicprotected CodeableConcept
type
Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.static ca.uhn.fhir.rest.gclient.UriClientParam
URL
Fluent Client search parameter constant for urlprotected StringType
usage
A detailed description of how the library is used from a clinical perspective.static ca.uhn.fhir.rest.gclient.TokenClientParam
VERSION
Fluent Client search parameter constant for version-
Fields inherited from class org.hl7.fhir.dstu3.model.MetadataResource
contact, date, description, experimental, jurisdiction, name, publisher, status, title, url, useContext, version
-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Library()
ConstructorLibrary(Enumeration<Enumerations.PublicationStatus> status, CodeableConcept type)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.MetadataResource
checkCanUseUrl, copyValues, toString
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
-
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.
-
type
protected CodeableConcept type
Identifies the type of library such as a Logic Library, Model Definition, Asset Collection, or Module Definition.
-
purpose
protected MarkdownType purpose
Explaination of why this library is needed and why it has been designed as it has.
-
usage
protected StringType usage
A detailed description of how the library is used from a clinical perspective.
-
approvalDate
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 doesn't 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.
-
contributor
protected List<Contributor> contributor
A contributor to the content of the library, including authors, editors, reviewers, and endorsers.
-
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.
-
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_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_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_SUCCESSOR
public static final String SP_SUCCESSOR
Search parameter: successorDescription: What resource is being referenced
Type: reference
Path: Library.relatedArtifact.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.resource
-
INCLUDE_SUCCESSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUCCESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:successor".
-
SP_JURISDICTION
public static final String SP_JURISDICTION
Search parameter: 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_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_DERIVED_FROM
public static final String SP_DERIVED_FROM
Search parameter: derived-fromDescription: What resource is being referenced
Type: reference
Path: Library.relatedArtifact.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.resource
-
INCLUDE_DERIVED_FROM
public static final ca.uhn.fhir.model.api.Include INCLUDE_DERIVED_FROM
Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:derived-from".
-
SP_PREDECESSOR
public static final String SP_PREDECESSOR
Search parameter: predecessorDescription: What resource is being referenced
Type: reference
Path: Library.relatedArtifact.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.resource
-
INCLUDE_PREDECESSOR
public static final ca.uhn.fhir.model.api.Include INCLUDE_PREDECESSOR
Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:predecessor".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: 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_COMPOSED_OF
public static final String SP_COMPOSED_OF
Search parameter: composed-ofDescription: What resource is being referenced
Type: reference
Path: Library.relatedArtifact.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.resource
-
INCLUDE_COMPOSED_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_COMPOSED_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:composed-of".
-
SP_VERSION
public static final String SP_VERSION
Search parameter: 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
-
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_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_DEPENDS_ON
public static final String SP_DEPENDS_ON
Search parameter: depends-onDescription: What resource is being referenced
Type: reference
Path: Library.relatedArtifact.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.resource
-
INCLUDE_DEPENDS_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEPENDS_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Library:depends-on".
-
SP_NAME
public static final String SP_NAME
Search parameter: 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_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_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_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
-
-
Constructor Detail
-
Library
public Library()
Constructor
-
Library
public Library(Enumeration<Enumerations.PublicationStatus> status, CodeableConcept type)
Constructor
-
-
Method Detail
-
getUrlElement
public UriType getUrlElement()
- Overrides:
getUrlElement
in classMetadataResource
- Returns:
MetadataResource.url
(An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
hasUrlElement
public boolean hasUrlElement()
- Overrides:
hasUrlElement
in classMetadataResource
-
hasUrl
public boolean hasUrl()
- Overrides:
hasUrl
in classMetadataResource
-
setUrlElement
public Library setUrlElement(UriType value)
- Overrides:
setUrlElement
in classMetadataResource
- Parameters:
value
-MetadataResource.url
(An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value
-
getUrl
public String getUrl()
- Overrides:
getUrl
in classMetadataResource
- Returns:
- An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).
-
setUrl
public Library setUrl(String value)
- Overrides:
setUrl
in classMetadataResource
- Parameters:
value
- An absolute URI that is used to identify this library when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this library is (or will be) published. The URL SHOULD include the major version of the library. For more information see [Technical and Business Versions](resource.html#versions).
-
getIdentifier
public List<Identifier> getIdentifier()
- 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)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Library addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getVersionElement
public StringType getVersionElement()
- Overrides:
getVersionElement
in classMetadataResource
- Returns:
MetadataResource.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()
- Overrides:
hasVersionElement
in classMetadataResource
-
hasVersion
public boolean hasVersion()
- Overrides:
hasVersion
in classMetadataResource
-
setVersionElement
public Library setVersionElement(StringType value)
- Overrides:
setVersionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.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()
- Overrides:
getVersion
in classMetadataResource
- 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)
- Overrides:
setVersion
in classMetadataResource
- 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()
- Overrides:
getNameElement
in classMetadataResource
- Returns:
MetadataResource.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()
- Overrides:
hasNameElement
in classMetadataResource
-
hasName
public boolean hasName()
- Overrides:
hasName
in classMetadataResource
-
setNameElement
public Library setNameElement(StringType value)
- Overrides:
setNameElement
in classMetadataResource
- Parameters:
value
-MetadataResource.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()
- Overrides:
getName
in classMetadataResource
- 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)
- Overrides:
setName
in classMetadataResource
- 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()
- Overrides:
getTitleElement
in classMetadataResource
- Returns:
MetadataResource.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()
- Overrides:
hasTitleElement
in classMetadataResource
-
hasTitle
public boolean hasTitle()
- Overrides:
hasTitle
in classMetadataResource
-
setTitleElement
public Library setTitleElement(StringType value)
- Overrides:
setTitleElement
in classMetadataResource
- Parameters:
value
-MetadataResource.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()
- Overrides:
getTitle
in classMetadataResource
- Returns:
- A short, descriptive, user-friendly title for the library.
-
setTitle
public Library setTitle(String value)
- Overrides:
setTitle
in classMetadataResource
- Parameters:
value
- A short, descriptive, user-friendly title for the library.
-
getStatusElement
public Enumeration<Enumerations.PublicationStatus> getStatusElement()
- Overrides:
getStatusElement
in classMetadataResource
- Returns:
MetadataResource.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()
- Overrides:
hasStatusElement
in classMetadataResource
-
hasStatus
public boolean hasStatus()
- Overrides:
hasStatus
in classMetadataResource
-
setStatusElement
public Library setStatusElement(Enumeration<Enumerations.PublicationStatus> value)
- Overrides:
setStatusElement
in classMetadataResource
- Parameters:
value
-MetadataResource.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()
- Overrides:
getStatus
in classMetadataResource
- Returns:
- The status of this library. Enables tracking the life-cycle of the content.
-
setStatus
public Library setStatus(Enumerations.PublicationStatus value)
- Overrides:
setStatus
in classMetadataResource
- Parameters:
value
- The status of this library. Enables tracking the life-cycle of the content.
-
getExperimentalElement
public BooleanType getExperimentalElement()
- Overrides:
getExperimentalElement
in classMetadataResource
- Returns:
MetadataResource.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()
- Overrides:
hasExperimentalElement
in classMetadataResource
-
hasExperimental
public boolean hasExperimental()
- Overrides:
hasExperimental
in classMetadataResource
-
setExperimentalElement
public Library setExperimentalElement(BooleanType value)
- Overrides:
setExperimentalElement
in classMetadataResource
- Parameters:
value
-MetadataResource.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()
- Overrides:
getExperimental
in classMetadataResource
- 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)
- Overrides:
setExperimental
in classMetadataResource
- 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.)
-
getDateElement
public DateTimeType getDateElement()
- Overrides:
getDateElement
in classMetadataResource
- Returns:
MetadataResource.date
(The date (and optionally time) when the library was published. The date must change if and 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()
- Overrides:
hasDateElement
in classMetadataResource
-
hasDate
public boolean hasDate()
- Overrides:
hasDate
in classMetadataResource
-
setDateElement
public Library setDateElement(DateTimeType value)
- Overrides:
setDateElement
in classMetadataResource
- Parameters:
value
-MetadataResource.date
(The date (and optionally time) when the library was published. The date must change if and 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()
- Overrides:
getDate
in classMetadataResource
- Returns:
- The date (and optionally time) when the library was published. The date must change if and 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)
- Overrides:
setDate
in classMetadataResource
- Parameters:
value
- The date (and optionally time) when the library was published. The date must change if and 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()
- Overrides:
getPublisherElement
in classMetadataResource
- Returns:
MetadataResource.publisher
(The name of the individual or organization 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()
- Overrides:
hasPublisherElement
in classMetadataResource
-
hasPublisher
public boolean hasPublisher()
- Overrides:
hasPublisher
in classMetadataResource
-
setPublisherElement
public Library setPublisherElement(StringType value)
- Overrides:
setPublisherElement
in classMetadataResource
- Parameters:
value
-MetadataResource.publisher
(The name of the individual or organization 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()
- Overrides:
getPublisher
in classMetadataResource
- Returns:
- The name of the individual or organization that published the library.
-
setPublisher
public Library setPublisher(String value)
- Overrides:
setPublisher
in classMetadataResource
- Parameters:
value
- The name of the individual or organization that published the library.
-
getDescriptionElement
public MarkdownType getDescriptionElement()
- Overrides:
getDescriptionElement
in classMetadataResource
- Returns:
MetadataResource.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()
- Overrides:
hasDescriptionElement
in classMetadataResource
-
hasDescription
public boolean hasDescription()
- Overrides:
hasDescription
in classMetadataResource
-
setDescriptionElement
public Library setDescriptionElement(MarkdownType value)
- Overrides:
setDescriptionElement
in classMetadataResource
- Parameters:
value
-MetadataResource.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()
- Overrides:
getDescription
in classMetadataResource
- Returns:
- A free text natural language description of the library from a consumer's perspective.
-
setDescription
public Library setDescription(String value)
- Overrides:
setDescription
in classMetadataResource
- Parameters:
value
- A free text natural language description of the library from a consumer's perspective.
-
getPurposeElement
public MarkdownType getPurposeElement()
- Returns:
purpose
(Explaination 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()
-
hasPurpose
public boolean hasPurpose()
-
setPurposeElement
public Library setPurposeElement(MarkdownType value)
- Parameters:
value
-purpose
(Explaination 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()
- Returns:
- Explaination of why this library is needed and why it has been designed as it has.
-
setPurpose
public Library setPurpose(String value)
- Parameters:
value
- Explaination 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.
-
getApprovalDateElement
public DateType getApprovalDateElement()
- 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()
-
hasApprovalDate
public boolean hasApprovalDate()
-
setApprovalDateElement
public Library setApprovalDateElement(DateType value)
- 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()
- 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)
- 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()
- Returns:
lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't 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()
-
hasLastReviewDate
public boolean hasLastReviewDate()
-
setLastReviewDateElement
public Library setLastReviewDateElement(DateType value)
- Parameters:
value
-lastReviewDate
(The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't 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()
- Returns:
- The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
-
setLastReviewDate
public Library setLastReviewDate(Date value)
- Parameters:
value
- The date on which the resource content was last reviewed. Review happens periodically after approval, but doesn't change the original approval date.
-
getEffectivePeriod
public Period getEffectivePeriod()
- Returns:
effectivePeriod
(The period during which the library content was or is planned to be in active use.)
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
-
setEffectivePeriod
public Library setEffectivePeriod(Period value)
- Parameters:
value
-effectivePeriod
(The period during which the library content was or is planned to be in active use.)
-
getUseContext
public List<UsageContext> getUseContext()
- Overrides:
getUseContext
in classMetadataResource
- Returns:
MetadataResource.useContext
(The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching for appropriate library instances.)
-
setUseContext
public Library setUseContext(List<UsageContext> theUseContext)
- Overrides:
setUseContext
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUseContext
public boolean hasUseContext()
- Overrides:
hasUseContext
in classMetadataResource
-
addUseContext
public UsageContext addUseContext()
- Overrides:
addUseContext
in classMetadataResource
-
addUseContext
public Library addUseContext(UsageContext t)
- Overrides:
addUseContext
in classMetadataResource
-
getUseContextFirstRep
public UsageContext getUseContextFirstRep()
- Overrides:
getUseContextFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.useContext
, creating it if it does not already exist
-
getJurisdiction
public List<CodeableConcept> getJurisdiction()
- Overrides:
getJurisdiction
in classMetadataResource
- Returns:
MetadataResource.jurisdiction
(A legal or geographic region in which the library is intended to be used.)
-
setJurisdiction
public Library setJurisdiction(List<CodeableConcept> theJurisdiction)
- Overrides:
setJurisdiction
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasJurisdiction
public boolean hasJurisdiction()
- Overrides:
hasJurisdiction
in classMetadataResource
-
addJurisdiction
public CodeableConcept addJurisdiction()
- Overrides:
addJurisdiction
in classMetadataResource
-
addJurisdiction
public Library addJurisdiction(CodeableConcept t)
- Overrides:
addJurisdiction
in classMetadataResource
-
getJurisdictionFirstRep
public CodeableConcept getJurisdictionFirstRep()
- Overrides:
getJurisdictionFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.jurisdiction
, creating it if it does not already exist
-
getTopic
public List<CodeableConcept> getTopic()
- 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)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasTopic
public boolean hasTopic()
-
addTopic
public CodeableConcept addTopic()
-
addTopic
public Library addTopic(CodeableConcept t)
-
getTopicFirstRep
public CodeableConcept getTopicFirstRep()
- Returns:
- The first repetition of repeating field
topic
, creating it if it does not already exist
-
getContributor
public List<Contributor> getContributor()
- Returns:
contributor
(A contributor to the content of the library, including authors, editors, reviewers, and endorsers.)
-
setContributor
public Library setContributor(List<Contributor> theContributor)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContributor
public boolean hasContributor()
-
addContributor
public Contributor addContributor()
-
addContributor
public Library addContributor(Contributor t)
-
getContributorFirstRep
public Contributor getContributorFirstRep()
- Returns:
- The first repetition of repeating field
contributor
, creating it if it does not already exist
-
getContact
public List<ContactDetail> getContact()
- Overrides:
getContact
in classMetadataResource
- Returns:
MetadataResource.contact
(Contact details to assist a user in finding and communicating with the publisher.)
-
setContact
public Library setContact(List<ContactDetail> theContact)
- Overrides:
setContact
in classMetadataResource
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasContact
public boolean hasContact()
- Overrides:
hasContact
in classMetadataResource
-
addContact
public ContactDetail addContact()
- Overrides:
addContact
in classMetadataResource
-
addContact
public Library addContact(ContactDetail t)
- Overrides:
addContact
in classMetadataResource
-
getContactFirstRep
public ContactDetail getContactFirstRep()
- Overrides:
getContactFirstRep
in classMetadataResource
- Returns:
- The first repetition of repeating field
MetadataResource.contact
, creating it if it does not already exist
-
getCopyrightElement
public MarkdownType getCopyrightElement()
- 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()
-
hasCopyright
public boolean hasCopyright()
-
setCopyrightElement
public Library setCopyrightElement(MarkdownType value)
- 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()
- 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)
- 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.
-
getRelatedArtifact
public List<RelatedArtifact> getRelatedArtifact()
- Returns:
relatedArtifact
(Related artifacts such as additional documentation, justification, or bibliographic references.)
-
setRelatedArtifact
public Library setRelatedArtifact(List<RelatedArtifact> theRelatedArtifact)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRelatedArtifact
public boolean hasRelatedArtifact()
-
addRelatedArtifact
public RelatedArtifact addRelatedArtifact()
-
addRelatedArtifact
public Library addRelatedArtifact(RelatedArtifact t)
-
getRelatedArtifactFirstRep
public RelatedArtifact getRelatedArtifactFirstRep()
- Returns:
- The first repetition of repeating field
relatedArtifact
, creating it if it does not already exist
-
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
this
for 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
-
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
this
for 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
-
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
this
for 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
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classMetadataResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classMetadataResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classMetadataResource
-
copy
public Library copy()
- Specified by:
copy
in classMetadataResource
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classMetadataResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classMetadataResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classMetadataResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-