BodyStructure (org.hl7.fhir.r4 5.4.0 API)

java.lang.Object
- org.hl7.fhir.r4.model.Base
- - org.hl7.fhir.r4.model.BaseResource
  - - org.hl7.fhir.r4.model.Resource
    - - org.hl7.fhir.r4.model.DomainResource
      - org.hl7.fhir.r4.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

Field Summary

Fields
Modifier and Type	Field and 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<Identifier>`	`identifier` Identifier for this instance of the anatomical structure.
`static 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 ca.uhn.fhir.model.api.Include`	`INCLUDE_PATIENT` Constant for fluent queries to be used to add include statements.
`protected CodeableConcept`	`location` The anatomical location or region of the specimen, lesion, or body structure.
`static ca.uhn.fhir.rest.gclient.TokenClientParam`	`LOCATION` Fluent Client search parameter constant for location
`protected List<CodeableConcept>`	`locationQualifier` Qualifier to refine the anatomical location.
`protected CodeableConcept`	`morphology` The kind of structure being represented by the body structure at `BodyStructure.location`.
`static 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 ca.uhn.fhir.rest.gclient.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.)
`static String`	`SP_IDENTIFIER` Search parameter: identifier
`static String`	`SP_LOCATION` Search parameter: location
`static String`	`SP_MORPHOLOGY` Search parameter: morphology
`static String`	`SP_PATIENT` Search parameter: patient

Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.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

BodyStructure()
Constructor

BodyStructure(Reference patient)
Constructor

Constructors
Constructor and Description
`BodyStructure()` Constructor
`BodyStructure(Reference patient)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Base`	`addChild(String name)`
`Identifier`	`addIdentifier()`
`BodyStructure`	`addIdentifier(Identifier t)`
`Attachment`	`addImage()`
`BodyStructure`	`addImage(Attachment t)`
`CodeableConcept`	`addLocationQualifier()`
`BodyStructure`	`addLocationQualifier(CodeableConcept 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<Identifier>`	`getIdentifier()`
`Identifier`	`getIdentifierFirstRep()`
`List<Attachment>`	`getImage()`
`Attachment`	`getImageFirstRep()`
`CodeableConcept`	`getLocation()`
`List<CodeableConcept>`	`getLocationQualifier()`
`CodeableConcept`	`getLocationQualifierFirstRep()`
`CodeableConcept`	`getMorphology()`
`Property`	`getNamedProperty(int _hash, String _name, boolean _checkValid)`
`Reference`	`getPatient()`
`Patient`	`getPatientTarget()`
`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`	`hasIdentifier()`
`boolean`	`hasImage()`
`boolean`	`hasLocation()`
`boolean`	`hasLocationQualifier()`
`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`	`setIdentifier(List<Identifier> theIdentifier)`
`BodyStructure`	`setImage(List<Attachment> theImage)`
`BodyStructure`	`setLocation(CodeableConcept value)`
`BodyStructure`	`setLocationQualifier(List<CodeableConcept> theLocationQualifier)`
`BodyStructure`	`setMorphology(CodeableConcept value)`
`BodyStructure`	`setPatient(Reference value)`
`BodyStructure`	`setPatientTarget(Patient 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.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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 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.
  - location
```
protected CodeableConcept location
```
    The anatomical location or region of the specimen, lesion, or body structure.
  - locationQualifier
```
protected List<CodeableConcept> locationQualifier
```
    Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.
  - 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.
  - 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: 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_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".
  - SP_LOCATION
```
public static final String SP_LOCATION
```
    Search parameter: location
    Description: Body site
    Type: token
    Path: BodyStructure.location
    
    See Also:
    
    Constant Field Values
  - LOCATION
```
public static final ca.uhn.fhir.rest.gclient.TokenClientParam LOCATION
```
    Fluent Client search parameter constant for location
    Description: Body site
    Type: token
    Path: BodyStructure.location
- Constructor Detail
  - BodyStructure
```
public BodyStructure()
```
    Constructor
  - BodyStructure
```
public BodyStructure(Reference patient)
```
    Constructor
- Method Detail
  - 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
  - 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.)
  - getLocation
```
public CodeableConcept getLocation()
```
    Returns:
    
    location (The anatomical location or region of the specimen, lesion, or body structure.)
  - hasLocation
```
public boolean hasLocation()
```
  - setLocation
```
public BodyStructure setLocation(CodeableConcept value)
```
    Parameters:
    
    value - location (The anatomical location or region of the specimen, lesion, or body structure.)
  - getLocationQualifier
```
public List<CodeableConcept> getLocationQualifier()
```
    Returns:
    
    locationQualifier (Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.)
  - setLocationQualifier
```
public BodyStructure setLocationQualifier(List<CodeableConcept> theLocationQualifier)
```
    Returns:
    
    Returns a reference to this for easy method chaining
  - hasLocationQualifier
```
public boolean hasLocationQualifier()
```
  - addLocationQualifier
```
public CodeableConcept addLocationQualifier()
```
  - addLocationQualifier
```
public BodyStructure addLocationQualifier(CodeableConcept t)
```
  - getLocationQualifierFirstRep
```
public CodeableConcept getLocationQualifierFirstRep()
```
    Returns:
    
    The first repetition of repeating field locationQualifier, creating it if it does not already exist
  - 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
  - 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.)
  - 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 BodyStructure 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> 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

Class BodyStructure

Field Summary

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

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

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

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

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

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

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

Field Detail

identifier

active

morphology

location

locationQualifier

description

image

patient

patientTarget

SP_IDENTIFIER

IDENTIFIER

SP_MORPHOLOGY

MORPHOLOGY

SP_PATIENT

PATIENT

INCLUDE_PATIENT

SP_LOCATION

LOCATION

Constructor Detail

BodyStructure

BodyStructure

Method Detail

getIdentifier

setIdentifier

hasIdentifier

addIdentifier

addIdentifier

getIdentifierFirstRep

getActiveElement

hasActiveElement

hasActive

setActiveElement

getActive

setActive

getMorphology

hasMorphology

setMorphology

getLocation

hasLocation

setLocation

getLocationQualifier

setLocationQualifier

hasLocationQualifier

addLocationQualifier

addLocationQualifier

getLocationQualifierFirstRep

getDescriptionElement

hasDescriptionElement

hasDescription

setDescriptionElement

getDescription

setDescription

getImage

setImage

hasImage

addImage

addImage

getImageFirstRep

getPatient

hasPatient

setPatient

getPatientTarget

setPatientTarget