Package ca.uhn.fhir.model.base.composite

Class BaseIdentifierDt

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.base.composite.BaseIdentifierDt
All Implemented Interfaces:
ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, IQueryParameterType, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, ICompositeType
public abstract class BaseIdentifierDt extends BaseIdentifiableElement implements ICompositeDatatype, IQueryParameterType
See Also:

  • Constructor Details

  • Method Details

    • getQueryParameterQualifier

      public String getQueryParameterQualifier()
      Description copied from interface: IQueryParameterType
      This method will return any qualifier that should be appended to the parameter name (e.g ":exact"). Returns null if none are present.
      Specified by:
      getQueryParameterQualifier in interface IQueryParameterType

    • getSystemElement

      public abstract UriDt getSystemElement()
      Gets the value(s) for system (The namespace for the identifier). creating it if it does not exist. Will not return null.

      Definition: Establishes the namespace in which set of possible id values is unique.

    • getValueElement

      public abstract StringDt getValueElement()
      Gets the value(s) for value (The value that is unique). creating it if it does not exist. Will not return null.

      Definition: The portion of the identifier typically displayed to the user and which is unique within the context of the system.

    • getValueAsQueryToken

      public String getValueAsQueryToken(FhirContext theContext)
      Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

      See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

      Specified by:
      getValueAsQueryToken in interface IQueryParameterType
      Parameters:
      theContext - TODO
      Returns:
      Returns a representation of this parameter's value as it will be represented "over the wire". In other words, how it will be presented in a URL (although not URL escaped)

    • matchesSystemAndValue

      public boolean matchesSystemAndValue(BaseIdentifierDt theIdentifier)
      Returns true if this identifier has the same value and system (as compared by simple equals comparison). Does not compare other values (e.g. getUse()) or any extensions.

    • setSystem

      public abstract BaseIdentifierDt setSystem(String theUri)
      Sets the value for system (The namespace for the identifier)

      Definition: Establishes the namespace in which set of possible id values is unique.

    • setValue

      public abstract BaseIdentifierDt setValue(String theString)
      Sets the value for value (The value that is unique)

      Definition: The portion of the identifier typically displayed to the user and which is unique within the context of the system.

    • setValueAsQueryToken

      public void setValueAsQueryToken(FhirContext theContext, String theParamName, String theQualifier, String theParameter)
      This method is generally only called by HAPI itself, and should not need to be called from user code.

      See FHIR specification 2.2.2 Search SearchParameter Types for information on the token format

      Specified by:
      setValueAsQueryToken in interface IQueryParameterType
      Parameters:
      theContext - TODO
      theParamName - TODO
      theQualifier - The parameter name qualifier that accompanied this value. For example, if the complete query was http://foo?name:exact=John, qualifier would be ":exact"
      theParameter - The actual parameter value. For example, if the complete query was http://foo?name:exact=John, the value would be "John"

    • getMissing

      @Deprecated public Boolean getMissing()
      Deprecated.
      get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality
      Not supported!
      Specified by:
      getMissing in interface IQueryParameterType

    • setMissing

      @Deprecated public IQueryParameterType setMissing(Boolean theMissing)
      Deprecated.
      get/setMissing is not supported in StringDt. Use StringParam instead if you need this functionality
      Not supported!
      Specified by:
      setMissing in interface IQueryParameterType
      Returns:
      Returns a reference to this for easier method chaining