
Package org.hl7.fhir.r5.model
Class DeviceDispense
java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.DeviceDispense
- 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
Indicates that a device is to be or has been dispensed for a named person/patient. This includes a description of the product (supply) provided and the instructions for using the device.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic 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
FieldsModifier and TypeFieldDescriptionThe order or request that this dispense is fulfilling.protected List<CodeableConcept>
Indicates the type of device dispense.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected Reference
Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.protected CodeableReference
Identifies the device being dispensed.protected Reference
The encounter that establishes the context for this event.A summary of the events of interest that have occurred, such as when the dispense was verified.protected List<Identifier>
Business identifier for this dispensation.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Reference
The principal physical location where the dispense was performed.protected List<Annotation>
Extra information about the dispense that could not be conveyed in the other attributes.The bigger event that this dispense is a part of.Indicates who or what performed the event.protected DateTimeType
The time when the dispensed product was packaged and reviewed.protected Quantity
The number of devices that have been dispensed.static final String
Search parameter: codestatic final String
Search parameter: subjectA code specifying the state of the set of dispense events.protected CodeableReference
Indicates the reason why a dispense was or was not performed.protected Reference
A link to a resource representing the person to whom the device is intended.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectAdditional information that supports the device being dispensed.protected CodeableConcept
Indicates the type of dispensing event that is performed.protected StringType
The full representation of the instructions.protected DateTimeType
The time the dispensed product was made available to the patient or their representative.Fields 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, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorDeviceDispense
(DeviceDispense.DeviceDispenseStatusCodes status, CodeableReference device, Reference subject) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()
copy()
void
copyValues
(DeviceDispense dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) getType()
String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasType()
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setBasedOn
(List<Reference> theBasedOn) setCategory
(List<CodeableConcept> theCategory) setDestination
(Reference value) setDevice
(CodeableReference value) setEncounter
(Reference value) setEventHistory
(List<Reference> theEventHistory) setIdentifier
(List<Identifier> theIdentifier) setLocation
(Reference value) setNote
(List<Annotation> theNote) setPerformer
(List<DeviceDispense.DeviceDispensePerformerComponent> thePerformer) setPreparedDate
(Date value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setQuantity
(Quantity value) setStatusReason
(CodeableReference value) setSubject
(Reference value) setSupportingInformation
(List<Reference> theSupportingInformation) setType
(CodeableConcept value) setUsageInstruction
(String value) setWhenHandedOver
(Date value) protected DeviceDispense
Methods inherited from class org.hl7.fhir.r5.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.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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, setId
-
Field Details
-
identifier
Business identifier for this dispensation. -
basedOn
The order or request that this dispense is fulfilling. -
partOf
The bigger event that this dispense is a part of. -
status
A code specifying the state of the set of dispense events. -
statusReason
Indicates the reason why a dispense was or was not performed. -
category
Indicates the type of device dispense. -
device
Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices. -
subject
A link to a resource representing the person to whom the device is intended. -
encounter
The encounter that establishes the context for this event. -
supportingInformation
Additional information that supports the device being dispensed. -
performer
Indicates who or what performed the event. -
location
The principal physical location where the dispense was performed. -
type
Indicates the type of dispensing event that is performed. -
quantity
The number of devices that have been dispensed. -
preparedDate
The time when the dispensed product was packaged and reviewed. -
whenHandedOver
The time the dispensed product was made available to the patient or their representative. -
destination
Identification of the facility/location where the device was /should be shipped to, as part of the dispense process. -
note
Extra information about the dispense that could not be conveyed in the other attributes. -
usageInstruction
The full representation of the instructions. -
eventHistory
A summary of the events of interest that have occurred, such as when the dispense was verified. -
SP_CODE
Search parameter: codeDescription: Search for devices that match this code
Type: token
Path: DeviceDispense.device.concept
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Search for devices that match this code
Type: token
Path: DeviceDispense.device.concept
-
SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient for whom to list dispenses
Type: reference
Path: DeviceDispense.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: The identity of a patient for whom to list dispenses
Type: reference
Path: DeviceDispense.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceDispense:subject".
-
-
Constructor Details
-
DeviceDispense
public DeviceDispense()Constructor -
DeviceDispense
public DeviceDispense(DeviceDispense.DeviceDispenseStatusCodes status, CodeableReference device, Reference subject) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifier for this dispensation.)
-
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}
-
getBasedOn
- Returns:
basedOn
(The order or request that this dispense is fulfilling.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist {3}
-
getPartOf
- Returns:
partOf
(The bigger event that this dispense is a part of.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist {3}
-
getStatusElement
- Returns:
status
(A code specifying the state of the set of dispense events.). 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 specifying the state of the set of dispense events.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- A code specifying the state of the set of dispense events.
-
setStatus
- Parameters:
value
- A code specifying the state of the set of dispense events.
-
getStatusReason
- Returns:
statusReason
(Indicates the reason why a dispense was or was not performed.)
-
hasStatusReason
-
setStatusReason
- Parameters:
value
-statusReason
(Indicates the reason why a dispense was or was not performed.)
-
getCategory
- Returns:
category
(Indicates the type of device dispense.)
-
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}
-
getDevice
- Returns:
device
(Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.)
-
hasDevice
-
setDevice
- Parameters:
value
-device
(Identifies the device being dispensed. This is either a link to a resource representing the details of the device or a simple attribute carrying a code that identifies the device from a known list of devices.)
-
getSubject
- Returns:
subject
(A link to a resource representing the person to whom the device is intended.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(A link to a resource representing the person to whom the device is intended.)
-
getEncounter
- Returns:
encounter
(The encounter that establishes the context for this event.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The encounter that establishes the context for this event.)
-
getSupportingInformation
- Returns:
supportingInformation
(Additional information that supports the device being dispensed.)
-
setSupportingInformation
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInformation
-
addSupportingInformation
-
addSupportingInformation
-
getSupportingInformationFirstRep
- Returns:
- The first repetition of repeating field
supportingInformation
, creating it if it does not already exist {3}
-
getPerformer
- Returns:
performer
(Indicates who or what performed the event.)
-
setPerformer
public DeviceDispense setPerformer(List<DeviceDispense.DeviceDispensePerformerComponent> thePerformer) - Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist {3}
-
getLocation
- Returns:
location
(The principal physical location where the dispense was performed.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(The principal physical location where the dispense was performed.)
-
getType
- Returns:
type
(Indicates the type of dispensing event that is performed.)
-
hasType
-
setType
- Parameters:
value
-type
(Indicates the type of dispensing event that is performed.)
-
getQuantity
- Returns:
quantity
(The number of devices that have been dispensed.)
-
hasQuantity
-
setQuantity
- Parameters:
value
-quantity
(The number of devices that have been dispensed.)
-
getPreparedDateElement
- Returns:
preparedDate
(The time when the dispensed product was packaged and reviewed.). This is the underlying object with id, value and extensions. The accessor "getPreparedDate" gives direct access to the value
-
hasPreparedDateElement
-
hasPreparedDate
-
setPreparedDateElement
- Parameters:
value
-preparedDate
(The time when the dispensed product was packaged and reviewed.). This is the underlying object with id, value and extensions. The accessor "getPreparedDate" gives direct access to the value
-
getPreparedDate
- Returns:
- The time when the dispensed product was packaged and reviewed.
-
setPreparedDate
- Parameters:
value
- The time when the dispensed product was packaged and reviewed.
-
getWhenHandedOverElement
- Returns:
whenHandedOver
(The time the dispensed product was made available to the patient or their representative.). This is the underlying object with id, value and extensions. The accessor "getWhenHandedOver" gives direct access to the value
-
hasWhenHandedOverElement
-
hasWhenHandedOver
-
setWhenHandedOverElement
- Parameters:
value
-whenHandedOver
(The time the dispensed product was made available to the patient or their representative.). This is the underlying object with id, value and extensions. The accessor "getWhenHandedOver" gives direct access to the value
-
getWhenHandedOver
- Returns:
- The time the dispensed product was made available to the patient or their representative.
-
setWhenHandedOver
- Parameters:
value
- The time the dispensed product was made available to the patient or their representative.
-
getDestination
- Returns:
destination
(Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.)
-
hasDestination
-
setDestination
- Parameters:
value
-destination
(Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.)
-
getNote
- Returns:
note
(Extra information about the dispense that could not be conveyed in the other attributes.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist {3}
-
getUsageInstructionElement
- Returns:
usageInstruction
(The full representation of the instructions.). This is the underlying object with id, value and extensions. The accessor "getUsageInstruction" gives direct access to the value
-
hasUsageInstructionElement
-
hasUsageInstruction
-
setUsageInstructionElement
- Parameters:
value
-usageInstruction
(The full representation of the instructions.). This is the underlying object with id, value and extensions. The accessor "getUsageInstruction" gives direct access to the value
-
getUsageInstruction
- Returns:
- The full representation of the instructions.
-
setUsageInstruction
- Parameters:
value
- The full representation of the instructions.
-
getEventHistory
- Returns:
eventHistory
(A summary of the events of interest that have occurred, such as when the dispense was verified.)
-
setEventHistory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEventHistory
-
addEventHistory
-
addEventHistory
-
getEventHistoryFirstRep
- Returns:
- The first repetition of repeating field
eventHistory
, creating it if it does not already exist {3}
-
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
-
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
-