Package org.hl7.fhir.r5.openehr

Class OBJECT_REF

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.LogicalBase

org.hl7.fhir.r5.openehr.OBJECT_REF

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.ICompositeType

Direct Known Subclasses:

LOCATABLE_REF, PARTY_REF

public class OBJECT_REF
extends LogicalBase
implements org.hl7.fhir.instance.model.api.ICompositeType

Class describing a reference to another object, which may exist locally or be maintained outside the current namespace, e.g. in another service. Services are usually external, e.g. available in a LAN (including on the same host) or the internet via Corba, SOAP, or some other distributed protocol. However, in small systems they may be part of the same executable as the data containing the Id.

See Also:

• Serialized Form

Nested Class Summary

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 OBJECT_ID	id	Globally unique id of an object, regardless of where it is stored.
protected StringType	namespace	Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic .
protected StringType	type	Name of the class (concrete or abstract) of object to which this identifier type refers, e.g.

Constructor Summary

Constructors

Constructor	Description
OBJECT_REF()	Constructor
OBJECT_REF(String namespace, String type, OBJECT_ID id)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
OBJECT_REF	copy()
void	copyValues(OBJECT_REF dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
OBJECT_ID	getId()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
String	getNamespace()
StringType	getNamespaceElement()
Base[]	getProperty(int hash, String name, boolean checkValid)
String	getType()
StringType	getTypeElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasId()
boolean	hasNamespace()
boolean	hasNamespaceElement()
boolean	hasType()
boolean	hasTypeElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
OBJECT_REF	setId(OBJECT_ID value)
OBJECT_REF	setNamespace(String value)
OBJECT_REF	setNamespaceElement(StringType value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
OBJECT_REF	setType(String value)
OBJECT_REF	setTypeElement(StringType value)
protected OBJECT_REF	typedCopy()

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

getFHIRPublicationVersion, getIdBase, setIdBase

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

Field Details

namespace

protected StringType namespace

Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic . These names are not yet standardised. Legal values for namespace are: 'local', 'unknown', or a string matching the standard regex [a-zA-Z][a-zA-Z0-9_.:/invalid input: '&'?=+-]*. Note that the first two are just special values of the regex, and will be matched by it.

type

protected StringType type

Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. PARTY, PERSON, GUIDELINE etc. These class names are from the relevant reference model. The type name ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).

id

protected OBJECT_ID id

Globally unique id of an object, regardless of where it is stored.

Constructor Details

OBJECT_REF

public OBJECT_REF()

Constructor

OBJECT_REF

public OBJECT_REF(String namespace,
 String type,
 OBJECT_ID id)

Constructor

Method Details

getNamespaceElement

public StringType getNamespaceElement()

Returns:

namespace (Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic . These names are not yet standardised. Legal values for namespace are: 'local', 'unknown', or a string matching the standard regex [a-zA-Z][a-zA-Z0-9_.:/invalid input: '&'?=+-]*. Note that the first two are just special values of the regex, and will be matched by it.). This is the underlying object with id, value and extensions. The accessor "getNamespace" gives direct access to the value

hasNamespaceElement

public boolean hasNamespaceElement()

hasNamespace

public boolean hasNamespace()

setNamespaceElement

public OBJECT_REF setNamespaceElement(StringType value)

Parameters:

value - namespace (Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic . These names are not yet standardised. Legal values for namespace are: 'local', 'unknown', or a string matching the standard regex [a-zA-Z][a-zA-Z0-9_.:/invalid input: '&'?=+-]*. Note that the first two are just special values of the regex, and will be matched by it.). This is the underlying object with id, value and extensions. The accessor "getNamespace" gives direct access to the value

getNamespace

public String getNamespace()

Returns:

Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic . These names are not yet standardised. Legal values for namespace are: 'local', 'unknown', or a string matching the standard regex [a-zA-Z][a-zA-Z0-9_.:/invalid input: '&'?=+-]*. Note that the first two are just special values of the regex, and will be matched by it.

setNamespace

public OBJECT_REF setNamespace(String value)

Parameters:

value - Namespace to which this identifier belongs in the local system context (and possibly in any other openEHR compliant environment) e.g. terminology , demographic . These names are not yet standardised. Legal values for namespace are: 'local', 'unknown', or a string matching the standard regex [a-zA-Z][a-zA-Z0-9_.:/invalid input: '&'?=+-]*. Note that the first two are just special values of the regex, and will be matched by it.

getTypeElement

public StringType getTypeElement()

Returns:

type (Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. PARTY, PERSON, GUIDELINE etc. These class names are from the relevant reference model. The type name ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

hasTypeElement

public boolean hasTypeElement()

hasType

public boolean hasType()

setTypeElement

public OBJECT_REF setTypeElement(StringType value)

Parameters:

value - type (Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. PARTY, PERSON, GUIDELINE etc. These class names are from the relevant reference model. The type name ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).). This is the underlying object with id, value and extensions. The accessor "getType" gives direct access to the value

getType

public String getType()

Returns:

Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. PARTY, PERSON, GUIDELINE etc. These class names are from the relevant reference model. The type name ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).

setType

public OBJECT_REF setType(String value)

Parameters:

value - Name of the class (concrete or abstract) of object to which this identifier type refers, e.g. PARTY, PERSON, GUIDELINE etc. These class names are from the relevant reference model. The type name ANY can be used to indicate that any type is accepted (e.g. if the type is unknown).

getId

public OBJECT_ID getId()

Returns:

id (Globally unique id of an object, regardless of where it is stored.)

hasId

public boolean hasId()

setId

public OBJECT_REF setId(OBJECT_ID value)

Parameters:

value - id (Globally unique id of an object, regardless of where it is stored.)

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class Base

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class Base

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 Base

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 Base

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class Base

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Specified by:

fhirType in class Base

Returns:

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

copy

public OBJECT_REF copy()

Specified by:

copy in class Base

copyValues

public void copyValues(OBJECT_REF dst)

typedCopy

protected OBJECT_REF typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class Base

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class Base

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class Base