Package org.hl7.fhir.dstu2.model

Class SearchParameter

java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.SearchParameter
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 SearchParameter extends DomainResource
A search parameter that defines a named search item that can be used to search/filter on a resource.
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • getUrlElement

      public UriType getUrlElement()
      Returns:
      url (An absolute URL that is used to identify this search parameter 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 search parameter is (or will be) published.). This is the underlying object with id, value and extensions. The accessor "getUrl" gives direct access to the value

    • hasUrlElement

      public boolean hasUrlElement()

    • hasUrl

      public boolean hasUrl()

    • setUrlElement

      public SearchParameter setUrlElement(UriType value)
      Parameters:
      value - url (An absolute URL that is used to identify this search parameter 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 search parameter 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 search parameter 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 search parameter is (or will be) published.

    • setUrl

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

    • getNameElement

      public StringType getNameElement()
      Returns:
      name (A free text natural language name identifying the search parameter.). This is the underlying object with id, value and extensions. The accessor "getName" gives direct access to the value

    • hasNameElement

      public boolean hasNameElement()

    • hasName

      public boolean hasName()

    • setNameElement

      public SearchParameter setNameElement(StringType value)
      Parameters:
      value - name (A free text natural language name identifying the search parameter.). 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 identifying the search parameter.

    • setName

      public SearchParameter setName(String value)
      Parameters:
      value - A free text natural language name identifying the search parameter.

    • getStatusElement

      public Enumeration<Enumerations.ConformanceResourceStatus> getStatusElement()
      Returns:
      status (The status of this search parameter definition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • hasStatusElement

      public boolean hasStatusElement()

    • hasStatus

      public boolean hasStatus()

    • setStatusElement

      public SearchParameter setStatusElement(Enumeration<Enumerations.ConformanceResourceStatus> value)
      Parameters:
      value - status (The status of this search parameter definition.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

    • getStatus

      public Enumerations.ConformanceResourceStatus getStatus()
      Returns:
      The status of this search parameter definition.

    • setStatus

      public SearchParameter setStatus(Enumerations.ConformanceResourceStatus value)
      Parameters:
      value - The status of this search parameter definition.

    • getExperimentalElement

      public BooleanType getExperimentalElement()
      Returns:
      experimental (A flag to indicate that this search parameter definition 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()

    • hasExperimental

      public boolean hasExperimental()

    • setExperimentalElement

      public SearchParameter setExperimentalElement(BooleanType value)
      Parameters:
      value - experimental (A flag to indicate that this search parameter definition 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()
      Returns:
      A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • setExperimental

      public SearchParameter setExperimental(boolean value)
      Parameters:
      value - A flag to indicate that this search parameter definition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • getPublisherElement

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

    • hasPublisherElement

      public boolean hasPublisherElement()

    • hasPublisher

      public boolean hasPublisher()

    • setPublisherElement

      public SearchParameter setPublisherElement(StringType value)
      Parameters:
      value - publisher (The name of the individual or organization that published the search parameter.). 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 search parameter.

    • setPublisher

      public SearchParameter setPublisher(String value)
      Parameters:
      value - The name of the individual or organization that published the search parameter.

    • getContact

      public List<SearchParameter.SearchParameterContactComponent> getContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • hasContact

      public boolean hasContact()

    • addContact

      public SearchParameter.SearchParameterContactComponent addContact()
      Returns:
      contact (Contacts to assist a user in finding and communicating with the publisher.)

    • addContact

      public SearchParameter addContact(SearchParameter.SearchParameterContactComponent t)

    • getDateElement

      public DateTimeType getDateElement()
      Returns:
      date (The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value

    • hasDateElement

      public boolean hasDateElement()

    • hasDate

      public boolean hasDate()

    • setDateElement

      public SearchParameter setDateElement(DateTimeType value)
      Parameters:
      value - date (The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter 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 (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

    • setDate

      public SearchParameter setDate(Date value)
      Parameters:
      value - The date (and optionally time) when the search parameter definition was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the search parameter changes.

    • getRequirementsElement

      public StringType getRequirementsElement()
      Returns:
      requirements (The Scope and Usage that this search parameter was created to meet.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

    • hasRequirementsElement

      public boolean hasRequirementsElement()

    • hasRequirements

      public boolean hasRequirements()

    • setRequirementsElement

      public SearchParameter setRequirementsElement(StringType value)
      Parameters:
      value - requirements (The Scope and Usage that this search parameter was created to meet.). This is the underlying object with id, value and extensions. The accessor "getRequirements" gives direct access to the value

    • getRequirements

      public String getRequirements()
      Returns:
      The Scope and Usage that this search parameter was created to meet.

    • setRequirements

      public SearchParameter setRequirements(String value)
      Parameters:
      value - The Scope and Usage that this search parameter was created to meet.

    • getCodeElement

      public CodeType getCodeElement()
      Returns:
      code (The code used in the URL or the parameter name in a parameters resource for this search parameter.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

    • hasCodeElement

      public boolean hasCodeElement()

    • hasCode

      public boolean hasCode()

    • setCodeElement

      public SearchParameter setCodeElement(CodeType value)
      Parameters:
      value - code (The code used in the URL or the parameter name in a parameters resource for this search parameter.). This is the underlying object with id, value and extensions. The accessor "getCode" gives direct access to the value

    • getCode

      public String getCode()
      Returns:
      The code used in the URL or the parameter name in a parameters resource for this search parameter.

    • setCode

      public SearchParameter setCode(String value)
      Parameters:
      value - The code used in the URL or the parameter name in a parameters resource for this search parameter.

    • getBaseElement

      public CodeType getBaseElement()
      Returns:
      base (The base resource type that this search parameter refers to.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value

    • hasBaseElement

      public boolean hasBaseElement()

    • hasBase

      public boolean hasBase()

    • setBaseElement

      public SearchParameter setBaseElement(CodeType value)
      Parameters:
      value - base (The base resource type that this search parameter refers to.). This is the underlying object with id, value and extensions. The accessor "getBase" gives direct access to the value

    • getBase

      public String getBase()
      Returns:
      The base resource type that this search parameter refers to.

    • setBase

      public SearchParameter setBase(String value)
      Parameters:
      value - The base resource type that this search parameter refers to.

    • getTypeElement

      public Enumeration<Enumerations.SearchParamType> getTypeElement()
      Returns:
      type (The type of value a search parameter refers to, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

    • hasTypeElement

      public boolean hasTypeElement()

    • hasType

      public boolean hasType()

    • setTypeElement

      public SearchParameter setTypeElement(Enumeration<Enumerations.SearchParamType> value)
      Parameters:
      value - type (The type of value a search parameter refers to, and how the content is interpreted.). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

    • getType

      public Enumerations.SearchParamType getType()
      Returns:
      The type of value a search parameter refers to, and how the content is interpreted.

    • setType

      public SearchParameter setType(Enumerations.SearchParamType value)
      Parameters:
      value - The type of value a search parameter refers to, and how the content is interpreted.

    • getDescriptionElement

      public StringType getDescriptionElement()
      Returns:
      description (A description of the search parameters and how it used.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

    • hasDescriptionElement

      public boolean hasDescriptionElement()

    • hasDescription

      public boolean hasDescription()

    • setDescriptionElement

      public SearchParameter setDescriptionElement(StringType value)
      Parameters:
      value - description (A description of the search parameters and how it used.). 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 description of the search parameters and how it used.

    • setDescription

      public SearchParameter setDescription(String value)
      Parameters:
      value - A description of the search parameters and how it used.

    • getXpathElement

      public StringType getXpathElement()
      Returns:
      xpath (An XPath expression that returns a set of elements for the search parameter.). This is the underlying object with id, value and extensions. The accessor "getXpath" gives direct access to the value

    • hasXpathElement

      public boolean hasXpathElement()

    • hasXpath

      public boolean hasXpath()

    • setXpathElement

      public SearchParameter setXpathElement(StringType value)
      Parameters:
      value - xpath (An XPath expression that returns a set of elements for the search parameter.). This is the underlying object with id, value and extensions. The accessor "getXpath" gives direct access to the value

    • getXpath

      public String getXpath()
      Returns:
      An XPath expression that returns a set of elements for the search parameter.

    • setXpath

      public SearchParameter setXpath(String value)
      Parameters:
      value - An XPath expression that returns a set of elements for the search parameter.

    • getXpathUsageElement

      public Enumeration<SearchParameter.XPathUsageType> getXpathUsageElement()
      Returns:
      xpathUsage (How the search parameter relates to the set of elements returned by evaluating the xpath query.). This is the underlying object with id, value and extensions. The accessor "getXpathUsage" gives direct access to the value

    • hasXpathUsageElement

      public boolean hasXpathUsageElement()

    • hasXpathUsage

      public boolean hasXpathUsage()

    • setXpathUsageElement

      public SearchParameter setXpathUsageElement(Enumeration<SearchParameter.XPathUsageType> value)
      Parameters:
      value - xpathUsage (How the search parameter relates to the set of elements returned by evaluating the xpath query.). This is the underlying object with id, value and extensions. The accessor "getXpathUsage" gives direct access to the value

    • getXpathUsage

      public SearchParameter.XPathUsageType getXpathUsage()
      Returns:
      How the search parameter relates to the set of elements returned by evaluating the xpath query.

    • setXpathUsage

      public SearchParameter setXpathUsage(SearchParameter.XPathUsageType value)
      Parameters:
      value - How the search parameter relates to the set of elements returned by evaluating the xpath query.

    • getTarget

      public List<CodeType> getTarget()
      Returns:
      target (Types of resource (if a resource is referenced).)

    • hasTarget

      public boolean hasTarget()

    • addTargetElement

      public CodeType addTargetElement()
      Returns:
      target (Types of resource (if a resource is referenced).)

    • addTarget

      public SearchParameter addTarget(String value)
      Parameters:
      value - target (Types of resource (if a resource is referenced).)

    • hasTarget

      public boolean hasTarget(String value)
      Parameters:
      value - target (Types of resource (if a resource is referenced).)

    • listChildren

      protected void listChildren(List<Property> childrenList)
      Overrides:
      listChildren in class DomainResource

    • setProperty

      public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • addChild

      public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      addChild in class DomainResource
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • fhirType

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

    • copy

      public SearchParameter copy()
      Specified by:
      copy in class DomainResource

    • typedCopy

      protected SearchParameter typedCopy()

    • equalsDeep

      public boolean equalsDeep(Base other)
      Overrides:
      equalsDeep in class DomainResource

    • equalsShallow

      public boolean equalsShallow(Base other)
      Overrides:
      equalsShallow in class DomainResource

    • isEmpty

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

    • getResourceType

      public ResourceType getResourceType()
      Specified by:
      getResourceType in class Resource