Package org.hl7.fhir.dstu2016may.model

Class ModuleMetadata

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType
    public class ModuleMetadata
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType
    The ModuleMetadata structure defines the common metadata elements used by quality improvement artifacts. This information includes descriptive and topical metadata to enable repository searches, as well as governance and evidentiary support information.
    See Also:
    Serialized Form

    • Field Detail

      • url

        protected UriType 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.

      • identifier

        protected List<Identifier> identifier
        A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.

      • version

        protected StringType 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.

      • name

        protected StringType 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.

      • title

        protected StringType title
        A short, descriptive, user-friendly title for the module.

      • experimental

        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.

      • description

        protected StringType description
        A free text natural language description of the module from the consumer's perspective.

      • purpose

        protected StringType purpose
        A brief description of the purpose of the module.

      • usage

        protected StringType usage
        A detailed description of how the module is used from a clinical perspective.

      • effectivePeriod

        protected Period effectivePeriod
        The period during which the module content is effective.

      • publisher

        protected StringType 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.

      • copyright

        protected StringType 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.

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        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 value

      • hasUrl

        public boolean hasUrl()

      • setUrlElement

        public ModuleMetadata setUrlElement​(UriType value)
        Parameters:
        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 value

      • getUrl

        public String getUrl()
        Returns:
        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.

      • setUrl

        public ModuleMetadata setUrl​(String value)
        Parameters:
        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.

      • addIdentifier

        public Identifier addIdentifier()
        Returns:
        identifier (A logical identifier for the module such as the CMS or NQF identifiers for a measure artifact.)

      • getVersionElement

        public StringType getVersionElement()
        Returns:
        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 value

      • setVersionElement

        public ModuleMetadata setVersionElement​(StringType value)
        Parameters:
        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 value

      • getVersion

        public String getVersion()
        Returns:
        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.

      • setVersion

        public ModuleMetadata setVersion​(String value)
        Parameters:
        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.

      • getNameElement

        public StringType getNameElement()
        Returns:
        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 value

      • hasName

        public boolean hasName()

      • setNameElement

        public ModuleMetadata setNameElement​(StringType value)
        Parameters:
        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 value

      • getName

        public String getName()
        Returns:
        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.

      • setName

        public ModuleMetadata setName​(String value)
        Parameters:
        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.

      • getTitleElement

        public StringType getTitleElement()
        Returns:
        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 value

      • setTitleElement

        public ModuleMetadata setTitleElement​(StringType value)
        Parameters:
        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 value

      • getTitle

        public String getTitle()
        Returns:
        A short, descriptive, user-friendly title for the module.

      • getTypeElement

        public Enumeration<ModuleMetadata.ModuleMetadataType> getTypeElement()
        Returns:
        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 value

      • hasType

        public boolean hasType()

      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        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 value

      • setExperimentalElement

        public ModuleMetadata setExperimentalElement​(BooleanType value)
        Parameters:
        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 value

      • getExperimental

        public boolean getExperimental()
        Returns:
        Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.

      • setExperimental

        public ModuleMetadata setExperimental​(boolean value)
        Parameters:
        value - Determines whether the module was developed for testing purposes (or education/evaluation/marketing), and is not intended to be used in production environments.

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        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 value

      • setDescriptionElement

        public ModuleMetadata setDescriptionElement​(StringType value)
        Parameters:
        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 value

      • getDescription

        public String getDescription()
        Returns:
        A free text natural language description of the module from the consumer's perspective.

      • setDescription

        public ModuleMetadata setDescription​(String value)
        Parameters:
        value - A free text natural language description of the module from the consumer's perspective.

      • getPurposeElement

        public StringType getPurposeElement()
        Returns:
        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 value

      • setPurposeElement

        public ModuleMetadata setPurposeElement​(StringType value)
        Parameters:
        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 value

      • getPurpose

        public String getPurpose()
        Returns:
        A brief description of the purpose of the module.

      • getUsageElement

        public StringType getUsageElement()
        Returns:
        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 value

      • setUsageElement

        public ModuleMetadata setUsageElement​(StringType value)
        Parameters:
        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 value

      • getUsage

        public String getUsage()
        Returns:
        A detailed description of how the module is used from a clinical perspective.

      • setUsage

        public ModuleMetadata setUsage​(String value)
        Parameters:
        value - A detailed description of how the module is used from a clinical perspective.

      • getPublicationDateElement

        public DateType getPublicationDateElement()
        Returns:
        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 value

      • getLastReviewDateElement

        public DateType getLastReviewDateElement()
        Returns:
        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 value

      • setLastReviewDateElement

        public ModuleMetadata setLastReviewDateElement​(DateType value)
        Parameters:
        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 value

      • getLastReviewDate

        public Date getLastReviewDate()
        Returns:
        The date on which the module content was last reviewed.

      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        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 value

      • setPublisherElement

        public ModuleMetadata setPublisherElement​(StringType value)
        Parameters:
        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 value

      • getPublisher

        public String getPublisher()
        Returns:
        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.

      • setPublisher

        public ModuleMetadata setPublisher​(String value)
        Parameters:
        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.

      • getCopyrightElement

        public StringType getCopyrightElement()
        Returns:
        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 value

      • setCopyrightElement

        public ModuleMetadata setCopyrightElement​(StringType value)
        Parameters:
        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 value

      • getCopyright

        public String getCopyright()
        Returns:
        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.

      • setCopyright

        public ModuleMetadata setCopyright​(String value)
        Parameters:
        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.

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class Element
        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 Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setProperty

        public void setProperty​(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        setProperty in class Element
        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 Element
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • addChild

        public Base addChild​(String name)
              throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        addChild in class Element
        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 Element

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class Element