
Class 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
- See Also:
 
- 
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumstatic classNested 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.TokenClientParamFluent Client search parameter constant for codeprotected ReferenceIdentification of the facility/location where the device was /should be shipped to, as part of the dispense process.protected CodeableReferenceIdentifies the device being dispensed.protected ReferenceThe 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.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.protected ReferenceThe 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.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientIndicates who or what performed the event.protected DateTimeTypeThe time when the dispensed product was packaged and reviewed.protected QuantityThe number of devices that have been dispensed.protected ReferenceIdentifies the person who picked up the device or the person or location where the device was delivered.static final StringSearch parameter: codestatic final StringSearch parameter: identifierstatic final StringSearch parameter: patientstatic final StringSearch parameter: statusstatic final StringSearch parameter: subjectA code specifying the state of the set of dispense events.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusprotected CodeableReferenceIndicates the reason why a dispense was or was not performed.protected ReferenceA link to a resource representing the person to whom the device is intended.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for subjectAdditional information that supports the device being dispensed.protected CodeableConceptIndicates the type of dispensing event that is performed.protected MarkdownTypeThe full representation of the instructions.protected DateTimeTypeThe 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, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields 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_TAGFields 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()voidcopyValues(DeviceDispense dst) booleanequalsDeep(Base other_) booleanequalsShallow(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) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasType()booleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) 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) setReceiver(Reference value) setStatusReason(CodeableReference value) setSubject(Reference value) setSupportingInformation(List<Reference> theSupportingInformation) setType(CodeableConcept value) setUsageInstruction(String value) setWhenHandedOver(Date value) protected DeviceDispenseMethods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setTextMethods 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, setWebPathMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, executeFunction, 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, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, 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. - 
receiver
Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location. - 
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_IDENTIFIER
Search parameter: identifierDescription: The identifier of the dispense
Type: token
Path: DeviceDispense.identifier
- See Also:
 
 - 
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: The identifier of the dispense
Type: token
Path: DeviceDispense.identifier
 - 
SP_PATIENT
Search parameter: patientDescription: Returns device dispenses for a specific patient
Type: reference
Path: DeviceDispense.subject.where(resolve() is Patient)
- See Also:
 
 - 
PATIENT
Fluent Client search parameter constant for patientDescription: Returns device dispenses for a specific patient
Type: reference
Path: DeviceDispense.subject.where(resolve() is Patient)
 - 
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceDispense:patient". - 
SP_STATUS
Search parameter: statusDescription: The status of the dispense
Type: token
Path: DeviceDispense.status
- See Also:
 
 - 
STATUS
Fluent Client search parameter constant for statusDescription: The status of the dispense
Type: token
Path: DeviceDispense.status
 - 
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 
thisfor 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 
thisfor 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 
thisfor 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 
thisfor 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.)
 - 
getReceiver
- Returns:
 receiver(Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.)
 - 
hasReceiver
 - 
setReceiver
- Parameters:
 value-receiver(Identifies the person who picked up the device or the person or location where the device was delivered. This may be a patient or their caregiver, but some cases exist where it can be a healthcare professional or a location.)
 - 
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 
thisfor 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 
thisfor 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 
thisfor 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 
thisfor 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:
 listChildrenin classDomainResource
 - 
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
 getNamedPropertyin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
 getPropertyin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
 setPropertyin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
setProperty
- Overrides:
 setPropertyin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
removeChild
- Overrides:
 removeChildin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
makeProperty
- Overrides:
 makePropertyin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
 getTypesForPropertyin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
addChild
- Overrides:
 addChildin classDomainResource- Throws:
 org.hl7.fhir.exceptions.FHIRException
 - 
fhirType
- Specified by:
 fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
 fhirTypein classDomainResource- Returns:
 - the FHIR type name of the instance (not the java class name)
 
 - 
copy
- Specified by:
 copyin classDomainResource
 - 
copyValues
 - 
typedCopy
 - 
equalsDeep
- Overrides:
 equalsDeepin classDomainResource
 - 
equalsShallow
- Overrides:
 equalsShallowin classDomainResource
 - 
isEmpty
- Specified by:
 isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
 isEmptyin classDomainResource
 - 
getResourceType
- Specified by:
 getResourceTypein classResource
 
 -