Package org.hl7.fhir.instance.model.api

Interface IBase

All Superinterfaces:

Serializable

All Known Subinterfaces:

BaseConformance, BaseOperationOutcome, BaseSecurityEvent, IAnyResource, IBackboneElement, IBaseBackboneElement, IBaseBinary, IBaseBooleanDatatype, IBaseBundle, IBaseCoding, IBaseConformance, IBaseDatatype, IBaseDatatypeElement, IBaseDecimalDatatype, IBaseEnumeration<T>, IBaseExtension<T,D>, IBaseHasExtensions, IBaseIntegerDatatype, IBaseLongDatatype, IBaseMetaType, IBaseOperationOutcome, IBaseParameters, IBaseReference, IBaseResource, IBaseXhtml, ICompositeDatatype, ICompositeElement, ICompositeType, IDatatype, IDomainResource, IElement, IExtension, IIdentifiableElement, IIdType, INarrative, IPrimitiveDatatype<T>, IPrimitiveType<T>, IResource, IResourceBlock, IStreamingDatatype<T>, ISupportsUndeclaredExtensions

All Known Implementing Classes:

Base64BinaryDt, BaseCodingDt, BaseContainedDt, BaseDateTimeDt, BaseElement, BaseHumanNameDt, BaseIdentifiableElement, BaseIdentifierDt, BaseNarrativeDt, BaseOperationOutcome.BaseIssue, BasePrimitive, BaseQuantityDt, BaseResourceReferenceDt, BooleanDt, BoundCodeDt, CodeDt, DateDt, DateParam.DateParamDateTimeHolder, DateTimeDt, DecimalDt, ExtensionDt, IdDt, InstantDt, IntegerDt, InternalCodingDt, MarkdownDt, OidDt, PositiveIntDt, StringDt, Tag, TagList, TimeDt, UnsignedIntDt, UriDt, XhtmlDt

public interface IBase
extends Serializable

This interface is a simple marker for anything which is an HL7 structure of some kind. It is provided mostly to simplify convergence between the HL7.org structures and the HAPI ones.

Method Summary

Modifier and Type	Method	Description
default String	fhirType()	Returns the FHIR type name for the given element, e.g.
List<String>	getFormatCommentsPost()	Returns a list of comments appearing immediately after this element within the serialized form of the resource.
List<String>	getFormatCommentsPre()	Returns a list of comments appearing immediately before this element within the serialized form of the resource.
Object	getUserData(String theName)	Retrieves any user suplied data in this element
boolean	hasFormatComment()	Returns true if any comments would be returned by getFormatCommentsPre() or getFormatCommentsPost()
boolean	isEmpty()
void	setUserData(String theName, Object theValue)	Sets a user supplied data value in this element

Method Detail

isEmpty

boolean isEmpty()

hasFormatComment

boolean hasFormatComment()

Returns true if any comments would be returned by getFormatCommentsPre() or getFormatCommentsPost()

Since:

1.5

getFormatCommentsPre

List<String> getFormatCommentsPre()

Returns a list of comments appearing immediately before this element within the serialized form of the resource. Creates the list if it does not exist, so this method will not return null

Since:

1.5

getFormatCommentsPost

List<String> getFormatCommentsPost()

Returns a list of comments appearing immediately after this element within the serialized form of the resource. Creates the list if it does not exist, so this method will not return null

Since:

1.5

fhirType

default String fhirType()

Returns the FHIR type name for the given element, e.g. "Patient" or "unsignedInt"

getUserData

Object getUserData(String theName)

Retrieves any user suplied data in this element

setUserData

void setUserData(String theName,
                 Object theValue)

Sets a user supplied data value in this element