Package org.hl7.fhir.r4.model
Class BodyStructure
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
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:
-
Field Summary
Modifier and TypeFieldDescriptionprotected BooleanType
Whether this body site is in active use.protected StringType
A summary, characterization or explanation of the body structure.protected List
<Identifier> Identifier for this instance of the anatomical structure.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierprotected List
<Attachment> Image or images used to identify a location.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected CodeableConcept
The anatomical location or region of the specimen, lesion, or body structure.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for locationprotected List
<CodeableConcept> Qualifier to refine the anatomical location.protected CodeableConcept
The kind of structure being represented by the body structure at `BodyStructure.location`.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for morphologyprotected Reference
The person to which the body site belongs.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Patient
The actual object that is the target of the reference (The person to which the body site belongs.)static final String
Search parameter: identifierstatic final String
Search parameter: locationstatic final String
Search parameter: morphologystatic final String
Search parameter: patientFields 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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionaddImage()
copy()
void
copyValues
(BodyStructure dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
boolean
getImage()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
hasImage()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setActive
(boolean value) setActiveElement
(BooleanType value) setDescription
(String value) setDescriptionElement
(StringType value) setIdentifier
(List<Identifier> theIdentifier) setImage
(List<Attachment> theImage) setLocation
(CodeableConcept value) setLocationQualifier
(List<CodeableConcept> theLocationQualifier) setMorphology
(CodeableConcept value) setPatient
(Reference value) setPatientTarget
(Patient value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) protected BodyStructure
Methods inherited from class org.hl7.fhir.r4.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.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, 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, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, 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.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifier for this instance of the anatomical structure. -
active
Whether this body site is in active use. -
morphology
The kind of structure being represented by the body structure at `BodyStructure.location`. This can define both normal and abnormal morphologies. -
location
The anatomical location or region of the specimen, lesion, or body structure. -
locationQualifier
Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane. -
description
A summary, characterization or explanation of the body structure. -
image
Image or images used to identify a location. -
patient
The person to which the body site belongs. -
patientTarget
The actual object that is the target of the reference (The person to which the body site belongs.) -
SP_IDENTIFIER
Search parameter: identifierDescription: Bodystructure identifier
Type: token
Path: BodyStructure.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Bodystructure identifier
Type: token
Path: BodyStructure.identifier
-
SP_MORPHOLOGY
Search parameter: morphologyDescription: Kind of Structure
Type: token
Path: BodyStructure.morphology
- See Also:
-
MORPHOLOGY
Fluent Client search parameter constant for morphologyDescription: Kind of Structure
Type: token
Path: BodyStructure.morphology
-
SP_PATIENT
Search parameter: patientDescription: Who this is about
Type: reference
Path: BodyStructure.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Who this is about
Type: reference
Path: BodyStructure.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "BodyStructure:patient". -
SP_LOCATION
Search parameter: locationDescription: Body site
Type: token
Path: BodyStructure.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Body site
Type: token
Path: BodyStructure.location
-
-
Constructor Details
-
BodyStructure
public BodyStructure()Constructor -
BodyStructure
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier for this instance of the anatomical structure.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
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
-
hasActive
-
setActiveElement
- 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
- Returns:
- Whether this body site is in active use.
-
setActive
- Parameters:
value
- Whether this body site is in active use.
-
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
-
setMorphology
- 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
- Returns:
location
(The anatomical location or region of the specimen, lesion, or body structure.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(The anatomical location or region of the specimen, lesion, or body structure.)
-
getLocationQualifier
- Returns:
locationQualifier
(Qualifier to refine the anatomical location. These include qualifiers for laterality, relative location, directionality, number, and plane.)
-
setLocationQualifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasLocationQualifier
-
addLocationQualifier
-
addLocationQualifier
-
getLocationQualifierFirstRep
- Returns:
- The first repetition of repeating field
locationQualifier
, creating it if it does not already exist
-
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
-
hasDescription
-
setDescriptionElement
- 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
- Returns:
- A summary, characterization or explanation of the body structure.
-
setDescription
- Parameters:
value
- A summary, characterization or explanation of the body structure.
-
getImage
- Returns:
image
(Image or images used to identify a location.)
-
setImage
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasImage
-
addImage
-
addImage
-
getImageFirstRep
- Returns:
- The first repetition of repeating field
image
, creating it if it does not already exist
-
getPatient
- Returns:
patient
(The person to which the body site belongs.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(The person to which the body site belongs.)
-
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
- 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
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-