public class ModuleMetadata extends Type implements org.hl7.fhir.instance.model.api.ICompositeType
| Modifier and Type | Class and Description |
|---|---|
static class |
ModuleMetadata.ModuleMetadataContactComponent |
static class |
ModuleMetadata.ModuleMetadataContributorComponent |
static class |
ModuleMetadata.ModuleMetadataContributorContactComponent |
static class |
ModuleMetadata.ModuleMetadataContributorType |
static class |
ModuleMetadata.ModuleMetadataContributorTypeEnumFactory |
static class |
ModuleMetadata.ModuleMetadataCoverageComponent |
static class |
ModuleMetadata.ModuleMetadataRelatedResourceComponent |
static class |
ModuleMetadata.ModuleMetadataResourceType |
static class |
ModuleMetadata.ModuleMetadataResourceTypeEnumFactory |
static class |
ModuleMetadata.ModuleMetadataStatus |
static class |
ModuleMetadata.ModuleMetadataStatusEnumFactory |
static class |
ModuleMetadata.ModuleMetadataType |
static class |
ModuleMetadata.ModuleMetadataTypeEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected List<ModuleMetadata.ModuleMetadataContactComponent> |
contact
Contacts to assist a user in finding and communicating with the publisher.
|
protected List<ModuleMetadata.ModuleMetadataContributorComponent> |
contributor
A contributor to the content of the module, including authors, editors, reviewers, and endorsers.
|
protected StringType |
copyright
A copyright statement relating to the module and/or its contents.
|
protected List<ModuleMetadata.ModuleMetadataCoverageComponent> |
coverage
Specifies various attributes of the patient population for whom and/or environment of care in which the knowledge module is applicable.
|
protected StringType |
description
A free text natural language description of the module from the consumer's perspective.
|
protected Period |
effectivePeriod
The period during which the module content is effective.
|
protected BooleanType |
experimental
Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.
|
protected List<Identifier> |
identifier
A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.
|
protected DateType |
lastReviewDate
The date on which the module content was last reviewed.
|
protected StringType |
name
A machine-friendly name for the module.
|
protected DateType |
publicationDate
The date on which the module was published.
|
protected StringType |
publisher
The name of the individual or organization that published the module (also known as the steward for the module).
|
protected StringType |
purpose
A brief description of the purpose of the module.
|
protected List<ModuleMetadata.ModuleMetadataRelatedResourceComponent> |
relatedResource
Related resources such as additional documentation, justification, or bibliographic references.
|
protected Enumeration<ModuleMetadata.ModuleMetadataStatus> |
status
The status of the module.
|
protected StringType |
title
A short, descriptive, user-friendly title for the module.
|
protected List<CodeableConcept> |
topic
Clinical topics related to the content of the module.
|
protected Enumeration<ModuleMetadata.ModuleMetadataType> |
type
Identifies the type of knowledge module, such as a rule, library, documentation template, or measure.
|
protected UriType |
url
An absolute URL that is used to identify this module when it is referenced.
|
protected StringType |
usage
A detailed description of how the module is used from a clinical perspective.
|
protected StringType |
version
The version of the module, if any.
|
| Constructor and Description |
|---|
ModuleMetadata()
Constructor
|
ModuleMetadata(Enumeration<ModuleMetadata.ModuleMetadataType> type,
Enumeration<ModuleMetadata.ModuleMetadataStatus> status)
Constructor
|
addExtension, addExtension, copyValues, getExtension, getExtensionsByUrl, getExtensionString, getId, getIdElement, hasExtension, hasExtension, hasId, hasIdElement, setId, setIdElementcastToActionDefinition, 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, setUserDataINNprotected UriType url
protected List<Identifier> identifier
protected StringType version
protected StringType name
protected StringType title
protected Enumeration<ModuleMetadata.ModuleMetadataType> type
protected Enumeration<ModuleMetadata.ModuleMetadataStatus> status
protected BooleanType experimental
protected StringType description
protected StringType purpose
protected StringType usage
protected DateType publicationDate
protected DateType lastReviewDate
protected Period effectivePeriod
protected List<ModuleMetadata.ModuleMetadataCoverageComponent> coverage
protected List<CodeableConcept> topic
protected List<ModuleMetadata.ModuleMetadataContributorComponent> contributor
protected StringType publisher
protected List<ModuleMetadata.ModuleMetadataContactComponent> contact
protected StringType copyright
protected List<ModuleMetadata.ModuleMetadataRelatedResourceComponent> relatedResource
public ModuleMetadata()
public ModuleMetadata(Enumeration<ModuleMetadata.ModuleMetadataType> type, Enumeration<ModuleMetadata.ModuleMetadataStatus> status)
public UriType getUrlElement()
url (An absolute URL that is used to identify this module when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this module definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic boolean hasUrlElement()
public boolean hasUrl()
public ModuleMetadata setUrlElement(UriType value)
value - url (An absolute URL that is used to identify this module when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this module definition is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the valuepublic String getUrl()
public ModuleMetadata setUrl(String value)
value - An absolute URL that is used to identify this module when it is referenced. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this module definition is (or will be) published.public List<Identifier> getIdentifier()
identifier (A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.)public boolean hasIdentifier()
public Identifier addIdentifier()
identifier (A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.)public ModuleMetadata addIdentifier(Identifier t)
public StringType getVersionElement()
version (The version of the module, if any. 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 modules, refer to the Decision Support Service specification. Note that the version is required for non-experimental published artifact.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the valuepublic boolean hasVersionElement()
public boolean hasVersion()
public ModuleMetadata setVersionElement(StringType value)
value - version (The version of the module, if any. 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 modules, refer to the Decision Support Service specification. Note that the version is required for non-experimental published artifact.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the valuepublic String getVersion()
public ModuleMetadata setVersion(String value)
value - The version of the module, if any. 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 modules, refer to the Decision Support Service specification. Note that the version is required for non-experimental published artifact.public StringType getNameElement()
name (A machine-friendly name for the module. 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 valuepublic boolean hasNameElement()
public boolean hasName()
public ModuleMetadata setNameElement(StringType value)
value - name (A machine-friendly name for the module. 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 valuepublic String getName()
public ModuleMetadata setName(String value)
value - A machine-friendly name for the module. This name should be usable as an identifier for the module by machine processing applications such as code generation.public StringType getTitleElement()
title (A short, descriptive, user-friendly title for the module.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the valuepublic boolean hasTitleElement()
public boolean hasTitle()
public ModuleMetadata setTitleElement(StringType value)
value - title (A short, descriptive, user-friendly title for the module.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the valuepublic String getTitle()
public ModuleMetadata setTitle(String value)
value - A short, descriptive, user-friendly title for the module.public Enumeration<ModuleMetadata.ModuleMetadataType> getTypeElement()
type (Identifies the type of knowledge module, such as a rule, library, documentation template, or measure.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the valuepublic boolean hasTypeElement()
public boolean hasType()
public ModuleMetadata setTypeElement(Enumeration<ModuleMetadata.ModuleMetadataType> value)
value - type (Identifies the type of knowledge module, such as a rule, library, documentation template, or measure.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the valuepublic ModuleMetadata.ModuleMetadataType getType()
public ModuleMetadata setType(ModuleMetadata.ModuleMetadataType value)
value - Identifies the type of knowledge module, such as a rule, library, documentation template, or measure.public Enumeration<ModuleMetadata.ModuleMetadataStatus> getStatusElement()
status (The status of the module.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic boolean hasStatusElement()
public boolean hasStatus()
public ModuleMetadata setStatusElement(Enumeration<ModuleMetadata.ModuleMetadataStatus> value)
value - status (The status of the module.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic ModuleMetadata.ModuleMetadataStatus getStatus()
public ModuleMetadata setStatus(ModuleMetadata.ModuleMetadataStatus value)
value - The status of the module.public BooleanType getExperimentalElement()
experimental (Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the valuepublic boolean hasExperimentalElement()
public boolean hasExperimental()
public ModuleMetadata setExperimentalElement(BooleanType value)
value - experimental (Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the valuepublic boolean getExperimental()
public ModuleMetadata setExperimental(boolean value)
value - Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.public StringType getDescriptionElement()
description (A free text natural language description of the module from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic boolean hasDescriptionElement()
public boolean hasDescription()
public ModuleMetadata setDescriptionElement(StringType value)
value - description (A free text natural language description of the module from the consumer's perspective.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the valuepublic String getDescription()
public ModuleMetadata setDescription(String value)
value - A free text natural language description of the module from the consumer's perspective.public StringType getPurposeElement()
purpose (A brief description of the purpose of the module.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the valuepublic boolean hasPurposeElement()
public boolean hasPurpose()
public ModuleMetadata setPurposeElement(StringType value)
value - purpose (A brief description of the purpose of the module.). This is the underlying object with id, value and extensions. The accessor "getPurpose" gives direct access to the valuepublic String getPurpose()
public ModuleMetadata setPurpose(String value)
value - A brief description of the purpose of the module.public StringType getUsageElement()
usage (A detailed description of how the module is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the valuepublic boolean hasUsageElement()
public boolean hasUsage()
public ModuleMetadata setUsageElement(StringType value)
value - usage (A detailed description of how the module is used from a clinical perspective.). This is the underlying object with id, value and extensions. The accessor "getUsage" gives direct access to the valuepublic String getUsage()
public ModuleMetadata setUsage(String value)
value - A detailed description of how the module is used from a clinical perspective.public DateType getPublicationDateElement()
publicationDate (The date on which the module was published.). This is the underlying object with id, value and extensions. The accessor "getPublicationDate" gives direct access to the valuepublic boolean hasPublicationDateElement()
public boolean hasPublicationDate()
public ModuleMetadata setPublicationDateElement(DateType value)
value - publicationDate (The date on which the module was published.). This is the underlying object with id, value and extensions. The accessor "getPublicationDate" gives direct access to the valuepublic Date getPublicationDate()
public ModuleMetadata setPublicationDate(Date value)
value - The date on which the module was published.public DateType getLastReviewDateElement()
lastReviewDate (The date on which the module content was last reviewed.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the valuepublic boolean hasLastReviewDateElement()
public boolean hasLastReviewDate()
public ModuleMetadata setLastReviewDateElement(DateType value)
value - lastReviewDate (The date on which the module content was last reviewed.). This is the underlying object with id, value and extensions. The accessor "getLastReviewDate" gives direct access to the valuepublic Date getLastReviewDate()
public ModuleMetadata setLastReviewDate(Date value)
value - The date on which the module content was last reviewed.public Period getEffectivePeriod()
effectivePeriod (The period during which the module content is effective.)public boolean hasEffectivePeriod()
public ModuleMetadata setEffectivePeriod(Period value)
value - effectivePeriod (The period during which the module content is effective.)public List<ModuleMetadata.ModuleMetadataCoverageComponent> getCoverage()
coverage (Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicable.)public boolean hasCoverage()
public ModuleMetadata.ModuleMetadataCoverageComponent addCoverage()
coverage (Specifies various attributes of the patient population for whom and/or environment of care in which, the knowledge module is applicable.)public ModuleMetadata addCoverage(ModuleMetadata.ModuleMetadataCoverageComponent t)
public List<CodeableConcept> getTopic()
topic (Clinical topics related to the content of the module.)public boolean hasTopic()
public CodeableConcept addTopic()
topic (Clinical topics related to the content of the module.)public ModuleMetadata addTopic(CodeableConcept t)
public List<ModuleMetadata.ModuleMetadataContributorComponent> getContributor()
contributor (A contributor to the content of the module, including authors, editors, reviewers, and endorsers.)public boolean hasContributor()
public ModuleMetadata.ModuleMetadataContributorComponent addContributor()
contributor (A contributor to the content of the module, including authors, editors, reviewers, and endorsers.)public ModuleMetadata addContributor(ModuleMetadata.ModuleMetadataContributorComponent t)
public StringType getPublisherElement()
publisher (The name of the individual or organization that published the module (also known as the steward for the module). This information is required for non-experimental published artifacts.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the valuepublic boolean hasPublisherElement()
public boolean hasPublisher()
public ModuleMetadata setPublisherElement(StringType value)
value - publisher (The name of the individual or organization that published the module (also known as the steward for the module). This information is required for non-experimental published artifacts.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the valuepublic String getPublisher()
public ModuleMetadata setPublisher(String value)
value - The name of the individual or organization that published the module (also known as the steward for the module). This information is required for non-experimental published artifacts.public List<ModuleMetadata.ModuleMetadataContactComponent> getContact()
contact (Contacts to assist a user in finding and communicating with the publisher.)public boolean hasContact()
public ModuleMetadata.ModuleMetadataContactComponent addContact()
contact (Contacts to assist a user in finding and communicating with the publisher.)public ModuleMetadata addContact(ModuleMetadata.ModuleMetadataContactComponent t)
public StringType getCopyrightElement()
copyright (A copyright statement relating to the module and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the module.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the valuepublic boolean hasCopyrightElement()
public boolean hasCopyright()
public ModuleMetadata setCopyrightElement(StringType value)
value - copyright (A copyright statement relating to the module and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the module.). This is the underlying object with id, value and extensions. The accessor "getCopyright" gives direct access to the valuepublic String getCopyright()
public ModuleMetadata setCopyright(String value)
value - A copyright statement relating to the module and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the module.public List<ModuleMetadata.ModuleMetadataRelatedResourceComponent> getRelatedResource()
relatedResource (Related resources such as additional documentation, justification, or bibliographic references.)public boolean hasRelatedResource()
public ModuleMetadata.ModuleMetadataRelatedResourceComponent addRelatedResource()
relatedResource (Related resources such as additional documentation, justification, or bibliographic references.)public ModuleMetadata addRelatedResource(ModuleMetadata.ModuleMetadataRelatedResourceComponent t)
protected void listChildren(List<Property> childrenList)
listChildren in class Elementpublic Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
getProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
makeProperty in class Elementorg.hl7.fhir.exceptions.FHIRExceptionpublic ModuleMetadata copy()
protected ModuleMetadata typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class Elementpublic boolean equalsShallow(Base other)
equalsShallow in class ElementCopyright © 2014–2018 University Health Network. All rights reserved.