org.hl7.fhir.dstu3.model

Class BodySite

java.lang.Object

org.hl7.fhir.dstu3.model.Base

org.hl7.fhir.dstu3.model.BaseResource

org.hl7.fhir.dstu3.model.Resource

org.hl7.fhir.dstu3.model.DomainResource

org.hl7.fhir.dstu3.model.BodySite

All Implemented Interfaces:

IElement, Serializable, IAnyResource, IBase, IBaseHasExtensions, IBaseHasModifierExtensions, IBaseResource, IDomainResource

public class BodySite
extends DomainResource

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.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected BooleanType	active Whether this body site is in active use.
protected CodeableConcept	code Named anatomical location - ideally coded where possible.
static TokenClientParam	CODE Fluent Client search parameter constant for code
protected StringType	description A summary, charactarization or explanation of the anatomic location.
protected List<Identifier>	identifier Identifier for this instance of the anatomical location.
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
protected List<Attachment>	image Image or images used to identify a location.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
protected Reference	patient The person to which the body site belongs.
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
protected Patient	patientTarget The actual object that is the target of the reference (The person to which the body site belongs.)
protected List<CodeableConcept>	qualifier Qualifier to refine the anatomical location.
static String	SP_CODE Search parameter: code
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_PATIENT Search parameter: patient

Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.dstu3.model.Resource

id, implicitRules, language, meta

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

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
BodySite() Constructor
BodySite(Reference patient) Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
Identifier	addIdentifier()
BodySite	addIdentifier(Identifier t)
Attachment	addImage()
BodySite	addImage(Attachment t)
CodeableConcept	addQualifier()
BodySite	addQualifier(CodeableConcept t)
BodySite	copy()
boolean	equalsDeep(Base other)
boolean	equalsShallow(Base other)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
CodeableConcept	getCode()
String	getDescription()
StringType	getDescriptionElement()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Attachment>	getImage()
Attachment	getImageFirstRep()
Reference	getPatient()
Patient	getPatientTarget()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getQualifier()
CodeableConcept	getQualifierFirstRep()
ResourceType	getResourceType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasCode()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasIdentifier()
boolean	hasImage()
boolean	hasPatient()
boolean	hasQualifier()
boolean	isEmpty()
protected void	listChildren(List<Property> childrenList)
Base	makeProperty(int hash, String name)
BodySite	setActive(boolean value)
BodySite	setActiveElement(BooleanType value)
BodySite	setCode(CodeableConcept value)
BodySite	setDescription(String value)
BodySite	setDescriptionElement(StringType value)
BodySite	setIdentifier(List<Identifier> theIdentifier)
BodySite	setImage(List<Attachment> theImage)
BodySite	setPatient(Reference value)
BodySite	setPatientTarget(Patient value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
BodySite	setQualifier(List<CodeableConcept> theQualifier)
protected BodySite	typedCopy()

Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource

addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.dstu3.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.dstu3.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

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

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

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

getMeta, getStructureFhirVersionEnum, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

identifier

protected List<Identifier> identifier

Identifier for this instance of the anatomical location.

active

protected BooleanType active

Whether this body site is in active use.

code

protected CodeableConcept code

Named anatomical location - ideally coded where possible.

qualifier

protected List<CodeableConcept> qualifier

Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.

description

protected StringType description

A summary, charactarization or explanation of the anatomic location.

image

protected List<Attachment> image

Image or images used to identify a location.

patient

protected Reference patient

The person to which the body site belongs.

patientTarget

protected Patient patientTarget

The actual object that is the target of the reference (The person to which the body site belongs.)

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

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

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

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

SP_CODE

public static final String SP_CODE

Search parameter: code

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

See Also:

Constant Field Values

CODE

public static final 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: patient

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

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

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

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

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

Constructor Detail

BodySite

public BodySite()

Constructor

BodySite

public BodySite(Reference patient)

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifier for this instance of the anatomical location.)

setIdentifier

public BodySite setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public BodySite addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getActiveElement

public BooleanType getActiveElement()

Returns:

active (Whether this body site is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

hasActiveElement

public boolean hasActiveElement()

hasActive

public boolean hasActive()

setActiveElement

public BodySite setActiveElement(BooleanType value)

Parameters:

value - active (Whether this body site is in active use.). This is the underlying object with id, value and extensions. The accessor "getActive" gives direct access to the value

getActive

public boolean getActive()

Returns:

Whether this body site is in active use.

setActive

public BodySite setActive(boolean value)

Parameters:

value - Whether this body site is in active use.

getCode

public CodeableConcept getCode()

Returns:

code (Named anatomical location - ideally coded where possible.)

hasCode

public boolean hasCode()

setCode

public BodySite setCode(CodeableConcept value)

Parameters:

value - code (Named anatomical location - ideally coded where possible.)

getQualifier

public List<CodeableConcept> getQualifier()

Returns:

qualifier (Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.)

setQualifier

public BodySite setQualifier(List<CodeableConcept> theQualifier)

Returns:

Returns a reference to this for easy method chaining

hasQualifier

public boolean hasQualifier()

addQualifier

public CodeableConcept addQualifier()

addQualifier

public BodySite addQualifier(CodeableConcept t)

getQualifierFirstRep

public CodeableConcept getQualifierFirstRep()

Returns:

The first repetition of repeating field qualifier, creating it if it does not already exist

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (A summary, charactarization or explanation of the anatomic location.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

hasDescriptionElement

public boolean hasDescriptionElement()

hasDescription

public boolean hasDescription()

setDescriptionElement

public BodySite setDescriptionElement(StringType value)

Parameters:

value - description (A summary, charactarization or explanation of the anatomic location.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value

getDescription

public String getDescription()

Returns:

A summary, charactarization or explanation of the anatomic location.

setDescription

public BodySite setDescription(String value)

Parameters:

value - A summary, charactarization or explanation of the anatomic location.

getImage

public List<Attachment> getImage()

Returns:

image (Image or images used to identify a location.)

setImage

public BodySite setImage(List<Attachment> theImage)

Returns:

Returns a reference to this for easy method chaining

hasImage

public boolean hasImage()

addImage

public Attachment addImage()

addImage

public BodySite addImage(Attachment t)

getImageFirstRep

public Attachment getImageFirstRep()

Returns:

The first repetition of repeating field image, creating it if it does not already exist

getPatient

public Reference getPatient()

Returns:

patient (The person to which the body site belongs.)

hasPatient

public boolean hasPatient()

setPatient

public BodySite setPatient(Reference value)

Parameters:

value - patient (The person to which the body site belongs.)

getPatientTarget

public Patient getPatientTarget()

Returns:

patient The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person to which the body site belongs.)

setPatientTarget

public BodySite setPatientTarget(Patient value)

Parameters:

value - patient The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person to which the body site belongs.)

listChildren

protected void listChildren(List<Property> childrenList)

Overrides:

listChildren in class DomainResource

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws FHIRException

Overrides:

getProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws FHIRException

Overrides:

setProperty in class DomainResource

Throws:

FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

FHIRException

addChild

public Base addChild(String name)
              throws FHIRException

Overrides:

addChild in class DomainResource

Throws:

FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public BodySite copy()

Specified by:

copy in class DomainResource

typedCopy

protected BodySite typedCopy()

equalsDeep

public boolean equalsDeep(Base other)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource