ca.uhn.fhir.model.api

Class BaseResource

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.api.BaseResource

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions

Direct Known Subclasses:

BaseConformance, BaseOperationOutcome, BaseSecurityEvent, Binary

public abstract class BaseResource
extends BaseElement
implements IResource

Field Summary

Fields

Modifier and Type	Field and Description
static StringClientParam	RES_ID Fluent Client search parameter constant for _id
static String	SP_RES_ID Search parameter constant for _id
static String	SP_RES_LANGUAGE Search parameter constant for _language

Constructor Summary

Constructors

Constructor and Description
BaseResource()

Method Summary

Methods

Modifier and Type	Method and Description
ContainedDt	getContained() Returns the contained resource list for this resource.
IdDt	getId() Returns the ID of this resource.
CodeDt	getLanguage() Gets the language of the resource itself - NOTE that this language attribute applies to the resource itself, it is not (for example) the language spoken by a practitioner or patient
Map<ResourceMetadataKeyEnum<?>,Object>	getResourceMetadata() Returns the metadata map for this object, creating it if neccesary.
NarrativeDt	getText() Returns the narrative block for this resource
protected boolean	isBaseEmpty() Intended to be called by extending classes IElement.isEmpty() implementations, returns true if all content in this superclass instance is empty per the semantics of IElement.isEmpty().
void	setContained(ContainedDt theContained)
void	setId(IdDt theId) Sets the ID of this resource.
void	setId(String theId)
void	setLanguage(CodeDt theLanguage) Sets the language of the resource itself - NOTE that this language attribute applies to the resource itself, it is not (for example) the language spoken by a practitioner or patient
void	setResourceMetadata(Map<ResourceMetadataKeyEnum<?>,Object> theMap) Sets the metadata map for this object.
void	setText(NarrativeDt theText)
String	toString()

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getResourceName

Methods inherited from interface ca.uhn.fhir.model.api.ICompositeElement

getAllPopulatedChildElementsOfType

Methods inherited from interface ca.uhn.fhir.model.api.IElement

isEmpty

Field Detail

SP_RES_LANGUAGE

public static final String SP_RES_LANGUAGE

Search parameter constant for _language

See Also:

Constant Field Values

SP_RES_ID

public static final String SP_RES_ID

Search parameter constant for _id

See Also:

Constant Field Values

RES_ID

public static final StringClientParam RES_ID

Fluent Client search parameter constant for _id

Description: the _id of a resource
Type: string
Path: Resource._id

Constructor Detail

BaseResource

public BaseResource()

Method Detail

getContained

public ContainedDt getContained()

Description copied from interface: IResource

Returns the contained resource list for this resource.

Usage note: HAPI will generally populate and use the resources from this list automatically (placing inline resources in the contained list when encoding, and copying contained resources from this list to their appropriate references when parsing) so it is generally not neccesary to interact with this list directly. Instead, in a server you can place resource instances in reference fields (such as Patient) and the resource will be automatically contained. In a client, contained resources will be automatically populated into their appropriate fields by the HAPI parser.

TODO: document contained resources and link there

Specified by:

getContained in interface IResource

getId

public IdDt getId()

Description copied from interface: IResource

Returns the ID of this resource. Note that this identifier is the URL (or a portion of the URL) used to access this resource, and is not the same thing as any business identifiers stored within the resource. For example, a Patient resource might have any number of medical record numbers but these are not stored here.

This ID is specified as the "Logical ID" and "Version ID" in the FHIR specification, see here

Specified by:

getId in interface IResource

getLanguage

public CodeDt getLanguage()

Description copied from interface: IResource

Gets the language of the resource itself - NOTE that this language attribute applies to the resource itself, it is not (for example) the language spoken by a practitioner or patient

Specified by:

getLanguage in interface IResource

getResourceMetadata

public Map<ResourceMetadataKeyEnum<?>,Object> getResourceMetadata()

Description copied from interface: IResource

Returns the metadata map for this object, creating it if neccesary. Metadata entries are used to get/set feed bundle entries, such as the resource version, or the last updated timestamp.

Keys in this map are enumerated in the ResourceMetadataKeyEnum, and each key has a specific value type that it must use.

Specified by:

getResourceMetadata in interface IResource

See Also:

for a list of allowable keys and the object types that values of a given key must use.

getText

public NarrativeDt getText()

Description copied from interface: IResource

Returns the narrative block for this resource

Specified by:

getText in interface IResource

setContained

public void setContained(ContainedDt theContained)

setId

public void setId(IdDt theId)

Description copied from interface: IResource

Sets the ID of this resource. Note that this identifier is the URL (or a portion of the URL) used to access this resource, and is not the same thing as any business identifiers stored within the resource. For example, a Patient resource might have any number of medical record numbers but these are not stored here.

This ID is specified as the "Logical ID" and "Version ID" in the FHIR specification, see here

Specified by:

setId in interface IResource

setId

public void setId(String theId)

setLanguage

public void setLanguage(CodeDt theLanguage)

Description copied from interface: IResource

Sets the language of the resource itself - NOTE that this language attribute applies to the resource itself, it is not (for example) the language spoken by a practitioner or patient

Specified by:

setLanguage in interface IResource

setResourceMetadata

public void setResourceMetadata(Map<ResourceMetadataKeyEnum<?>,Object> theMap)

Description copied from interface: IResource

Sets the metadata map for this object. Metadata entries are used to get/set feed bundle entries, such as the resource version, or the last updated timestamp.

Specified by:

setResourceMetadata in interface IResource

setText

public void setText(NarrativeDt theText)

toString

public String toString()

Overrides:

toString in class Object

isBaseEmpty

protected boolean isBaseEmpty()

Intended to be called by extending classes IElement.isEmpty() implementations, returns true if all content in this superclass instance is empty per the semantics of IElement.isEmpty().

Overrides:

isBaseEmpty in class BaseElement