Package com.ibm.fhir.model.resource
Class BodyStructure
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.BodyStructure
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") 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.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBodyStructure.Builder
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static BodyStructure.Builderbuilder()booleanequals(Object obj)BooleangetActive()Whether this body site is in active use.StringgetDescription()A summary, characterization or explanation of the body structure.List<Identifier>getIdentifier()Identifier for this instance of the anatomical structure.List<Attachment>getImage()Image or images used to identify a location.CodeableConceptgetLocation()The anatomical location or region of the specimen, lesion, or body structure.List<CodeableConcept>getLocationQualifier()Qualifier to refine the anatomical location.CodeableConceptgetMorphology()The kind of structure being represented by the body structure at `BodyStructure.location`.ReferencegetPatient()The person to which the body site belongs.booleanhasChildren()inthashCode()BodyStructure.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
Identifier for this instance of the anatomical structure.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getActive
public Boolean getActive()
Whether this body site is in active use.- Returns:
- An immutable object of type
Booleanthat may be null.
-
getMorphology
public CodeableConcept getMorphology()
The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getLocation
public CodeableConcept getLocation()
The anatomical location or region of the specimen, lesion, or body structure.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getLocationQualifier
public List<CodeableConcept> getLocationQualifier()
Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getDescription
public String getDescription()
A summary, characterization or explanation of the body structure.- Returns:
- An immutable object of type
Stringthat may be null.
-
getImage
public List<Attachment> getImage()
Image or images used to identify a location.- Returns:
- An unmodifiable list containing immutable objects of type
Attachmentthat may be empty.
-
getPatient
public Reference getPatient()
The person to which the body site belongs.- Returns:
- An immutable object of type
Referencethat is non-null.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public BodyStructure.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static BodyStructure.Builder builder()
-
-