Package com.ibm.fhir.model.resource
Class DeviceRequest
- java.lang.Object
-
- com.ibm.fhir.model.visitor.AbstractVisitable
-
- com.ibm.fhir.model.resource.Resource
-
- com.ibm.fhir.model.resource.DomainResource
-
- com.ibm.fhir.model.resource.DeviceRequest
-
- All Implemented Interfaces:
Visitable
@Generated("com.ibm.fhir.tools.CodeGenerator") public class DeviceRequest extends DomainResource
Represents a request for a patient to employ a medical device. The device may be an implantable device, or an external assistive device, such as a walker.Maturity level: FMM1 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDeviceRequest.Builderstatic classDeviceRequest.ParameterSpecific parameters for the ordered item.
-
Field Summary
-
Fields inherited from class com.ibm.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class com.ibm.fhir.model.resource.Resource
id, implicitRules, language, meta
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(String elementName, int elementIndex, Visitor visitor)Accept a Visitor and invoke the appropriate visit methods.static DeviceRequest.Builderbuilder()booleanequals(Object obj)DateTimegetAuthoredOn()When the request transitioned to being actionable.List<Reference>getBasedOn()Plan/proposal/order fulfilled by this request.ElementgetCode()The details of the device to be used.ReferencegetEncounter()An encounter that provides additional context in which this request is made.IdentifiergetGroupIdentifier()Composite request this is part of.List<Identifier>getIdentifier()Identifiers assigned to this order by the orderer or by the receiver.List<Canonical>getInstantiatesCanonical()The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.List<Uri>getInstantiatesUri()The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.List<Reference>getInsurance()Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.RequestIntentgetIntent()Whether the request is a proposal, plan, an original order or a reflex order.List<Annotation>getNote()Details about this request that were not represented at all or sufficiently in one of the attributes provided in a class.ElementgetOccurrence()The timing schedule for the use of the device.List<DeviceRequest.Parameter>getParameter()Specific parameters for the ordered item.ReferencegetPerformer()The desired performer for doing the diagnostic testing.CodeableConceptgetPerformerType()Desired type of performer for doing the diagnostic testing.RequestPrioritygetPriority()Indicates how quickly the {{title}} should be addressed with respect to other requests.List<Reference>getPriorRequest()The request takes the place of the referenced completed or terminated request(s).List<CodeableConcept>getReasonCode()Reason or justification for the use of this device.List<Reference>getReasonReference()Reason or justification for the use of this device.List<Reference>getRelevantHistory()Key events in the history of the request.ReferencegetRequester()The individual who initiated the request and has responsibility for its activation.DeviceRequestStatusgetStatus()The status of the request.ReferencegetSubject()The patient who will use the device.List<Reference>getSupportingInfo()Additional clinical information about the patient that may influence the request fulfilment.booleanhasChildren()inthashCode()DeviceRequest.BuildertoBuilder()Create a new Builder from the contents of this Resource-
Methods inherited from class com.ibm.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class com.ibm.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
Identifiers assigned to this order by the orderer or by the receiver.- Returns:
- An unmodifiable list containing immutable objects of type
Identifierthat may be empty.
-
getInstantiatesCanonical
public List<Canonical> getInstantiatesCanonical()
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.- Returns:
- An unmodifiable list containing immutable objects of type
Canonicalthat may be empty.
-
getInstantiatesUri
public List<Uri> getInstantiatesUri()
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this DeviceRequest.- Returns:
- An unmodifiable list containing immutable objects of type
Urithat may be empty.
-
getBasedOn
public List<Reference> getBasedOn()
Plan/proposal/order fulfilled by this request.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getPriorRequest
public List<Reference> getPriorRequest()
The request takes the place of the referenced completed or terminated request(s).- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getGroupIdentifier
public Identifier getGroupIdentifier()
Composite request this is part of.- Returns:
- An immutable object of type
Identifierthat may be null.
-
getStatus
public DeviceRequestStatus getStatus()
The status of the request.- Returns:
- An immutable object of type
DeviceRequestStatusthat may be null.
-
getIntent
public RequestIntent getIntent()
Whether the request is a proposal, plan, an original order or a reflex order.- Returns:
- An immutable object of type
RequestIntentthat is non-null.
-
getPriority
public RequestPriority getPriority()
Indicates how quickly the {{title}} should be addressed with respect to other requests.- Returns:
- An immutable object of type
RequestPrioritythat may be null.
-
getCode
public Element getCode()
The details of the device to be used.- Returns:
- An immutable object of type
Elementthat is non-null.
-
getParameter
public List<DeviceRequest.Parameter> getParameter()
Specific parameters for the ordered item. For example, the prism value for lenses.- Returns:
- An unmodifiable list containing immutable objects of type
DeviceRequest.Parameterthat may be empty.
-
getSubject
public Reference getSubject()
The patient who will use the device.- Returns:
- An immutable object of type
Referencethat is non-null.
-
getEncounter
public Reference getEncounter()
An encounter that provides additional context in which this request is made.- Returns:
- An immutable object of type
Referencethat may be null.
-
getOccurrence
public Element getOccurrence()
The timing schedule for the use of the device. The Schedule data type allows many different expressions, for example. "Every 8 hours"; "Three times a day"; "1/2 an hour before breakfast for 10 days from 23-Dec 2011:"; "15 Oct 2013, 17 Oct 2013 and 1 Nov 2013".- Returns:
- An immutable object of type
Elementthat may be null.
-
getAuthoredOn
public DateTime getAuthoredOn()
When the request transitioned to being actionable.- Returns:
- An immutable object of type
DateTimethat may be null.
-
getRequester
public Reference getRequester()
The individual who initiated the request and has responsibility for its activation.- Returns:
- An immutable object of type
Referencethat may be null.
-
getPerformerType
public CodeableConcept getPerformerType()
Desired type of performer for doing the diagnostic testing.- Returns:
- An immutable object of type
CodeableConceptthat may be null.
-
getPerformer
public Reference getPerformer()
The desired performer for doing the diagnostic testing.- Returns:
- An immutable object of type
Referencethat may be null.
-
getReasonCode
public List<CodeableConcept> getReasonCode()
Reason or justification for the use of this device.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConceptthat may be empty.
-
getReasonReference
public List<Reference> getReasonReference()
Reason or justification for the use of this device.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getInsurance
public List<Reference> getInsurance()
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getSupportingInfo
public List<Reference> getSupportingInfo()
Additional clinical information about the patient that may influence the request fulfilment. For example, this may include where on the subject's body the device will be used (i.e. the target site).- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
getNote
public List<Annotation> getNote()
Details about this request 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.- Returns:
- An unmodifiable list containing immutable objects of type
Annotationthat may be empty.
-
getRelevantHistory
public List<Reference> getRelevantHistory()
Key events in the history of the request.- Returns:
- An unmodifiable list containing immutable objects of type
Referencethat may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildrenin classDomainResource
-
accept
public void accept(String elementName, int elementIndex, Visitor visitor)
Description copied from interface:VisitableAccept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }- Specified by:
acceptin interfaceVisitable- Specified by:
acceptin classAbstractVisitable- Parameters:
elementName- the name of the element in the context of this visitelementIndex- the index of the element in a list or -1 if it is not contained within a Listvisitor- the visitor to use
-
toBuilder
public DeviceRequest.Builder toBuilder()
Description copied from class:ResourceCreate a new Builder from the contents of this Resource- Specified by:
toBuilderin classDomainResource
-
builder
public static DeviceRequest.Builder builder()
-
-