Package org.openehealth.ipf.commons.ihe.xds.core.metadata

Class ReferenceId

java.lang.Object

org.openehealth.ipf.commons.ihe.xds.core.metadata.Hl7v2Based<ca.uhn.hl7v2.model.v25.datatype.CX>

org.openehealth.ipf.commons.ihe.xds.core.metadata.ReferenceId

All Implemented Interfaces:

Serializable

public class ReferenceId
extends Hl7v2Based<ca.uhn.hl7v2.model.v25.datatype.CX>

Represents a reference ID.

This class is derived from an HL7v2 CX data type ("CXi" in IHE ITI TF-3).

All members of this class are allowed to be null. When transforming to HL7 this indicates that the values are empty. Trailing empty values are removed from the HL7 string.

Author:

Jens Riemschneider, Dmytro Rud

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.openehealth.ipf.commons.ihe.xds.core.metadata.Hl7v2Based

Hl7v2Based.Holder<T extends ca.uhn.hl7v2.model.Type>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_TYPE_CODE_ACCESSION
static final String	ID_TYPE_CODE_ORDER
static final String	ID_TYPE_CODE_REFERRAL
static final String	ID_TYPE_CODE_UNIQUE_ID
static final String	ID_TYPE_ENCOUNTER_ID
static final String	ID_TYPE_STUDY_INSTANCE_ID
static final String	ID_TYPE_WORKFLOW_INSTANCE_ID

Fields inherited from class org.openehealth.ipf.commons.ihe.xds.core.metadata.Hl7v2Based

MESSAGE

Constructor Summary

Constructors

Constructor	Description
ReferenceId()	Constructs a reference ID.
ReferenceId(ca.uhn.hl7v2.model.v25.datatype.CX cx)	Constructs a reference ID.
ReferenceId(String id, CXiAssigningAuthority assigningAuthority, String idTypeCode)	Constructs a reference ID.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
CXiAssigningAuthority	getAssigningAuthority()
String	getId()
String	getIdTypeCode()
int	hashCode()
static ReferenceId	parse(String hl7String)	Parses an HL7v2 string into a ReferenceId object.
void	setAssigningAuthority(CXiAssigningAuthority assigningAuthority)
void	setId(String id)
void	setIdTypeCode(String idTypeCode)
String	toString()

Methods inherited from class org.openehealth.ipf.commons.ihe.xds.core.metadata.Hl7v2Based

getHapiObject, getIntegerValue, getLongValue, isEmpty, parse, rawRender, render, render, setAssigningAuthority, setValue, setValue

Methods inherited from class java.lang.Object

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

Field Details

ID_TYPE_CODE_UNIQUE_ID

public static final String ID_TYPE_CODE_UNIQUE_ID

See Also:

• Constant Field Values

ID_TYPE_CODE_ACCESSION

public static final String ID_TYPE_CODE_ACCESSION

See Also:

• Constant Field Values

ID_TYPE_CODE_REFERRAL

public static final String ID_TYPE_CODE_REFERRAL

See Also:

• Constant Field Values

ID_TYPE_CODE_ORDER

public static final String ID_TYPE_CODE_ORDER

See Also:

• Constant Field Values

ID_TYPE_WORKFLOW_INSTANCE_ID

public static final String ID_TYPE_WORKFLOW_INSTANCE_ID

See Also:

• Constant Field Values

ID_TYPE_ENCOUNTER_ID

public static final String ID_TYPE_ENCOUNTER_ID

See Also:

• Constant Field Values

ID_TYPE_STUDY_INSTANCE_ID

public static final String ID_TYPE_STUDY_INSTANCE_ID

See Also:

• Constant Field Values

Constructor Details

ReferenceId

public ReferenceId()

Constructs a reference ID.

ReferenceId

public ReferenceId(ca.uhn.hl7v2.model.v25.datatype.CX cx)

Constructs a reference ID.

ReferenceId

public ReferenceId(String id,
 CXiAssigningAuthority assigningAuthority,
 String idTypeCode)

Constructs a reference ID.

Parameters:

id - the value of the id (CX.1).

assigningAuthority - the assigning authority (CX.4).

idTypeCode - the ID type code (CX.5).

Method Details

parse

public static ReferenceId parse(String hl7String)

Parses an HL7v2 string into a ReferenceId object.

Parameters:

hl7String - HL7v2 representation of a ReferenceId object.

Returns:

parsed ReferenceId object.

getId

public String getId()

Returns:

the value of the id (CX.1).

setId

public void setId(String id)

Parameters:

id - the value of the id (CX.1).

getAssigningAuthority

public CXiAssigningAuthority getAssigningAuthority()

Returns:

the assigning authority (CX.4).

setAssigningAuthority

public void setAssigningAuthority(CXiAssigningAuthority assigningAuthority)

Parameters:

assigningAuthority - the assigning authority (CX.4).

getIdTypeCode

public String getIdTypeCode()

Returns:

ID type code (CX.5).

setIdTypeCode

public void setIdTypeCode(String idTypeCode)

Parameters:

idTypeCode - ID type code (CX.5).

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object