Class InventoryItem
- 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 class
static class
static class
static class
static class
static class
static enum
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
Modifier and TypeFieldDescriptionAssociation with other items or products.protected CodeableConcept
The base unit of measure - the unit in which the product is used or counted.protected List
<CodeableConcept> Category or class of the item.The descriptive or identifying characteristics of the item.protected List
<CodeableConcept> Code designating the specific type of item.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeThe descriptive characteristics of the inventory item.protected List
<Identifier> Business identifier for the inventory item.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.Instances or occurrences of the product.protected List
<CodeableConcept> The usage status e.g.protected List
<InventoryItem.InventoryItemNameComponent> The item name(s) - the brand name, or common name, functional name, generic name.protected Quantity
Net content or amount present in the item.protected Reference
Link to a product resource used in clinical workflows.Organization(s) responsible for the product.static final String
Search parameter: codestatic final String
Search parameter: identifierstatic final String
Search parameter: statusstatic final String
Search parameter: subjectStatus of the item entry.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 subjectFields 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, 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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddCode()
addName()
copy()
void
copyValues
(InventoryItem dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getName()
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
hasCode()
boolean
boolean
boolean
boolean
boolean
hasName()
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setAssociation
(List<InventoryItem.InventoryItemAssociationComponent> theAssociation) setBaseUnit
(CodeableConcept value) setCategory
(List<CodeableConcept> theCategory) setCharacteristic
(List<InventoryItem.InventoryItemCharacteristicComponent> theCharacteristic) setCode
(List<CodeableConcept> theCode) setIdentifier
(List<Identifier> theIdentifier) setInventoryStatus
(List<CodeableConcept> theInventoryStatus) setNetContent
(Quantity value) setProductReference
(Reference value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setResponsibleOrganization
(List<InventoryItem.InventoryItemResponsibleOrganizationComponent> theResponsibleOrganization) protected InventoryItem
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPath
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, 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
Business identifier for the inventory item. -
status
Status of the item entry. -
category
Category or class of the item. -
code
Code designating the specific type of item. -
name
The item name(s) - the brand name, or common name, functional name, generic name. -
responsibleOrganization
Organization(s) responsible for the product. -
description
The descriptive characteristics of the inventory item. -
inventoryStatus
The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etc. -
baseUnit
The base unit of measure - the unit in which the product is used or counted. -
netContent
Net content or amount present in the item. -
association
Association with other items or products. -
characteristic
The descriptive or identifying characteristics of the item. -
instance
Instances or occurrences of the product. -
productReference
Link to a product resource used in clinical workflows. -
SP_CODE
Search parameter: codeDescription: Search for products that match this code
Type: token
Path: InventoryItem.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Search for products that match this code
Type: token
Path: InventoryItem.code
-
SP_IDENTIFIER
Search parameter: identifierDescription: The identifier of the item
Type: token
Path: InventoryItem.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identifier of the item
Type: token
Path: InventoryItem.identifier
-
SP_STATUS
Search parameter: statusDescription: The status of the item
Type: token
Path: InventoryItem.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: The status of the item
Type: token
Path: InventoryItem.status
-
SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient for whom to list associations
Type: reference
Path: InventoryItem.instance.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of a patient for whom to list associations
Type: reference
Path: InventoryItem.instance.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "InventoryItem:subject".
-
-
Constructor Details
-
InventoryItem
public InventoryItem()Constructor -
InventoryItem
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for the inventory item.)
-
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 {3}
-
getStatusElement
- Returns:
status
(Status of the item entry.). 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
(Status of the item entry.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- Status of the item entry.
-
setStatus
- Parameters:
value
- Status of the item entry.
-
getCategory
- Returns:
category
(Category or class of the item.)
-
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 {3}
-
getCode
- Returns:
code
(Code designating the specific type of item.)
-
setCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCode
-
addCode
-
addCode
-
getCodeFirstRep
- Returns:
- The first repetition of repeating field
code
, creating it if it does not already exist {3}
-
getName
- Returns:
name
(The item name(s) - the brand name, or common name, functional name, generic name.)
-
setName
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasName
-
addName
-
addName
-
getNameFirstRep
- Returns:
- The first repetition of repeating field
name
, creating it if it does not already exist {3}
-
getResponsibleOrganization
public List<InventoryItem.InventoryItemResponsibleOrganizationComponent> getResponsibleOrganization()- Returns:
responsibleOrganization
(Organization(s) responsible for the product.)
-
setResponsibleOrganization
public InventoryItem setResponsibleOrganization(List<InventoryItem.InventoryItemResponsibleOrganizationComponent> theResponsibleOrganization) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasResponsibleOrganization
-
addResponsibleOrganization
-
addResponsibleOrganization
-
getResponsibleOrganizationFirstRep
public InventoryItem.InventoryItemResponsibleOrganizationComponent getResponsibleOrganizationFirstRep()- Returns:
- The first repetition of repeating field
responsibleOrganization
, creating it if it does not already exist {3}
-
getDescription
- Returns:
description
(The descriptive characteristics of the inventory item.)
-
hasDescription
-
setDescription
- Parameters:
value
-description
(The descriptive characteristics of the inventory item.)
-
getInventoryStatus
- Returns:
inventoryStatus
(The usage status e.g. recalled, in use, discarded... This can be used to indicate that the items have been taken out of inventory, or are in use, etc.)
-
setInventoryStatus
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInventoryStatus
-
addInventoryStatus
-
addInventoryStatus
-
getInventoryStatusFirstRep
- Returns:
- The first repetition of repeating field
inventoryStatus
, creating it if it does not already exist {3}
-
getBaseUnit
- Returns:
baseUnit
(The base unit of measure - the unit in which the product is used or counted.)
-
hasBaseUnit
-
setBaseUnit
- Parameters:
value
-baseUnit
(The base unit of measure - the unit in which the product is used or counted.)
-
getNetContent
- Returns:
netContent
(Net content or amount present in the item.)
-
hasNetContent
-
setNetContent
- Parameters:
value
-netContent
(Net content or amount present in the item.)
-
getAssociation
- Returns:
association
(Association with other items or products.)
-
setAssociation
public InventoryItem setAssociation(List<InventoryItem.InventoryItemAssociationComponent> theAssociation) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasAssociation
-
addAssociation
-
addAssociation
-
getAssociationFirstRep
- Returns:
- The first repetition of repeating field
association
, creating it if it does not already exist {3}
-
getCharacteristic
- Returns:
characteristic
(The descriptive or identifying characteristics of the item.)
-
setCharacteristic
public InventoryItem setCharacteristic(List<InventoryItem.InventoryItemCharacteristicComponent> theCharacteristic) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasCharacteristic
-
addCharacteristic
-
addCharacteristic
-
getCharacteristicFirstRep
- Returns:
- The first repetition of repeating field
characteristic
, creating it if it does not already exist {3}
-
getInstance
- Returns:
instance
(Instances or occurrences of the product.)
-
hasInstance
-
setInstance
- Parameters:
value
-instance
(Instances or occurrences of the product.)
-
getProductReference
- Returns:
productReference
(Link to a product resource used in clinical workflows.)
-
hasProductReference
-
setProductReference
- Parameters:
value
-productReference
(Link to a product resource used in clinical workflows.)
-
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
- Returns:
- the FHIR type name of the instance (not the java class name)
-
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
-