Private OptionalidentifierInventoryItem.identifier Element
Private ReadonlyinventoryitemFHIR CodeSystem: InventoryitemStatus
PrivatestatusInventoryItem.status Element
FHIR Specification
codeCodeSystem Enumeration: InventoryitemStatusEnum
Private OptionalcategoryInventoryItem.category Element
Private OptionalcodeInventoryItem.code Element
Private OptionalnameInventoryItem.name Element
Private OptionalresponsibleInventoryItem.responsibleOrganization Element
Private OptionaldescriptionInventoryItem.description Element
Private OptionalinventoryInventoryItem.inventoryStatus Element
FHIR Specification
CodeableConceptPrivate OptionalbaseInventoryItem.baseUnit Element
Private OptionalnetInventoryItem.netContent Element
Private OptionalassociationInventoryItem.association Element
Private OptionalcharacteristicInventoryItem.characteristic Element
Private Optionalinstance_InventoryItem.instance Element
Private OptionalproductInventoryItem.productReference Element
StaticparseParse the provided InventoryItem JSON to instantiate the InventoryItem data model.
JSON representing FHIR InventoryItem
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to InventoryItem
InventoryItem data model or undefined for InventoryItem
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: InventoryitemStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: InventoryitemStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: InventoryitemStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: InventoryitemStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: InventoryitemStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: InventoryitemStatusEnum
true if the status property exists and has a value; false otherwise
the category property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the category property.
the category array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the category array property.
the category value
this
InvalidTypeError for invalid data types
true if the category property exists and has a value; false otherwise
the code property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the code property.
the code array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the code array property.
the code value
this
InvalidTypeError for invalid data types
true if the code property exists and has a value; false otherwise
the name property value as a InventoryItemNameComponent array
Assigns the provided InventoryItemNameComponent array value to the name property.
the name array value
this
InvalidTypeError for invalid data types
Add the provided InventoryItemNameComponent value to the name array property.
the name value
this
InvalidTypeError for invalid data types
true if the name property exists and has a value; false otherwise
the responsibleOrganization property value as a InventoryItemResponsibleOrganizationComponent array
Assigns the provided InventoryItemResponsibleOrganizationComponent array value to the responsibleOrganization property.
the responsibleOrganization array value
this
InvalidTypeError for invalid data types
Add the provided InventoryItemResponsibleOrganizationComponent value to the responsibleOrganization array property.
the responsibleOrganization value
this
InvalidTypeError for invalid data types
true if the responsibleOrganization property exists and has a value; false otherwise
the description property value as a InventoryItemDescriptionComponent object if defined; else an empty InventoryItemDescriptionComponent object
Assigns the provided Description object value to the description property.
the description object value
this
InvalidTypeError for invalid data types
true if the description property exists and has a value; false otherwise
the inventoryStatus property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the inventoryStatus property.
the inventoryStatus array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the inventoryStatus array property.
the inventoryStatus value
this
InvalidTypeError for invalid data types
true if the inventoryStatus property exists and has a value; false otherwise
the baseUnit property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided BaseUnit object value to the baseUnit property.
the baseUnit object value
this
InvalidTypeError for invalid data types
true if the baseUnit property exists and has a value; false otherwise
the netContent property value as a Quantity object if defined; else an empty Quantity object
Assigns the provided NetContent object value to the netContent property.
the netContent object value
this
InvalidTypeError for invalid data types
true if the netContent property exists and has a value; false otherwise
the association property value as a InventoryItemAssociationComponent array
Assigns the provided InventoryItemAssociationComponent array value to the association property.
the association array value
this
InvalidTypeError for invalid data types
Add the provided InventoryItemAssociationComponent value to the association array property.
the association value
this
InvalidTypeError for invalid data types
true if the association property exists and has a value; false otherwise
the characteristic property value as a InventoryItemCharacteristicComponent array
Assigns the provided InventoryItemCharacteristicComponent array value to the characteristic property.
the characteristic array value
this
InvalidTypeError for invalid data types
Add the provided InventoryItemCharacteristicComponent value to the characteristic array property.
the characteristic value
this
InvalidTypeError for invalid data types
true if the characteristic property exists and has a value; false otherwise
the instance_ property value as a InventoryItemInstanceComponent object if defined; else an empty InventoryItemInstanceComponent object
Assigns the provided Instance object value to the instance_ property.
the instance_ object value
this
InvalidTypeError for invalid data types
true if the instance_ property exists and has a value; false otherwise
the productReference property value as a Reference object; else an empty Reference object
Assigns the provided ProductReference object value to the productReference property.
the productReference object value
this
@ReferenceTargets('InventoryItem.productReference', ['Medication','Device','NutritionProduct','BiologicallyDerivedProduct',])
InvalidTypeError for invalid data type or reference value
true if the productReference property exists and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
PrivateinitInitialize the identifier property
PrivateinitInitialize the category property
PrivateinitInitialize the code property
PrivateinitInitialize the name property
PrivateinitInitialize the responsibleOrganization property
PrivateinitInitialize the inventoryStatus property
PrivateinitInitialize the association property
PrivateinitInitialize the characteristic property
InventoryItem Class
Remarks
functional description of an inventory item used in inventory and supply-related workflows.
FHIR Specification
See
FHIR InventoryItem