Class DeviceUsage
- 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 enumstatic class -
Field Summary
FieldsModifier and TypeFieldDescriptionA plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage.protected CodeableReferenceIndicates the anotomic location on the subject's body where the device was used ( i.e.protected List<CodeableConcept>This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).protected ReferenceThe encounter or episode of care that establishes the context for this device use statement.protected DateTimeTypeThe time at which the statement was recorded by informationSource.Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage.protected CodeableReferenceCode or Reference to device used.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for deviceprotected List<Identifier>An external identifier for this statement such as an IRI.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.protected ReferenceWho reported the device was being used by the patient.protected List<Annotation>Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class.protected ReferenceThe patient who used the device.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected List<CodeableReference>Reason or justification for the use of the device.static final StringSearch parameter: devicestatic final StringSearch parameter: identifierstatic final StringSearch parameter: patientprotected Enumeration<DeviceUsage.DeviceUsageStatus>A code representing the patient or other source's judgment about the state of the device used that this statement is about.protected DataTypeHow often the device was used.protected List<CodeableConcept>The reason for asserting the usage status - for example forgot, lost, stolen, broken.protected CodeableConceptThe status of the device usage, for example always, sometimes, never.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, SP_RES_IDFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionConstructorDeviceUsage(DeviceUsage.DeviceUsageStatus status, Reference patient, CodeableReference device) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()copy()voidcopyValues(DeviceUsage dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getNamedProperty(int _hash, String _name, boolean _checkValid) getNote()Base[]getProperty(int hash, String name, boolean checkValid) String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) setBasedOn(List<Reference> theBasedOn) setBodySite(CodeableReference value) setCategory(List<CodeableConcept> theCategory) setContext(Reference value) setDateAsserted(Date value) setDerivedFrom(List<Reference> theDerivedFrom) setDevice(CodeableReference value) setIdentifier(List<Identifier> theIdentifier) setInformationSource(Reference value) setNote(List<Annotation> theNote) setPatient(Reference value) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setReason(List<CodeableReference> theReason) setUsageReason(List<CodeableConcept> theUsageReason) setUsageStatus(CodeableConcept value) protected DeviceUsageMethods 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, setTextMethods 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, setMetaMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods 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, setUserDataINNMethods 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, setId
-
Field Details
-
identifier
An external identifier for this statement such as an IRI. -
basedOn
A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage. -
status
A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed. -
category
This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified). -
patient
The patient who used the device. -
derivedFrom
Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage. -
context
The encounter or episode of care that establishes the context for this device use statement. -
timing
How often the device was used. -
dateAsserted
The time at which the statement was recorded by informationSource. -
usageStatus
The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement. -
usageReason
The reason for asserting the usage status - for example forgot, lost, stolen, broken. -
informationSource
Who reported the device was being used by the patient. -
device
Code or Reference to device used. -
reason
Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsage. -
bodySite
Indicates the anotomic location on the subject's body where the device was used ( i.e. the target). -
note
Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement. -
SP_DEVICE
Search parameter: deviceDescription: Search by device
Type: token
Path: DeviceUsage.device.concept
- See Also:
-
DEVICE
Fluent Client search parameter constant for deviceDescription: Search by device
Type: token
Path: DeviceUsage.device.concept
-
SP_IDENTIFIER
Search parameter: identifierDescription: Search by identifier
Type: token
Path: DeviceUsage.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Search by identifier
Type: token
Path: DeviceUsage.identifier
-
SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "DeviceUsage:patient".
-
-
Constructor Details
-
DeviceUsage
public DeviceUsage()Constructor -
DeviceUsage
public DeviceUsage(DeviceUsage.DeviceUsageStatus status, Reference patient, CodeableReference device) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(An external identifier for this statement such as an IRI.)
-
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(A plan, proposal or order that is fulfilled in whole or in part by this DeviceUsage.)
-
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}
-
getStatusElement
- Returns:
status(A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.). 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 representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
-
setStatus
- Parameters:
value- A code representing the patient or other source's judgment about the state of the device used that this statement is about. Generally this will be active or completed.
-
getCategory
- Returns:
category(This attribute indicates a category for the statement - The device statement may be made in an inpatient or outpatient settting (inpatient | outpatient | community | patientspecified).)
-
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}
-
getPatient
- Returns:
patient(The patient who used the device.)
-
hasPatient
-
setPatient
- Parameters:
value-patient(The patient who used the device.)
-
getDerivedFrom
- Returns:
derivedFrom(Allows linking the DeviceUsage to the underlying Request, or to other information that supports or is used to derive the DeviceUsage.)
-
setDerivedFrom
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDerivedFrom
-
addDerivedFrom
-
addDerivedFrom
-
getDerivedFromFirstRep
- Returns:
- The first repetition of repeating field
derivedFrom, creating it if it does not already exist {3}
-
getContext
- Returns:
context(The encounter or episode of care that establishes the context for this device use statement.)
-
hasContext
-
setContext
- Parameters:
value-context(The encounter or episode of care that establishes the context for this device use statement.)
-
getTiming
- Returns:
timing(How often the device was used.)
-
getTimingTiming
- Returns:
timing(How often the device was used.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingTiming
-
getTimingPeriod
- Returns:
timing(How often the device was used.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingPeriod
-
getTimingDateTimeType
- Returns:
timing(How often the device was used.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasTimingDateTimeType
-
hasTiming
-
setTiming
- Parameters:
value-timing(How often the device was used.)
-
getDateAssertedElement
- Returns:
dateAsserted(The time at which the statement was recorded by informationSource.). This is the underlying object with id, value and extensions. The accessor "getDateAsserted" gives direct access to the value
-
hasDateAssertedElement
-
hasDateAsserted
-
setDateAssertedElement
- Parameters:
value-dateAsserted(The time at which the statement was recorded by informationSource.). This is the underlying object with id, value and extensions. The accessor "getDateAsserted" gives direct access to the value
-
getDateAsserted
- Returns:
- The time at which the statement was recorded by informationSource.
-
setDateAsserted
- Parameters:
value- The time at which the statement was recorded by informationSource.
-
getUsageStatus
- Returns:
usageStatus(The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.)
-
hasUsageStatus
-
setUsageStatus
- Parameters:
value-usageStatus(The status of the device usage, for example always, sometimes, never. This is not the same as the status of the statement.)
-
getUsageReason
- Returns:
usageReason(The reason for asserting the usage status - for example forgot, lost, stolen, broken.)
-
setUsageReason
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUsageReason
-
addUsageReason
-
addUsageReason
-
getUsageReasonFirstRep
- Returns:
- The first repetition of repeating field
usageReason, creating it if it does not already exist {3}
-
getInformationSource
- Returns:
informationSource(Who reported the device was being used by the patient.)
-
hasInformationSource
-
setInformationSource
- Parameters:
value-informationSource(Who reported the device was being used by the patient.)
-
getDevice
- Returns:
device(Code or Reference to device used.)
-
hasDevice
-
setDevice
- Parameters:
value-device(Code or Reference to device used.)
-
getReason
- Returns:
reason(Reason or justification for the use of the device. A coded concept, or another resource whose existence justifies this DeviceUsage.)
-
setReason
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason, creating it if it does not already exist {3}
-
getBodySite
- Returns:
bodySite(Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).)
-
hasBodySite
-
setBodySite
- Parameters:
value-bodySite(Indicates the anotomic location on the subject's body where the device was used ( i.e. the target).)
-
getNote
- Returns:
note(Details about the device statement that were not represented at all or sufficiently in one of the attributes provided in a class. These may include for example a comment, an instruction, or a note associated with the statement.)
-
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}
-
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
-
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
-
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
-