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
public class DeviceDispense extends DomainResource
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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDeviceDispense.DeviceDispensePerformerComponentstatic classDeviceDispense.DeviceDispenseStatusCodesstatic classDeviceDispense.DeviceDispenseStatusCodesEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>basedOnThe order or request that this dispense is fulfilling.protected List<CodeableConcept>categoryIndicates the type of device dispense.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected ReferencedestinationIdentification of the facility/location where the device was /should be shipped to, as part of the dispense process.protected CodeableReferencedeviceIdentifies the device being dispensed.protected ReferenceencounterThe encounter that establishes the context for this event.protected List<Reference>eventHistoryA summary of the events of interest that have occurred, such as when the dispense was verified.protected List<Identifier>identifierBusiness identifier for this dispensation.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.protected ReferencelocationThe principal physical location where the dispense was performed.protected List<Annotation>noteExtra information about the dispense that could not be conveyed in the other attributes.protected List<Reference>partOfThe bigger event that this dispense is a part of.protected List<DeviceDispense.DeviceDispensePerformerComponent>performerIndicates who or what performed the event.protected DateTimeTypepreparedDateThe time when the dispensed product was packaged and reviewed.protected QuantityquantityThe number of devices that have been dispensed.static StringSP_CODESearch parameter: codestatic StringSP_SUBJECTSearch parameter: subjectprotected Enumeration<DeviceDispense.DeviceDispenseStatusCodes>statusA code specifying the state of the set of dispense events.protected CodeableReferencestatusReasonIndicates the reason why a dispense was or was not performed.protected ReferencesubjectA link to a resource representing the person to whom the device is intended.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected List<Reference>supportingInformationAdditional information that supports the device being dispensed.protected CodeableConcepttypeIndicates the type of dispensing event that is performed.protected StringTypeusageInstructionThe full representation of the instructions.protected DateTimeTypewhenHandedOverThe 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
-
-
Constructor Summary
Constructors Constructor Description DeviceDispense()ConstructorDeviceDispense(DeviceDispense.DeviceDispenseStatusCodes status, CodeableReference device, Reference subject)Constructor
-
Method Summary
-
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, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Business identifier for this dispensation.
-
status
protected Enumeration<DeviceDispense.DeviceDispenseStatusCodes> status
A code specifying the state of the set of dispense events.
-
statusReason
protected CodeableReference statusReason
Indicates the reason why a dispense was or was not performed.
-
category
protected List<CodeableConcept> category
Indicates the type of device dispense.
-
device
protected CodeableReference 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
protected Reference subject
A link to a resource representing the person to whom the device is intended.
-
supportingInformation
protected List<Reference> supportingInformation
Additional information that supports the device being dispensed.
-
performer
protected List<DeviceDispense.DeviceDispensePerformerComponent> performer
Indicates who or what performed the event.
-
location
protected Reference location
The principal physical location where the dispense was performed.
-
type
protected CodeableConcept type
Indicates the type of dispensing event that is performed.
-
preparedDate
protected DateTimeType preparedDate
The time when the dispensed product was packaged and reviewed.
-
whenHandedOver
protected DateTimeType whenHandedOver
The time the dispensed product was made available to the patient or their representative.
-
destination
protected Reference destination
Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.
-
note
protected List<Annotation> note
Extra information about the dispense that could not be conveyed in the other attributes.
-
usageInstruction
protected StringType usageInstruction
The full representation of the instructions.
-
eventHistory
protected List<Reference> eventHistory
A summary of the events of interest that have occurred, such as when the dispense was verified.
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Search for devices that match this code
Type: token
Path: DeviceDispense.device.concept
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Search for devices that match this code
Type: token
Path: DeviceDispense.device.concept
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient for whom to list dispenses
Type: reference
Path: DeviceDispense.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceDispense:subject".
-
-
Constructor Detail
-
DeviceDispense
public DeviceDispense()
Constructor
-
DeviceDispense
public DeviceDispense(DeviceDispense.DeviceDispenseStatusCodes status, CodeableReference device, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Business identifier for this dispensation.)
-
setIdentifier
public DeviceDispense setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public DeviceDispense addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(The order or request that this dispense is fulfilling.)
-
setBasedOn
public DeviceDispense setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public DeviceDispense addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist {3}
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf(The bigger event that this dispense is a part of.)
-
setPartOf
public DeviceDispense setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
addPartOf
public DeviceDispense addPartOf(Reference t)
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist {3}
-
getStatusElement
public Enumeration<DeviceDispense.DeviceDispenseStatusCodes> 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
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public DeviceDispense setStatusElement(Enumeration<DeviceDispense.DeviceDispenseStatusCodes> value)
- 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
public DeviceDispense.DeviceDispenseStatusCodes getStatus()
- Returns:
- A code specifying the state of the set of dispense events.
-
setStatus
public DeviceDispense setStatus(DeviceDispense.DeviceDispenseStatusCodes value)
- Parameters:
value- A code specifying the state of the set of dispense events.
-
getStatusReason
public CodeableReference getStatusReason()
- Returns:
statusReason(Indicates the reason why a dispense was or was not performed.)
-
hasStatusReason
public boolean hasStatusReason()
-
setStatusReason
public DeviceDispense setStatusReason(CodeableReference value)
- Parameters:
value-statusReason(Indicates the reason why a dispense was or was not performed.)
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(Indicates the type of device dispense.)
-
setCategory
public DeviceDispense setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public DeviceDispense addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist {3}
-
getDevice
public CodeableReference 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
public boolean hasDevice()
-
setDevice
public DeviceDispense setDevice(CodeableReference value)
- 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
public Reference getSubject()
- Returns:
subject(A link to a resource representing the person to whom the device is intended.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public DeviceDispense setSubject(Reference value)
- Parameters:
value-subject(A link to a resource representing the person to whom the device is intended.)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The encounter that establishes the context for this event.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public DeviceDispense setEncounter(Reference value)
- Parameters:
value-encounter(The encounter that establishes the context for this event.)
-
getSupportingInformation
public List<Reference> getSupportingInformation()
- Returns:
supportingInformation(Additional information that supports the device being dispensed.)
-
setSupportingInformation
public DeviceDispense setSupportingInformation(List<Reference> theSupportingInformation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInformation
public boolean hasSupportingInformation()
-
addSupportingInformation
public Reference addSupportingInformation()
-
addSupportingInformation
public DeviceDispense addSupportingInformation(Reference t)
-
getSupportingInformationFirstRep
public Reference getSupportingInformationFirstRep()
- Returns:
- The first repetition of repeating field
supportingInformation, creating it if it does not already exist {3}
-
getPerformer
public List<DeviceDispense.DeviceDispensePerformerComponent> 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
public boolean hasPerformer()
-
addPerformer
public DeviceDispense.DeviceDispensePerformerComponent addPerformer()
-
addPerformer
public DeviceDispense addPerformer(DeviceDispense.DeviceDispensePerformerComponent t)
-
getPerformerFirstRep
public DeviceDispense.DeviceDispensePerformerComponent getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer, creating it if it does not already exist {3}
-
getLocation
public Reference getLocation()
- Returns:
location(The principal physical location where the dispense was performed.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public DeviceDispense setLocation(Reference value)
- Parameters:
value-location(The principal physical location where the dispense was performed.)
-
getType
public CodeableConcept getType()
- Returns:
type(Indicates the type of dispensing event that is performed.)
-
hasType
public boolean hasType()
-
setType
public DeviceDispense setType(CodeableConcept value)
- Parameters:
value-type(Indicates the type of dispensing event that is performed.)
-
getQuantity
public Quantity getQuantity()
- Returns:
quantity(The number of devices that have been dispensed.)
-
hasQuantity
public boolean hasQuantity()
-
setQuantity
public DeviceDispense setQuantity(Quantity value)
- Parameters:
value-quantity(The number of devices that have been dispensed.)
-
getPreparedDateElement
public DateTimeType 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
public boolean hasPreparedDateElement()
-
hasPreparedDate
public boolean hasPreparedDate()
-
setPreparedDateElement
public DeviceDispense setPreparedDateElement(DateTimeType value)
- 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
public Date getPreparedDate()
- Returns:
- The time when the dispensed product was packaged and reviewed.
-
setPreparedDate
public DeviceDispense setPreparedDate(Date value)
- Parameters:
value- The time when the dispensed product was packaged and reviewed.
-
getWhenHandedOverElement
public DateTimeType 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
public boolean hasWhenHandedOverElement()
-
hasWhenHandedOver
public boolean hasWhenHandedOver()
-
setWhenHandedOverElement
public DeviceDispense setWhenHandedOverElement(DateTimeType value)
- 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
public Date getWhenHandedOver()
- Returns:
- The time the dispensed product was made available to the patient or their representative.
-
setWhenHandedOver
public DeviceDispense setWhenHandedOver(Date value)
- Parameters:
value- The time the dispensed product was made available to the patient or their representative.
-
getDestination
public Reference getDestination()
- Returns:
destination(Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.)
-
hasDestination
public boolean hasDestination()
-
setDestination
public DeviceDispense setDestination(Reference value)
- Parameters:
value-destination(Identification of the facility/location where the device was /should be shipped to, as part of the dispense process.)
-
getNote
public List<Annotation> getNote()
- Returns:
note(Extra information about the dispense that could not be conveyed in the other attributes.)
-
setNote
public DeviceDispense setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public DeviceDispense addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist {3}
-
getUsageInstructionElement
public StringType 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
public boolean hasUsageInstructionElement()
-
hasUsageInstruction
public boolean hasUsageInstruction()
-
setUsageInstructionElement
public DeviceDispense setUsageInstructionElement(StringType value)
- 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
public String getUsageInstruction()
- Returns:
- The full representation of the instructions.
-
setUsageInstruction
public DeviceDispense setUsageInstruction(String value)
- Parameters:
value- The full representation of the instructions.
-
getEventHistory
public List<Reference> getEventHistory()
- Returns:
eventHistory(A summary of the events of interest that have occurred, such as when the dispense was verified.)
-
setEventHistory
public DeviceDispense setEventHistory(List<Reference> theEventHistory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEventHistory
public boolean hasEventHistory()
-
addEventHistory
public Reference addEventHistory()
-
addEventHistory
public DeviceDispense addEventHistory(Reference t)
-
getEventHistoryFirstRep
public Reference getEventHistoryFirstRep()
- Returns:
- The first repetition of repeating field
eventHistory, creating it if it does not already exist {3}
-
listChildren
protected void listChildren(List<Property> children)
- 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public DeviceDispense copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(DeviceDispense dst)
-
typedCopy
protected DeviceDispense typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-