Package com.ibm.fhir.model.type

Class Identifier

java.lang.Object

com.ibm.fhir.model.visitor.AbstractVisitable

com.ibm.fhir.model.type.Element

com.ibm.fhir.model.type.Identifier

All Implemented Interfaces:

Visitable

@Generated("com.ibm.fhir.tools.CodeGenerator")
public class Identifier
extends Element

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Identifier.Builder

Field Summary

Fields inherited from class com.ibm.fhir.model.type.Element

extension, id

Method Summary

Modifier and Type	Method	Description
void	accept(String elementName, int elementIndex, Visitor visitor)	Accept a Visitor and invoke the appropriate visit methods.
static Identifier.Builder	builder()
boolean	equals(Object obj)
Reference	getAssigner()	Organization that issued/manages the identifier.
Period	getPeriod()	Time period during which identifier is/was valid for use.
Uri	getSystem()	Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
CodeableConcept	getType()	A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
IdentifierUse	getUse()	The purpose of this identifier.
String	getValue()	The portion of the identifier typically relevant to the user and which is unique within the context of the system.
boolean	hasChildren()
int	hashCode()
Identifier.Builder	toBuilder()	Create a new Builder from the contents of this Element

Methods inherited from class com.ibm.fhir.model.type.Element

as, getExtension, getId, hasValue, is

Methods inherited from class com.ibm.fhir.model.visitor.AbstractVisitable

accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, accept, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.fhir.model.visitor.Visitable

accept, accept

Method Detail

getUse

public IdentifierUse getUse()

The purpose of this identifier.

Returns:

An immutable object of type IdentifierUse that may be null.

getType

public CodeableConcept getType()

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

Returns:

An immutable object of type CodeableConcept that may be null.

getSystem

public Uri getSystem()

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

Returns:

An immutable object of type Uri that may be null.

getValue

public String getValue()

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

Returns:

An immutable object of type String that may be null.

getPeriod

public Period getPeriod()

Time period during which identifier is/was valid for use.

Returns:

An immutable object of type Period that may be null.

getAssigner

public Reference getAssigner()

Organization that issued/manages the identifier.

Returns:

An immutable object of type Reference that may be null.

hasChildren

public boolean hasChildren()

Overrides:

hasChildren in class Element

accept

public void accept(String elementName,
                   int elementIndex,
                   Visitor visitor)

Description copied from interface: Visitable

Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:

 if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
 

Specified by:

accept in interface Visitable

Specified by:

accept in class AbstractVisitable

Parameters:

elementName - the name of the element in the context of this visit

elementIndex - the index of the element in a list or -1 if it is not contained within a List

visitor - the visitor to use

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public Identifier.Builder toBuilder()

Description copied from class: Element

Create a new Builder from the contents of this Element

Specified by:

toBuilder in class Element

builder

public static Identifier.Builder builder()