Class Substance
- 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
static class
static class
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected List
<CodeableConcept> A code that classifies the general type of substance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected CodeableConcept
A code (or set of codes) that identify this substance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for container-identifierprotected StringType
A description of the substance - its appearance, handling requirements, and other usage notes.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for expiryprotected List
<Identifier> Unique identifier for the substance.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected List
<Substance.SubstanceIngredientComponent> A substance can be composed of other substances.protected List
<Substance.SubstanceInstanceComponent> Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.static final ca.uhn.fhir.rest.gclient.QuantityClientParam
Fluent Client search parameter constant for quantitystatic final String
Search parameter: categorystatic final String
Search parameter: codestatic final String
Search parameter: container-identifierstatic final String
Search parameter: expirystatic final String
Search parameter: identifierstatic final String
Search parameter: quantitystatic final String
Search parameter: statusstatic final String
Search parameter: substance-referenceprotected Enumeration
<Substance.FHIRSubstanceStatus> A code to indicate if the substance is actively used.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for substance-referenceFields 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 TypeMethodDescriptioncopy()
void
copyValues
(Substance dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getNamedProperty
(int _hash, String _name, boolean _checkValid) Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCategory
(List<CodeableConcept> theCategory) setCode
(CodeableConcept value) setDescription
(String value) setDescriptionElement
(StringType value) setIdentifier
(List<Identifier> theIdentifier) setIngredient
(List<Substance.SubstanceIngredientComponent> theIngredient) setInstance
(List<Substance.SubstanceInstanceComponent> theInstance) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) protected Substance
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
Unique identifier for the substance. -
status
A code to indicate if the substance is actively used. -
category
A code that classifies the general type of substance. This is used for searching, sorting and display purposes. -
code
A code (or set of codes) that identify this substance. -
description
A description of the substance - its appearance, handling requirements, and other usage notes. -
instance
Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance. -
ingredient
A substance can be composed of other substances. -
SP_IDENTIFIER
Search parameter: identifierDescription: Unique identifier for the substance
Type: token
Path: Substance.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Unique identifier for the substance
Type: token
Path: Substance.identifier
-
SP_CONTAINER_IDENTIFIER
Search parameter: container-identifierDescription: Identifier of the package/container
Type: token
Path: Substance.instance.identifier
- See Also:
-
CONTAINER_IDENTIFIER
Fluent Client search parameter constant for container-identifierDescription: Identifier of the package/container
Type: token
Path: Substance.instance.identifier
-
SP_CODE
Search parameter: codeDescription: The code of the substance or ingredient
Type: token
Path: Substance.code, Substance.ingredient.substanceCodeableConcept
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: The code of the substance or ingredient
Type: token
Path: Substance.code, Substance.ingredient.substanceCodeableConcept
-
SP_QUANTITY
Search parameter: quantityDescription: Amount of substance in the package
Type: quantity
Path: Substance.instance.quantity
- See Also:
-
QUANTITY
Fluent Client search parameter constant for quantityDescription: Amount of substance in the package
Type: quantity
Path: Substance.instance.quantity
-
SP_SUBSTANCE_REFERENCE
Search parameter: substance-referenceDescription: A component of the substance
Type: reference
Path: Substance.ingredient.substanceReference
- See Also:
-
SUBSTANCE_REFERENCE
Fluent Client search parameter constant for substance-referenceDescription: A component of the substance
Type: reference
Path: Substance.ingredient.substanceReference
-
INCLUDE_SUBSTANCE_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Substance:substance-reference". -
SP_EXPIRY
Search parameter: expiryDescription: Expiry date of package or container of substance
Type: date
Path: Substance.instance.expiry
- See Also:
-
EXPIRY
Fluent Client search parameter constant for expiryDescription: Expiry date of package or container of substance
Type: date
Path: Substance.instance.expiry
-
SP_CATEGORY
Search parameter: categoryDescription: The category of the substance
Type: token
Path: Substance.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: The category of the substance
Type: token
Path: Substance.category
-
SP_STATUS
Search parameter: statusDescription: active | inactive | entered-in-error
Type: token
Path: Substance.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: active | inactive | entered-in-error
Type: token
Path: Substance.status
-
-
Constructor Details
-
Substance
public Substance()Constructor -
Substance
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Unique identifier for the substance.)
-
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
-
getStatusElement
- Returns:
status
(A code to indicate if the substance is actively used.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(A code to indicate if the substance is actively used.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- A code to indicate if the substance is actively used.
-
setStatus
- Parameters:
value
- A code to indicate if the substance is actively used.
-
getCategory
- Returns:
category
(A code that classifies the general type of substance. This is used for searching, sorting and display purposes.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
getCode
- Returns:
code
(A code (or set of codes) that identify this substance.)
-
hasCode
-
setCode
- Parameters:
value
-code
(A code (or set of codes) that identify this substance.)
-
getDescriptionElement
- Returns:
description
(A description of the substance - its appearance, handling requirements, and other usage notes.). 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 description of the substance - its appearance, handling requirements, and other usage notes.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- A description of the substance - its appearance, handling requirements, and other usage notes.
-
setDescription
- Parameters:
value
- A description of the substance - its appearance, handling requirements, and other usage notes.
-
getInstance
- Returns:
instance
(Substance may be used to describe a kind of substance, or a specific package/container of the substance: an instance.)
-
setInstance
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstance
-
addInstance
-
addInstance
-
getInstanceFirstRep
- Returns:
- The first repetition of repeating field
instance
, creating it if it does not already exist
-
getIngredient
- Returns:
ingredient
(A substance can be composed of other substances.)
-
setIngredient
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIngredient
-
addIngredient
-
addIngredient
-
getIngredientFirstRep
- Returns:
- The first repetition of repeating field
ingredient
, creating it if it does not already exist
-
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
-