Package org.hl7.fhir.r5.model

Class BodyStructure

java.lang.Object

org.hl7.fhir.r5.model.Base

org.hl7.fhir.r5.model.BaseResource

org.hl7.fhir.r5.model.Resource

org.hl7.fhir.r5.model.DomainResource

org.hl7.fhir.r5.model.BodyStructure

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class BodyStructure
extends DomainResource

Record details about an anatomical structure. This resource may be used when a coded concept does not provide the necessary detail needed for the use case.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BodyStructure.BodyStructureExcludedStructureComponent
static class	BodyStructure.BodyStructureIncludedStructureComponent

Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base

Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason

Field Summary

Fields

Modifier and Type	Field	Description
protected BooleanType	active	Whether this body site is in active use.
protected StringType	description	A summary, characterization or explanation of the body structure.
protected List<BodyStructure.BodyStructureExcludedStructureComponent>	excludedStructure	The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	EXCLUDEDSTRUCTURE	Fluent Client search parameter constant for excluded_structure
protected List<Identifier>	identifier	Identifier for this instance of the anatomical structure.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
protected List<Attachment>	image	Image or images used to identify a location.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
protected List<BodyStructure.BodyStructureIncludedStructureComponent>	includedStructure	The anatomical location(s) or region(s) of the specimen, lesion, or body structure.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	INCLUDEDSTRUCTURE	Fluent Client search parameter constant for included_structure
protected CodeableConcept	morphology	The kind of structure being represented by the body structure at `BodyStructure.location`.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	MORPHOLOGY	Fluent Client search parameter constant for morphology
protected Reference	patient	The person to which the body site belongs.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
static final String	SP_EXCLUDEDSTRUCTURE	Search parameter: excluded_structure
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_INCLUDEDSTRUCTURE	Search parameter: included_structure
static final String	SP_MORPHOLOGY	Search parameter: morphology
static final String	SP_PATIENT	Search parameter: patient

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

contained, extension, modifierExtension, SP_TEXT, text, TEXT

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

id, implicitRules, language, meta

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

