Class IdentifierDt

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.IQueryParameterType, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

    public class IdentifierDt
    extends ca.uhn.fhir.model.base.composite.BaseIdentifierDt
    implements ca.uhn.fhir.model.api.ICompositeDatatype
    HAPI/FHIR IdentifierDt Datatype ()

    Definition: A technical identifier - identifies some entity uniquely and unambiguously

    Requirements: Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation

    See Also:
    Serialized Form
    • Constructor Detail

      • IdentifierDt

        public IdentifierDt​(String theSystem,
                            String theValue)
        Creates a new identifier with the given system and value
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getUseElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<IdentifierUseEnumgetUseElement()
        Gets the value(s) for use (). creating it if it does not exist. Will not return null.

        Definition: The purpose of this identifier

      • getUse

        public String getUse()
        Gets the value(s) for use (). creating it if it does not exist. This method may return null.

        Definition: The purpose of this identifier

      • setUse

        public IdentifierDt setUse​(ca.uhn.fhir.model.primitive.BoundCodeDt<IdentifierUseEnum> theValue)
        Sets the value(s) for use ()

        Definition: The purpose of this identifier

      • getType

        public BoundCodeableConceptDt<IdentifierTypeCodesEnumgetType()
        Gets the value(s) for type (). creating it if it does not exist. Will not return null.

        Definition: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose

      • setType

        public IdentifierDt setType​(IdentifierTypeCodesEnum theValue)
        Sets the value(s) for type ()

        Definition: A coded type for the identifier that can be used to determine which identifier to use for a specific purpose

      • getSystemElement

        public ca.uhn.fhir.model.primitive.UriDt getSystemElement()
        Gets the value(s) for system (). creating it if it does not exist. Will not return null.

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

        Specified by:
        getSystemElement in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt
      • getSystem

        public String getSystem()
        Gets the value(s) for system (). creating it if it does not exist. This method may return null.

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

      • setSystem

        public IdentifierDt setSystem​(ca.uhn.fhir.model.primitive.UriDt theValue)
        Sets the value(s) for system ()

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

      • setSystem

        public IdentifierDt setSystem​(String theUri)
        Sets the value for system ()

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

        Specified by:
        setSystem in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt
      • getValueElement

        public ca.uhn.fhir.model.primitive.StringDt getValueElement()
        Gets the value(s) for value (). 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.

        Specified by:
        getValueElement in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt
      • getValue

        public String getValue()
        Gets the value(s) for value (). creating it if it does not exist. This method may return null.

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

      • setValue

        public IdentifierDt setValue​(ca.uhn.fhir.model.primitive.StringDt theValue)
        Sets the value(s) for value ()

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

      • setValue

        public IdentifierDt setValue​(String theString)
        Sets the value for value ()

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

        Specified by:
        setValue in class ca.uhn.fhir.model.base.composite.BaseIdentifierDt
      • getPeriod

        public PeriodDt getPeriod()
        Gets the value(s) for period (). creating it if it does not exist. Will not return null.

        Definition: Time period during which identifier is/was valid for use

      • setPeriod

        public IdentifierDt setPeriod​(PeriodDt theValue)
        Sets the value(s) for period ()

        Definition: Time period during which identifier is/was valid for use

      • getAssigner

        public ResourceReferenceDt getAssigner()
        Gets the value(s) for assigner (). creating it if it does not exist. Will not return null.

        Definition: Organization that issued/manages the identifier