ca.uhn.fhir.model.dstu2.resource

Class Basic

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.dstu2.resource.BaseResource

ca.uhn.fhir.model.dstu2.resource.Basic

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource

public class Basic
extends BaseResource
implements IResource

HAPI/FHIR Basic Resource ()

Definition: Basic is used for handling concepts not yet defined in FHIR, narrative-only resources that don't map to an existing resource, and custom resources not appropriate for inclusion in the FHIR specification.

Requirements: Need some way to safely (without breaking interoperability) allow implementers to exchange content not supported by the initial set of declared resources.

Profile Definition: http://hl7.org/fhir/profiles/Basic

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ReferenceClientParam	AUTHOR Fluent Client search parameter constant for author
static TokenClientParam	CODE Fluent Client search parameter constant for code
static DateClientParam	CREATED Fluent Client search parameter constant for created
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_AUTHOR Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_SUBJECT Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static String	SP_AUTHOR Search parameter constant for author
static String	SP_CODE Search parameter constant for code
static String	SP_CREATED Search parameter constant for created
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_PATIENT Search parameter constant for patient
static String	SP_SUBJECT Search parameter constant for subject
static ReferenceClientParam	SUBJECT Fluent Client search parameter constant for subject

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
Basic()

Method Summary

Modifier and Type	Method and Description
IdentifierDt	addIdentifier() Adds and returns a new value for identifier ()
Basic	addIdentifier(IdentifierDt theValue) Adds a given new value for identifier ()
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
ResourceReferenceDt	getAuthor() Gets the value(s) for author ().
CodeableConceptDt	getCode() Gets the value(s) for code ().
Date	getCreated() Gets the value(s) for created ().
DateDt	getCreatedElement() Gets the value(s) for created ().
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier ().
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (), creating it if it does not already exist.
String	getResourceName()
FhirVersionEnum	getStructureFhirVersionEnum()
ResourceReferenceDt	getSubject() Gets the value(s) for subject ().
boolean	isEmpty()
Basic	setAuthor(ResourceReferenceDt theValue) Sets the value(s) for author ()
Basic	setCode(CodeableConceptDt theValue) Sets the value(s) for code ()
Basic	setCreated(DateDt theValue) Sets the value(s) for created ()
Basic	setCreated(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for created ()
Basic	setCreatedWithDayPrecision(Date theDate) Sets the value for created ()
Basic	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier ()
Basic	setSubject(ResourceReferenceDt theValue) Sets the value(s) for subject ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, 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

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getIdElement, setId, setId

Field Detail

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter constant for subject

Description:
Type: reference
Path: Basic.subject

See Also:

Constant Field Values

SUBJECT

public static final ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description:
Type: reference
Path: Basic.subject

SP_CREATED

public static final String SP_CREATED

Search parameter constant for created

Description:
Type: date
Path: Basic.created

See Also:

Constant Field Values

CREATED

public static final DateClientParam CREATED

Fluent Client search parameter constant for created

Description:
Type: date
Path: Basic.created

SP_CODE

public static final String SP_CODE

Search parameter constant for code

Description:
Type: token
Path: Basic.code

See Also:

Constant Field Values

CODE

public static final TokenClientParam CODE

Fluent Client search parameter constant for code

Description:
Type: token
Path: Basic.code

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description:
Type: reference
Path: Basic.subject

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description:
Type: reference
Path: Basic.subject

SP_AUTHOR

public static final String SP_AUTHOR

Search parameter constant for author

Description:
Type: reference
Path: Basic.author

See Also:

Constant Field Values

AUTHOR

public static final ReferenceClientParam AUTHOR

Fluent Client search parameter constant for author

Description:
Type: reference
Path: Basic.author

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description:
Type: token
Path: Basic.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description:
Type: token
Path: Basic.identifier

INCLUDE_AUTHOR

public static final Include INCLUDE_AUTHOR

Constant for fluent queries to be used to add include statements. Specifies the path value of "Basic:author".

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Basic:patient".

INCLUDE_SUBJECT

public static final Include INCLUDE_SUBJECT

Constant for fluent queries to be used to add include statements. Specifies the path value of "Basic:subject".

Constructor Detail

Basic

public Basic()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

Definition: Identifier assigned to the resource for business purposes, outside the context of FHIR

setIdentifier

public Basic setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier ()

Definition: Identifier assigned to the resource for business purposes, outside the context of FHIR

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier ()

Definition: Identifier assigned to the resource for business purposes, outside the context of FHIR

addIdentifier

public Basic addIdentifier(IdentifierDt theValue)

Adds a given new value for identifier ()

Definition: Identifier assigned to the resource for business purposes, outside the context of FHIR

Parameters:

theValue - The identifier to add (must not be null)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (), creating it if it does not already exist.

Definition: Identifier assigned to the resource for business purposes, outside the context of FHIR

getCode

public CodeableConceptDt getCode()

Gets the value(s) for code (). creating it if it does not exist. Will not return null.

Definition: Identifies the 'type' of resource - equivalent to the resource name for other resources.

setCode

public Basic setCode(CodeableConceptDt theValue)

Sets the value(s) for code ()

Definition: Identifies the 'type' of resource - equivalent to the resource name for other resources.

getSubject

public ResourceReferenceDt getSubject()

Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

Definition: Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resource.

setSubject

public Basic setSubject(ResourceReferenceDt theValue)

Sets the value(s) for subject ()

Definition: Identifies the patient, practitioner, device or any other resource that is the \"focus\" of this resource.

getAuthor

public ResourceReferenceDt getAuthor()

Gets the value(s) for author (). creating it if it does not exist. Will not return null.

Definition: Indicates who was responsible for creating the resource instance

setAuthor

public Basic setAuthor(ResourceReferenceDt theValue)

Sets the value(s) for author ()

Definition: Indicates who was responsible for creating the resource instance

getCreatedElement

public DateDt getCreatedElement()

Gets the value(s) for created (). creating it if it does not exist. Will not return null.

Definition: Identifies when the resource was first created

getCreated

public Date getCreated()

Gets the value(s) for created (). creating it if it does not exist. Will not return null.

Definition: Identifies when the resource was first created

setCreated

public Basic setCreated(DateDt theValue)

Sets the value(s) for created ()

Definition: Identifies when the resource was first created

setCreated

public Basic setCreated(Date theDate,
                        TemporalPrecisionEnum thePrecision)

Sets the value for created ()

Definition: Identifies when the resource was first created

setCreatedWithDayPrecision

public Basic setCreatedWithDayPrecision(Date theDate)

Sets the value for created ()

Definition: Identifies when the resource was first created

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface IResource

getStructureFhirVersionEnum

public FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface IResource

Specified by:

getStructureFhirVersionEnum in interface IBaseResource