RES_ID, SP_RES_ID

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
BodyStructure()	Constructor
BodyStructure(BodyStructure.BodyStructureIncludedStructureComponent includedStructure, Reference patient)	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
BodyStructure.BodyStructureExcludedStructureComponent	addExcludedStructure()
BodyStructure	addExcludedStructure(BodyStructure.BodyStructureExcludedStructureComponent t)
Identifier	addIdentifier()
BodyStructure	addIdentifier(Identifier t)
Attachment	addImage()
BodyStructure	addImage(Attachment t)
BodyStructure.BodyStructureIncludedStructureComponent	addIncludedStructure()
BodyStructure	addIncludedStructure(BodyStructure.BodyStructureIncludedStructureComponent t)
BodyStructure	copy()
void	copyValues(BodyStructure dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
boolean	getActive()
BooleanType	getActiveElement()
String	getDescription()
StringType	getDescriptionElement()
List<BodyStructure.BodyStructureExcludedStructureComponent>	getExcludedStructure()
BodyStructure.BodyStructureExcludedStructureComponent	getExcludedStructureFirstRep()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<Attachment>	getImage()
Attachment	getImageFirstRep()
List<BodyStructure.BodyStructureIncludedStructureComponent>	getIncludedStructure()
BodyStructure.BodyStructureIncludedStructureComponent	getIncludedStructureFirstRep()
CodeableConcept	getMorphology()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Reference	getPatient()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
String[]	getTypesForProperty(int hash, String name)
boolean	hasActive()
boolean	hasActiveElement()
boolean	hasDescription()
boolean	hasDescriptionElement()
boolean	hasExcludedStructure()
boolean	hasIdentifier()
boolean	hasImage()
boolean	hasIncludedStructure()
boolean	hasMorphology()
boolean	hasPatient()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
BodyStructure	setActive(boolean value)
BodyStructure	setActiveElement(BooleanType value)
BodyStructure	setDescription(String value)
BodyStructure	setDescriptionElement(StringType value)
BodyStructure	setExcludedStructure(List<BodyStructure.BodyStructureExcludedStructureComponent> theExcludedStructure)
BodyStructure	setIdentifier(List<Identifier> theIdentifier)
BodyStructure	setImage(List<Attachment> theImage)
BodyStructure	setIncludedStructure(List<BodyStructure.BodyStructureIncludedStructureComponent> theIncludedStructure)
BodyStructure	setMorphology(CodeableConcept value)
BodyStructure	setPatient(Reference value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
protected BodyStructure	typedCopy()

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

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

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

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

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

getStructureFhirVersionEnum, isResource, setId

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

addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, setId

Field Details

identifier

protected List<Identifier> identifier

Identifier for this instance of the anatomical structure.

active

protected BooleanType active

Whether this body site is in active use.

morphology

protected CodeableConcept morphology

The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.

includedStructure

protected List<BodyStructure.BodyStructureIncludedStructureComponent> includedStructure

The anatomical location(s) or region(s) of the specimen, lesion, or body structure.

excludedStructure

protected List<BodyStructure.BodyStructureExcludedStructureComponent> excludedStructure

The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.

description

protected StringType description

A summary, characterization or explanation of the body structure.

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.

SP_EXCLUDEDSTRUCTURE

public static final String SP_EXCLUDEDSTRUCTURE

Search parameter: excluded_structure

Description: Body site excludedStructure structure
Type: token
Path: BodyStructure.excludedStructure.structure

See Also:

• Constant Field Values

EXCLUDEDSTRUCTURE

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

Fluent Client search parameter constant for excluded_structure

Description: Body site excludedStructure structure
Type: token
Path: BodyStructure.excludedStructure.structure

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Bodystructure identifier
Type: token
Path: BodyStructure.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: Bodystructure identifier
Type: token
Path: BodyStructure.identifier

SP_INCLUDEDSTRUCTURE

public static final String SP_INCLUDEDSTRUCTURE

Search parameter: included_structure

Description: Body site includedStructure structure
Type: token
Path: BodyStructure.includedStructure.structure

See Also:

• Constant Field Values

INCLUDEDSTRUCTURE

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

Fluent Client search parameter constant for included_structure

Description: Body site includedStructure structure
Type: token
Path: BodyStructure.includedStructure.structure

SP_MORPHOLOGY

public static final String SP_MORPHOLOGY

Search parameter: morphology

Description: Kind of Structure
Type: token
Path: BodyStructure.morphology

See Also:

• Constant Field Values

MORPHOLOGY

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

Fluent Client search parameter constant for morphology

Description: Kind of Structure
Type: token
Path: BodyStructure.morphology

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Who this is about
Type: reference
Path: BodyStructure.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: Who this is about
Type: reference
Path: BodyStructure.patient

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 "BodyStructure:patient".

Constructor Details

BodyStructure

public BodyStructure()

Constructor

BodyStructure

public BodyStructure(BodyStructure.BodyStructureIncludedStructureComponent includedStructure,
 Reference patient)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

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

setIdentifier

public BodyStructure setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public BodyStructure addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

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 BodyStructure 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 BodyStructure setActive(boolean value)

Parameters:

value - Whether this body site is in active use.

getMorphology

public CodeableConcept getMorphology()

Returns:

morphology (The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.)

hasMorphology

public boolean hasMorphology()

setMorphology

public BodyStructure setMorphology(CodeableConcept value)

Parameters:

value - morphology (The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.)

getIncludedStructure

public List<BodyStructure.BodyStructureIncludedStructureComponent> getIncludedStructure()

Returns:

includedStructure (The anatomical location(s) or region(s) of the specimen, lesion, or body structure.)

setIncludedStructure

public BodyStructure setIncludedStructure(List<BodyStructure.BodyStructureIncludedStructureComponent> theIncludedStructure)

Returns:

Returns a reference to this for easy method chaining

hasIncludedStructure

public boolean hasIncludedStructure()

addIncludedStructure

public BodyStructure.BodyStructureIncludedStructureComponent addIncludedStructure()

addIncludedStructure

public BodyStructure addIncludedStructure(BodyStructure.BodyStructureIncludedStructureComponent t)

getIncludedStructureFirstRep

public BodyStructure.BodyStructureIncludedStructureComponent getIncludedStructureFirstRep()

Returns:

The first repetition of repeating field includedStructure, creating it if it does not already exist {3}

getExcludedStructure

public List<BodyStructure.BodyStructureExcludedStructureComponent> getExcludedStructure()

Returns:

excludedStructure (The anatomical location(s) or region(s) not occupied or represented by the specimen, lesion, or body structure.)

setExcludedStructure

public BodyStructure setExcludedStructure(List<BodyStructure.BodyStructureExcludedStructureComponent> theExcludedStructure)

Returns:

Returns a reference to this for easy method chaining

hasExcludedStructure

public boolean hasExcludedStructure()

addExcludedStructure

public BodyStructure.BodyStructureExcludedStructureComponent addExcludedStructure()

addExcludedStructure

public BodyStructure addExcludedStructure(BodyStructure.BodyStructureExcludedStructureComponent t)

getExcludedStructureFirstRep

public BodyStructure.BodyStructureExcludedStructureComponent getExcludedStructureFirstRep()

Returns:

The first repetition of repeating field excludedStructure, creating it if it does not already exist {3}

getDescriptionElement

public StringType getDescriptionElement()

Returns:

description (A summary, characterization or explanation of the body structure.). 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 BodyStructure setDescriptionElement(StringType value)

Parameters:

value - description (A summary, characterization or explanation of the body structure.). 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, characterization or explanation of the body structure.

setDescription

public BodyStructure setDescription(String value)

Parameters:

value - A summary, characterization or explanation of the body structure.

getImage

public List<Attachment> getImage()

Returns:

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

setImage

public BodyStructure setImage(List<Attachment> theImage)

Returns:

Returns a reference to this for easy method chaining

hasImage

public boolean hasImage()

addImage

public Attachment addImage()

addImage

public BodyStructure addImage(Attachment t)

getImageFirstRep

public Attachment getImageFirstRep()

Returns:

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

getPatient

public Reference getPatient()

Returns:

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

hasPatient

public boolean hasPatient()

setPatient

public BodyStructure setPatient(Reference value)

Parameters:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
 String _name,
 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
 String name,
 boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
 String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
 Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
 String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
 String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

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

Overrides:

fhirType in class DomainResource

copy

public BodyStructure copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(BodyStructure dst)

typedCopy

protected BodyStructure 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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource