Package ca.uhn.fhir.model.dstu2.resource

Class BodySite

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

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

ca.uhn.fhir.model.dstu2.resource.BodySite

All Implemented Interfaces:

ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class BodySite
extends BaseResource
implements ca.uhn.fhir.model.api.IResource

HAPI/FHIR BodySite Resource ()

Definition: Record details about the anatomical location of a specimen or body part. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

Requirements:

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ca.uhn.fhir.rest.gclient.TokenClientParam	CODE	Fluent Client search parameter constant for code
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
static String	SP_CODE	Search parameter constant for code
static String	SP_IDENTIFIER	Search parameter constant for identifier
static String	SP_PATIENT	Search parameter constant for patient

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	Description
BodySite()

Method Summary

Modifier and Type	Method	Description
IdentifierDt	addIdentifier()	Adds and returns a new value for identifier ()
BodySite	addIdentifier(IdentifierDt theValue)	Adds a given new value for identifier ()
AttachmentDt	addImage()	Adds and returns a new value for image ()
BodySite	addImage(AttachmentDt theValue)	Adds a given new value for image ()
CodeableConceptDt	addModifier()	Adds and returns a new value for modifier ()
BodySite	addModifier(CodeableConceptDt theValue)	Adds a given new value for modifier ()
<T extends ca.uhn.fhir.model.api.IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
CodeableConceptDt	getCode()	Gets the value(s) for code ().
String	getDescription()	Gets the value(s) for description ().
ca.uhn.fhir.model.primitive.StringDt	getDescriptionElement()	Gets the value(s) for description ().
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.
List<AttachmentDt>	getImage()	Gets the value(s) for image ().
AttachmentDt	getImageFirstRep()	Gets the first repetition for image (), creating it if it does not already exist.
List<CodeableConceptDt>	getModifier()	Gets the value(s) for modifier ().
CodeableConceptDt	getModifierFirstRep()	Gets the first repetition for modifier (), creating it if it does not already exist.
ResourceReferenceDt	getPatient()	Gets the value(s) for patient ().
String	getResourceName()
ca.uhn.fhir.context.FhirVersionEnum	getStructureFhirVersionEnum()
boolean	isEmpty()
BodySite	setCode(CodeableConceptDt theValue)	Sets the value(s) for code ()
BodySite	setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)	Sets the value(s) for description ()
BodySite	setDescription(String theString)	Sets the value for description ()
BodySite	setIdentifier(List<IdentifierDt> theValue)	Sets the value(s) for identifier ()
BodySite	setImage(List<AttachmentDt> theValue)	Sets the value(s) for image ()
BodySite	setModifier(List<CodeableConceptDt> theValue)	Sets the value(s) for modifier ()
BodySite	setPatient(ResourceReferenceDt theValue)	Sets the value(s) for patient ()

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

getContained, getId, getIdElement, getLanguage, getMeta, 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, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, setUserData

Methods inherited from class java.lang.Object

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

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

fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData

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

getIdElement, setId, setId

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

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

Field Details

SP_CODE

public static final String SP_CODE

Search parameter constant for code

Description: Named anatomical location
Type: token
Path: BodySite.code

See Also:

Constant Field Values

CODE

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE

Fluent Client search parameter constant for code

Description: Named anatomical location
Type: token
Path: BodySite.code

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description: Patient to whom bodysite belongs
Type: reference
Path: BodySite.patient

See Also:

Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Patient to whom bodysite belongs
Type: reference
Path: BodySite.patient

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description: Identifier for this instance of the anatomical location
Type: token
Path: BodySite.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Identifier for this instance of the anatomical location
Type: token
Path: BodySite.identifier

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

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

Constructor Details

BodySite

public BodySite()

Method Details

isEmpty

public boolean isEmpty()

Specified by:

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

getAllPopulatedChildElementsOfType

public <T extends ca.uhn.fhir.model.api.IElement>
List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement

getPatient

public ResourceReferenceDt getPatient()

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

Definition: The person to which the body site belongs

setPatient

public BodySite setPatient(ResourceReferenceDt theValue)

Sets the value(s) for patient ()

Definition: The person to which the body site belongs

getIdentifier

public List<IdentifierDt> getIdentifier()

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

Definition: Identifier for this instance of the anatomical location.

setIdentifier

public BodySite setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier ()

Definition: Identifier for this instance of the anatomical location.

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier ()

Definition: Identifier for this instance of the anatomical location.

addIdentifier

public BodySite addIdentifier(IdentifierDt theValue)

Adds a given new value for identifier ()

Definition: Identifier for this instance of the anatomical location.

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 for this instance of the anatomical location.

getCode

public CodeableConceptDt getCode()

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

Definition: Named anatomical location - ideally coded where possible.

setCode

public BodySite setCode(CodeableConceptDt theValue)

Sets the value(s) for code ()

Definition: Named anatomical location - ideally coded where possible.

getModifier

public List<CodeableConceptDt> getModifier()

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

Definition: Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.

setModifier

public BodySite setModifier(List<CodeableConceptDt> theValue)

Sets the value(s) for modifier ()

Definition: Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.

addModifier

public CodeableConceptDt addModifier()

Adds and returns a new value for modifier ()

Definition: Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.

addModifier

public BodySite addModifier(CodeableConceptDt theValue)

Adds a given new value for modifier ()

Definition: Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.

Parameters:

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

getModifierFirstRep

public CodeableConceptDt getModifierFirstRep()

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

Definition: Modifier to refine the anatomical location. These include modifiers for laterality, relative location, directionality, number, and plane.

getDescriptionElement

public ca.uhn.fhir.model.primitive.StringDt getDescriptionElement()

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

Definition: Description of anatomical location.

getDescription

public String getDescription()

Gets the value(s) for description (). creating it if it does not exist. This method may return null.

Definition: Description of anatomical location.

setDescription

public BodySite setDescription(ca.uhn.fhir.model.primitive.StringDt theValue)

Sets the value(s) for description ()

Definition: Description of anatomical location.

setDescription

public BodySite setDescription(String theString)

Sets the value for description ()

Definition: Description of anatomical location.

getImage

public List<AttachmentDt> getImage()

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

Definition: Image or images used to identify a location.

setImage

public BodySite setImage(List<AttachmentDt> theValue)

Sets the value(s) for image ()

Definition: Image or images used to identify a location.

addImage

public AttachmentDt addImage()

Adds and returns a new value for image ()

Definition: Image or images used to identify a location.

addImage

public BodySite addImage(AttachmentDt theValue)

Adds a given new value for image ()

Definition: Image or images used to identify a location.

Parameters:

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

getImageFirstRep

public AttachmentDt getImageFirstRep()

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

Definition: Image or images used to identify a location.

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface ca.uhn.fhir.model.api.IResource

getStructureFhirVersionEnum

public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource

Specified by:

getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource