Package org.hl7.fhir.dstu2016may.model

Class ExpansionProfile

  • 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 ExpansionProfile
extends DomainResource
    Resource to define constraints on the Expansion of a FHIR ValueSet.
    See Also:
    Serialized Form

    • Field Detail

      • url

        protected UriType url
        An absolute URL that is used to identify this expansion profile 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 expansion profile is (or will be) published.

      • identifier

        protected Identifier identifier
        Formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.

      • version

        protected StringType version
        Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance.

      • name

        protected StringType name
        A free text natural language name for the expansion profile.

      • experimental

        protected BooleanType experimental
        This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usage.

      • publisher

        protected StringType publisher
        The name of the individual or organization that published the expansion profile.

      • date

        protected DateTimeType date
        The date that the expansion profile status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes.

      • description

        protected StringType description
        A free text natural language description of the use of the expansion profile - reason for definition, conditions of use, etc. The description may include a list of expected usages for the expansion profile and can also describe the approach taken to build the expansion profile.

      • includeDesignations

        protected BooleanType includeDesignations
        Controls whether concept designations are to be included or excluded in value set expansions.

      • includeDefinition

        protected BooleanType includeDefinition
        Controls whether the value set definition is included or excluded in value set expansions.

      • includeInactive

        protected BooleanType includeInactive
        Controls whether inactive concepts are included or excluded in value set expansions.

      • excludeNested

        protected BooleanType excludeNested
        Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains).

      • excludeNotForUI

        protected BooleanType excludeNotForUI
        Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.

      • displayLanguage

        protected CodeType displayLanguage
        Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.

      • limitedExpansion

        protected BooleanType limitedExpansion
        If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete.

      • SP_STATUS

        public static final String SP_STATUS
        Search parameter: status

        Description: The status of the expansion profile
        Type: token
        Path: ExpansionProfile.status

        See Also:
        Constant Field Values

      • STATUS

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
        Fluent Client search parameter constant for status

        Description: The status of the expansion profile
        Type: token
        Path: ExpansionProfile.status

      • SP_DESCRIPTION

        public static final String SP_DESCRIPTION
        Search parameter: description

        Description: Text search in the description of the expansion profile
        Type: string
        Path: ExpansionProfile.description

        See Also:
        Constant Field Values

      • DESCRIPTION

        public static final ca.uhn.fhir.rest.gclient.StringClientParam DESCRIPTION
        Fluent Client search parameter constant for description

        Description: Text search in the description of the expansion profile
        Type: string
        Path: ExpansionProfile.description

      • SP_NAME

        public static final String SP_NAME
        Search parameter: name

        Description: The name of the expansion profile
        Type: string
        Path: ExpansionProfile.name

        See Also:
        Constant Field Values

      • NAME

        public static final ca.uhn.fhir.rest.gclient.StringClientParam NAME
        Fluent Client search parameter constant for name

        Description: The name of the expansion profile
        Type: string
        Path: ExpansionProfile.name

      • SP_DATE

        public static final String SP_DATE
        Search parameter: date

        Description: The expansion profile publication date
        Type: date
        Path: ExpansionProfile.date

        See Also:
        Constant Field Values

      • DATE

        public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
        Fluent Client search parameter constant for date

        Description: The expansion profile publication date
        Type: date
        Path: ExpansionProfile.date

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter: identifier

        Description: The identifier for the expansion profile
        Type: token
        Path: ExpansionProfile.identifier

        See Also:
        Constant Field Values

      • IDENTIFIER

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
        Fluent Client search parameter constant for identifier

        Description: The identifier for the expansion profile
        Type: token
        Path: ExpansionProfile.identifier

      • SP_URL

        public static final String SP_URL
        Search parameter: url

        Description: The logical URL for the expansion profile
        Type: uri
        Path: ExpansionProfile.url

        See Also:
        Constant Field Values

      • URL

        public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
        Fluent Client search parameter constant for url

        Description: The logical URL for the expansion profile
        Type: uri
        Path: ExpansionProfile.url

      • SP_PUBLISHER

        public static final String SP_PUBLISHER
        Search parameter: publisher

        Description: Name of the publisher of the expansion profile
        Type: string
        Path: ExpansionProfile.publisher

        See Also:
        Constant Field Values

      • PUBLISHER

        public static final ca.uhn.fhir.rest.gclient.StringClientParam PUBLISHER
        Fluent Client search parameter constant for publisher

        Description: Name of the publisher of the expansion profile
        Type: string
        Path: ExpansionProfile.publisher

      • SP_VERSION

        public static final String SP_VERSION
        Search parameter: version

        Description: The version identifier of the expansion profile
        Type: token
        Path: ExpansionProfile.version

        See Also:
        Constant Field Values

      • VERSION

        public static final ca.uhn.fhir.rest.gclient.TokenClientParam VERSION
        Fluent Client search parameter constant for version

        Description: The version identifier of the expansion profile
        Type: token
        Path: ExpansionProfile.version

    • Method Detail

      • getUrlElement

        public UriType getUrlElement()
        Returns:
        url (An absolute URL that is used to identify this expansion profile 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 expansion profile 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 ExpansionProfile setUrlElement​(UriType value)
        Parameters:
        value - url (An absolute URL that is used to identify this expansion profile 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 expansion profile 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 expansion profile 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 expansion profile is (or will be) published.

      • setUrl

        public ExpansionProfile setUrl​(String value)
        Parameters:
        value - An absolute URL that is used to identify this expansion profile 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 expansion profile is (or will be) published.

      • getIdentifier

        public Identifier getIdentifier()
        Returns:
        identifier (Formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.)

      • setIdentifier

        public ExpansionProfile setIdentifier​(Identifier value)
        Parameters:
        value - identifier (Formal identifier that is used to identify this expansion profile when it is represented in other formats, or referenced in a specification, model, design or an instance.)

      • getVersionElement

        public StringType getVersionElement()
        Returns:
        version (Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • setVersionElement

        public ExpansionProfile setVersionElement​(StringType value)
        Parameters:
        value - version (Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value

      • getVersion

        public String getVersion()
        Returns:
        Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance.

      • setVersion

        public ExpansionProfile setVersion​(String value)
        Parameters:
        value - Used to identify this version of the expansion profile when it is referenced in a specification, model, design or instance.

      • getNameElement

        public StringType getNameElement()
        Returns:
        name (A free text natural language name for the expansion profile.). 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 ExpansionProfile setNameElement​(StringType value)
        Parameters:
        value - name (A free text natural language name for the expansion profile.). 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 free text natural language name for the expansion profile.

      • getExperimentalElement

        public BooleanType getExperimentalElement()
        Returns:
        experimental (This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

      • setExperimentalElement

        public ExpansionProfile setExperimentalElement​(BooleanType value)
        Parameters:
        value - experimental (This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usage.). This is the underlying object with id, value and extensions. The accessor "getExperimental" gives direct access to the value

      • getExperimental

        public boolean getExperimental()
        Returns:
        This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usage.

      • setExperimental

        public ExpansionProfile setExperimental​(boolean value)
        Parameters:
        value - This expansion profile was authored for testing purposes (or education/evaluation/marketing), and is not intended for genuine production usage.

      • getPublisherElement

        public StringType getPublisherElement()
        Returns:
        publisher (The name of the individual or organization that published the expansion profile.). This is the underlying object with id, value and extensions. The accessor "getPublisher" gives direct access to the value

      • setPublisherElement

        public ExpansionProfile setPublisherElement​(StringType value)
        Parameters:
        value - publisher (The name of the individual or organization that published the expansion profile.). 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 expansion profile.

      • setPublisher

        public ExpansionProfile setPublisher​(String value)
        Parameters:
        value - The name of the individual or organization that published the expansion profile.

      • getDateElement

        public DateTimeType getDateElement()
        Returns:
        date (The date that the expansion profile status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • hasDate

        public boolean hasDate()

      • setDateElement

        public ExpansionProfile setDateElement​(DateTimeType value)
        Parameters:
        value - date (The date that the expansion profile status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

      • getDate

        public Date getDate()
        Returns:
        The date that the expansion profile status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes.

      • setDate

        public ExpansionProfile setDate​(Date value)
        Parameters:
        value - The date that the expansion profile status was last changed. The date must change when the business version changes, if it does, and it must change if the status code changes.

      • getDescriptionElement

        public StringType getDescriptionElement()
        Returns:
        description (A free text natural language description of the use of the expansion profile - reason for definition, conditions of use, etc. The description may include a list of expected usages for the expansion profile and can also describe the approach taken to build the expansion profile.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

      • setDescriptionElement

        public ExpansionProfile setDescriptionElement​(StringType value)
        Parameters:
        value - description (A free text natural language description of the use of the expansion profile - reason for definition, conditions of use, etc. The description may include a list of expected usages for the expansion profile and can also describe the approach taken to build the expansion profile.). 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 use of the expansion profile - reason for definition, conditions of use, etc. The description may include a list of expected usages for the expansion profile and can also describe the approach taken to build the expansion profile.

      • setDescription

        public ExpansionProfile setDescription​(String value)
        Parameters:
        value - A free text natural language description of the use of the expansion profile - reason for definition, conditions of use, etc. The description may include a list of expected usages for the expansion profile and can also describe the approach taken to build the expansion profile.

      • getIncludeDesignationsElement

        public BooleanType getIncludeDesignationsElement()
        Returns:
        includeDesignations (Controls whether concept designations are to be included or excluded in value set expansions.). This is the underlying object with id, value and extensions. The accessor "getIncludeDesignations" gives direct access to the value

      • setIncludeDesignationsElement

        public ExpansionProfile setIncludeDesignationsElement​(BooleanType value)
        Parameters:
        value - includeDesignations (Controls whether concept designations are to be included or excluded in value set expansions.). This is the underlying object with id, value and extensions. The accessor "getIncludeDesignations" gives direct access to the value

      • getIncludeDesignations

        public boolean getIncludeDesignations()
        Returns:
        Controls whether concept designations are to be included or excluded in value set expansions.

      • setIncludeDesignations

        public ExpansionProfile setIncludeDesignations​(boolean value)
        Parameters:
        value - Controls whether concept designations are to be included or excluded in value set expansions.

      • getIncludeDefinitionElement

        public BooleanType getIncludeDefinitionElement()
        Returns:
        includeDefinition (Controls whether the value set definition is included or excluded in value set expansions.). This is the underlying object with id, value and extensions. The accessor "getIncludeDefinition" gives direct access to the value

      • setIncludeDefinitionElement

        public ExpansionProfile setIncludeDefinitionElement​(BooleanType value)
        Parameters:
        value - includeDefinition (Controls whether the value set definition is included or excluded in value set expansions.). This is the underlying object with id, value and extensions. The accessor "getIncludeDefinition" gives direct access to the value

      • getIncludeDefinition

        public boolean getIncludeDefinition()
        Returns:
        Controls whether the value set definition is included or excluded in value set expansions.

      • setIncludeDefinition

        public ExpansionProfile setIncludeDefinition​(boolean value)
        Parameters:
        value - Controls whether the value set definition is included or excluded in value set expansions.

      • getIncludeInactiveElement

        public BooleanType getIncludeInactiveElement()
        Returns:
        includeInactive (Controls whether inactive concepts are included or excluded in value set expansions.). This is the underlying object with id, value and extensions. The accessor "getIncludeInactive" gives direct access to the value

      • setIncludeInactiveElement

        public ExpansionProfile setIncludeInactiveElement​(BooleanType value)
        Parameters:
        value - includeInactive (Controls whether inactive concepts are included or excluded in value set expansions.). This is the underlying object with id, value and extensions. The accessor "getIncludeInactive" gives direct access to the value

      • getIncludeInactive

        public boolean getIncludeInactive()
        Returns:
        Controls whether inactive concepts are included or excluded in value set expansions.

      • setIncludeInactive

        public ExpansionProfile setIncludeInactive​(boolean value)
        Parameters:
        value - Controls whether inactive concepts are included or excluded in value set expansions.

      • getExcludeNestedElement

        public BooleanType getExcludeNestedElement()
        Returns:
        excludeNested (Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains).). This is the underlying object with id, value and extensions. The accessor "getExcludeNested" gives direct access to the value

      • setExcludeNestedElement

        public ExpansionProfile setExcludeNestedElement​(BooleanType value)
        Parameters:
        value - excludeNested (Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains).). This is the underlying object with id, value and extensions. The accessor "getExcludeNested" gives direct access to the value

      • getExcludeNested

        public boolean getExcludeNested()
        Returns:
        Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains).

      • setExcludeNested

        public ExpansionProfile setExcludeNested​(boolean value)
        Parameters:
        value - Controls whether or not the value set expansion includes nested codes (i.e. ValueSet.expansion.contains.contains).

      • getExcludeNotForUIElement

        public BooleanType getExcludeNotForUIElement()
        Returns:
        excludeNotForUI (Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.). This is the underlying object with id, value and extensions. The accessor "getExcludeNotForUI" gives direct access to the value

      • setExcludeNotForUIElement

        public ExpansionProfile setExcludeNotForUIElement​(BooleanType value)
        Parameters:
        value - excludeNotForUI (Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.). This is the underlying object with id, value and extensions. The accessor "getExcludeNotForUI" gives direct access to the value

      • getExcludeNotForUI

        public boolean getExcludeNotForUI()
        Returns:
        Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.

      • setExcludeNotForUI

        public ExpansionProfile setExcludeNotForUI​(boolean value)
        Parameters:
        value - Controls whether or not the value set expansion includes codes which cannot be displayed in user interfaces.

      • getExcludePostCoordinatedElement

        public BooleanType getExcludePostCoordinatedElement()
        Returns:
        excludePostCoordinated (Controls whether or not the value set expansion includes post coordinated codes.). This is the underlying object with id, value and extensions. The accessor "getExcludePostCoordinated" gives direct access to the value

      • getExcludePostCoordinated

        public boolean getExcludePostCoordinated()
        Returns:
        Controls whether or not the value set expansion includes post coordinated codes.

      • getDisplayLanguageElement

        public CodeType getDisplayLanguageElement()
        Returns:
        displayLanguage (Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.). This is the underlying object with id, value and extensions. The accessor "getDisplayLanguage" gives direct access to the value

      • setDisplayLanguageElement

        public ExpansionProfile setDisplayLanguageElement​(CodeType value)
        Parameters:
        value - displayLanguage (Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.). This is the underlying object with id, value and extensions. The accessor "getDisplayLanguage" gives direct access to the value

      • getDisplayLanguage

        public String getDisplayLanguage()
        Returns:
        Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.

      • setDisplayLanguage

        public ExpansionProfile setDisplayLanguage​(String value)
        Parameters:
        value - Specifies the language to be used for description in the expansions i.e. the language to be used for ValueSet.expansion.contains.display.

      • getLimitedExpansionElement

        public BooleanType getLimitedExpansionElement()
        Returns:
        limitedExpansion (If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete.). This is the underlying object with id, value and extensions. The accessor "getLimitedExpansion" gives direct access to the value

      • setLimitedExpansionElement

        public ExpansionProfile setLimitedExpansionElement​(BooleanType value)
        Parameters:
        value - limitedExpansion (If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete.). This is the underlying object with id, value and extensions. The accessor "getLimitedExpansion" gives direct access to the value

      • getLimitedExpansion

        public boolean getLimitedExpansion()
        Returns:
        If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete.

      • setLimitedExpansion

        public ExpansionProfile setLimitedExpansion​(boolean value)
        Parameters:
        value - If the value set being expanded is incomplete (because it is too big to expand), return a limited expansion (a subset) with an indicator that expansion is incomplete.

      • getProperty

        public Base[] getProperty​(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class DomainResource
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • makeProperty

        public Base makeProperty​(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException
        Description copied from class: Base
        make an instance of a property. If the property is a repeating property, make a new instance. if the property is not repeating, return the property
        Overrides:
        makeProperty in class DomainResource
        Returns:
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • isEmpty

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