Package org.hl7.fhir.r5.model

Class Identifier

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.Element

org.hl7.fhir.r5.model.DataType

org.hl7.fhir.r5.model.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 DataType
implements org.hl7.fhir.instance.model.api.ICompositeType

Identifier Type: An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Identifier.IdentifierUse
static class	Identifier.IdentifierUseEnumFactory

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected Reference	assigner	Organization that issued/manages the identifier.
protected Period	period	Time period during which identifier is/was valid for use.
protected UriType	system	Establishes the namespace for the value - that is, an absolute URL that describes a set values that are unique.
protected CodeableConcept	type	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
protected Enumeration<Identifier.IdentifierUse>	use	The purpose of this identifier.
protected StringType	value	The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Fields inherited from class org.hl7.fhir.r5.model.Element

extension, id

Constructor Summary

Constructors

Constructor	Description
Identifier()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
Identifier	copy()
void	copyValues(Identifier dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Reference	getAssigner()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Period	getPeriod()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getSystem()
UriType	getSystemElement()
CodeableConcept	getType()
String[]	getTypesForProperty(int hash, String name)
Identifier.IdentifierUse	getUse()
Enumeration<Identifier.IdentifierUse>	getUseElement()
String	getValue()
StringType	getValueElement()
boolean	hasAssigner()
boolean	hasPeriod()
boolean	hasSystem()
boolean	hasSystemElement()
boolean	hasType()
boolean	hasUse()
boolean	hasUseElement()
boolean	hasValue()
boolean	hasValueElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
boolean	matches(Identifier other)
void	removeChild(String name, Base value)
Identifier	setAssigner(Reference value)
Identifier	setPeriod(Period value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Identifier	setSystem(String value)
Identifier	setSystemElement(UriType value)
Identifier	setType(CodeableConcept value)
Identifier	setUse(Identifier.IdentifierUse value)
Identifier	setUseElement(Enumeration<Identifier.IdentifierUse> value)
Identifier	setValue(String value)
Identifier	setValueElement(StringType value)
protected Identifier	typedCopy()

Methods inherited from class org.hl7.fhir.r5.model.DataType

copyValues, getTranslation, isTranslatable

Methods inherited from class org.hl7.fhir.r5.model.Element

addExtension, addExtension, addExtension, copyExtensions, copyNewExtensions, copyValues, getExtension, getExtensionByUrl, getExtensionByUrl, getExtensionFirstRep, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getExtensionValue, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getStandardsStatus, hasExtension, hasExtension, hasExtension, hasExtension, hasId, hasIdElement, isDisallowExtensions, noExtensions, removeExtension, setDisallowExtensions, setExtension, setId, setIdBase, setIdElement, setStandardsStatus

Methods inherited from class org.hl7.fhir.r5.model.Base

addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, isResource, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseElement

getUserData, setUserData

Field Details

use

protected Enumeration<Identifier.IdentifierUse> 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, an absolute 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.

Constructor Details

Identifier

public Identifier()

Constructor

Method Details

getUseElement

public Enumeration<Identifier.IdentifierUse> 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

public Identifier setUseElement(Enumeration<Identifier.IdentifierUse> value)

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

public Identifier.IdentifierUse getUse()

Returns:

The purpose of this identifier.

setUse

public Identifier setUse(Identifier.IdentifierUse value)

Parameters:

value - The purpose of this identifier.

getType

public CodeableConcept 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

public UriType getSystemElement()

Returns:

system (Establishes the namespace for the value - that is, an absolute 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, an absolute 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, an absolute 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, an absolute URL that describes a set values that are unique.

getValueElement

public StringType 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

public Identifier setValueElement(StringType value)

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

public Reference 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.)

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

removeChild

public void removeChild(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

removeChild 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 DataType

Returns:

the FHIR type name of the instance (not the java class name)

copy

public Identifier copy()

Specified by:

copy in class DataType

copyValues

public void copyValues(Identifier dst)

typedCopy

protected Identifier typedCopy()

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

matches

public boolean matches(Identifier other)