Class Identifier

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 Identifier
extends Type
implements org.hl7.fhir.instance.model.api.ICompositeType
A technical identifier - identifies some entity uniquely and unambiguously.
See Also:
Serialized Form
  • Field Details

    • use

      The purpose of this identifier.
    • type

      protected CodeableConcept type
      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
    • system

      protected UriType system
      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
    • value

      protected StringType value
      The portion of the identifier typically relevant to the user and which is unique within the context of the system.
    • period

      protected Period period
      Time period during which identifier is/was valid for use.
    • assigner

      protected Reference assigner
      Organization that issued/manages the identifier.
    • assignerTarget

      The actual object that is the target of the reference (Organization that issued/manages the identifier.)
  • Constructor Details

  • Method Details

    • getUseElement

      Returns:
      use (The purpose of this identifier.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
    • hasUseElement

      public boolean hasUseElement()
    • hasUse

      public boolean hasUse()
    • setUseElement

      Parameters:
      value - use (The purpose of this identifier.). This is the underlying object with id, value and extensions. The accessor "getUse" gives direct access to the value
    • getUse

      Returns:
      The purpose of this identifier.
    • setUse

      Parameters:
      value - The purpose of this identifier.
    • getType

      Returns:
      type (A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.)
    • hasType

      public boolean hasType()
    • setType

      public Identifier setType​(CodeableConcept value)
      Parameters:
      value - type (A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.)
    • getSystemElement

      Returns:
      system (Establishes the namespace for the value - that is, a URL that describes a set values that are unique.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
    • hasSystemElement

      public boolean hasSystemElement()
    • hasSystem

      public boolean hasSystem()
    • setSystemElement

      public Identifier setSystemElement​(UriType value)
      Parameters:
      value - system (Establishes the namespace for the value - that is, a URL that describes a set values that are unique.). This is the underlying object with id, value and extensions. The accessor "getSystem" gives direct access to the value
    • getSystem

      public String getSystem()
      Returns:
      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
    • setSystem

      public Identifier setSystem​(String value)
      Parameters:
      value - Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
    • getValueElement

      Returns:
      value (The portion of the identifier typically relevant to the user and which is unique within the context of the system.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
    • hasValueElement

      public boolean hasValueElement()
    • hasValue

      public boolean hasValue()
    • setValueElement

      Parameters:
      value - value (The portion of the identifier typically relevant to the user and which is unique within the context of the system.). This is the underlying object with id, value and extensions. The accessor "getValue" gives direct access to the value
    • getValue

      public String getValue()
      Returns:
      The portion of the identifier typically relevant to the user and which is unique within the context of the system.
    • setValue

      public Identifier setValue​(String value)
      Parameters:
      value - The portion of the identifier typically relevant to the user and which is unique within the context of the system.
    • getPeriod

      public Period getPeriod()
      Returns:
      period (Time period during which identifier is/was valid for use.)
    • hasPeriod

      public boolean hasPeriod()
    • setPeriod

      public Identifier setPeriod​(Period value)
      Parameters:
      value - period (Time period during which identifier is/was valid for use.)
    • getAssigner

      Returns:
      assigner (Organization that issued/manages the identifier.)
    • hasAssigner

      public boolean hasAssigner()
    • setAssigner

      public Identifier setAssigner​(Reference value)
      Parameters:
      value - assigner (Organization that issued/manages the identifier.)
    • getAssignerTarget

      Returns:
      assigner The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Organization that issued/manages the identifier.)
    • setAssignerTarget

      Parameters:
      value - assigner The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Organization that issued/manages the identifier.)
    • listChildren

      protected void listChildren​(List<Property> children)
      Overrides:
      listChildren in class Element
    • getNamedProperty

      public Property getNamedProperty​(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • 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 Base 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 Base 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
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException
    • getTypesForProperty

      public String[] getTypesForProperty​(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty in class Element
      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
    • copy

      public Identifier copy()
      Overrides:
      copy in class Type
    • typedCopy

      protected Identifier typedCopy()
      Specified by:
      typedCopy in class Type
    • equalsDeep

      public boolean equalsDeep​(Base other_)
      Overrides:
      equalsDeep in class Element
    • equalsShallow

      public boolean equalsShallow​(Base other_)
      Overrides:
      equalsShallow in class Element
    • isEmpty

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