Class MedicationRequest
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.MedicationRequest
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") public class MedicationRequest extends DomainResource
An order or request for both supply of the medication and the instructions for administration of the medication to a patient. The resource is called "MedicationRequest" rather than "MedicationPrescription" or "MedicationOrder" to generalize the use across inpatient and outpatient settings, including care plans, etc., and to harmonize with workflow patterns.Maturity level: FMM3 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
MedicationRequest.Builder
static class
MedicationRequest.DispenseRequest
Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order).static class
MedicationRequest.Substitution
Indicates whether or not substitution can or should be part of the dispense.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static MedicationRequest.Builder
builder()
boolean
equals(java.lang.Object obj)
DateTime
getAuthoredOn()
The date (and perhaps time) when the prescription was initially written or authored on.java.util.List<Reference>
getBasedOn()
A plan or request that is fulfilled in whole or in part by this medication request.java.util.List<CodeableConcept>
getCategory()
Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e.CodeableConcept
getCourseOfTherapyType()
The description of the overall patte3rn of the administration of the medication to the patient.java.util.List<Reference>
getDetectedIssue()
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.MedicationRequest.DispenseRequest
getDispenseRequest()
Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order).Boolean
getDoNotPerform()
If true indicates that the provider is asking for the medication request not to occur.java.util.List<Dosage>
getDosageInstruction()
Indicates how the medication is to be used by the patient.Reference
getEncounter()
The Encounter during which this [x] was created or to which the creation of this record is tightly associated.java.util.List<Reference>
getEventHistory()
Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.Identifier
getGroupIdentifier()
A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.java.util.List<Identifier>
getIdentifier()
Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate.java.util.List<Canonical>
getInstantiatesCanonical()
The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.java.util.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 MedicationRequest.java.util.List<Reference>
getInsurance()
Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be required for delivering the requested service.MedicationRequestIntent
getIntent()
Whether the request is a proposal, plan, or an original order.Element
getMedication()
Identifies the medication being requested.java.util.List<Annotation>
getNote()
Extra information about the prescription that could not be conveyed by the other attributes.Reference
getPerformer()
The specified desired performer of the medication treatment (e.g.CodeableConcept
getPerformerType()
Indicates the type of performer of the administration of the medication.MedicationRequestPriority
getPriority()
Indicates how quickly the Medication Request should be addressed with respect to other requests.Reference
getPriorPrescription()
A link to a resource representing an earlier order related order or prescription.java.util.List<CodeableConcept>
getReasonCode()
The reason or the indication for ordering or not ordering the medication.java.util.List<Reference>
getReasonReference()
Condition or observation that supports why the medication was ordered.Reference
getRecorder()
The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.Element
getReported()
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of- truth record.Reference
getRequester()
The individual, organization, or device that initiated the request and has responsibility for its activation.MedicationRequestStatus
getStatus()
A code specifying the current state of the order.CodeableConcept
getStatusReason()
Captures the reason for the current state of the MedicationRequest.Reference
getSubject()
A link to a resource representing the person or set of individuals to whom the medication will be given.MedicationRequest.Substitution
getSubstitution()
Indicates whether or not substitution can or should be part of the dispense.java.util.List<Reference>
getSupportingInformation()
Include additional information (for example, patient height and weight) that supports the ordering of the medication.boolean
hasChildren()
int
hashCode()
MedicationRequest.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
Identifiers associated with this medication request that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getStatus
public MedicationRequestStatus getStatus()
A code specifying the current state of the order. Generally, this will be active or completed state.- Returns:
- An immutable object of type
MedicationRequestStatus
that is non-null.
-
getStatusReason
public CodeableConcept getStatusReason()
Captures the reason for the current state of the MedicationRequest.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getIntent
public MedicationRequestIntent getIntent()
Whether the request is a proposal, plan, or an original order.- Returns:
- An immutable object of type
MedicationRequestIntent
that is non-null.
-
getCategory
public java.util.List<CodeableConcept> getCategory()
Indicates the type of medication request (for example, where the medication is expected to be consumed or administered (i.e. inpatient or outpatient)).- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getPriority
public MedicationRequestPriority getPriority()
Indicates how quickly the Medication Request should be addressed with respect to other requests.- Returns:
- An immutable object of type
MedicationRequestPriority
that may be null.
-
getDoNotPerform
public Boolean getDoNotPerform()
If true indicates that the provider is asking for the medication request not to occur.- Returns:
- An immutable object of type
Boolean
that may be null.
-
getReported
public Element getReported()
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of- truth record. It may also indicate the source of the report.
-
getMedication
public Element getMedication()
Identifies the medication being requested. This is a link to a resource that represents the medication which may be the details of the medication or simply an attribute carrying a code that identifies the medication from a known list of medications.- Returns:
- An immutable object of type
CodeableConcept
orReference
that is non-null.
-
getSubject
public Reference getSubject()
A link to a resource representing the person or set of individuals to whom the medication will be given.- Returns:
- An immutable object of type
Reference
that is non-null.
-
getEncounter
public Reference getEncounter()
The Encounter during which this [x] was created or to which the creation of this record is tightly associated.- Returns:
- An immutable object of type
Reference
that may be null.
-
getSupportingInformation
public java.util.List<Reference> getSupportingInformation()
Include additional information (for example, patient height and weight) that supports the ordering of the medication.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getAuthoredOn
public DateTime getAuthoredOn()
The date (and perhaps time) when the prescription was initially written or authored on.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getRequester
public Reference getRequester()
The individual, organization, or device that initiated the request and has responsibility for its activation.- Returns:
- An immutable object of type
Reference
that may be null.
-
getPerformer
public Reference getPerformer()
The specified desired performer of the medication treatment (e.g. the performer of the medication administration).- Returns:
- An immutable object of type
Reference
that may be null.
-
getPerformerType
public CodeableConcept getPerformerType()
Indicates the type of performer of the administration of the medication.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getRecorder
public Reference getRecorder()
The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.- Returns:
- An immutable object of type
Reference
that may be null.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
The reason or the indication for ordering or not ordering the medication.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
Condition or observation that supports why the medication was ordered.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getInstantiatesCanonical
public java.util.List<Canonical> getInstantiatesCanonical()
The URL pointing to a protocol, guideline, orderset, or other definition that is adhered to in whole or in part by this MedicationRequest.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getInstantiatesUri
public java.util.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 MedicationRequest.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getBasedOn
public java.util.List<Reference> getBasedOn()
A plan or request that is fulfilled in whole or in part by this medication request.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getGroupIdentifier
public Identifier getGroupIdentifier()
A shared identifier common to all requests that were authorized more or less simultaneously by a single author, representing the identifier of the requisition or prescription.- Returns:
- An immutable object of type
Identifier
that may be null.
-
getCourseOfTherapyType
public CodeableConcept getCourseOfTherapyType()
The description of the overall patte3rn of the administration of the medication to the patient.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getInsurance
public java.util.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
Reference
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
Extra information about the prescription that could not be conveyed by the other attributes.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
getDosageInstruction
public java.util.List<Dosage> getDosageInstruction()
Indicates how the medication is to be used by the patient.- Returns:
- An unmodifiable list containing immutable objects of type
Dosage
that may be empty.
-
getDispenseRequest
public MedicationRequest.DispenseRequest getDispenseRequest()
Indicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order). Note that this information is not always sent with the order. There may be in some settings (e.g. hospitals) institutional or system support for completing the dispense details in the pharmacy department.- Returns:
- An immutable object of type
MedicationRequest.DispenseRequest
that may be null.
-
getSubstitution
public MedicationRequest.Substitution getSubstitution()
Indicates whether or not substitution can or should be part of the dispense. In some cases, substitution must happen, in other cases substitution must not happen. This block explains the prescriber's intent. If nothing is specified substitution may be done.- Returns:
- An immutable object of type
MedicationRequest.Substitution
that may be null.
-
getPriorPrescription
public Reference getPriorPrescription()
A link to a resource representing an earlier order related order or prescription.- Returns:
- An immutable object of type
Reference
that may be null.
-
getDetectedIssue
public java.util.List<Reference> getDetectedIssue()
Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g. Drug-drug interaction, duplicate therapy, dosage alert etc.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getEventHistory
public java.util.List<Reference> getEventHistory()
Links to Provenance records for past versions of this resource or fulfilling request or event resources that identify key state transitions or updates that are likely to be relevant to a user looking at the current version of the resource.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept 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:
accept
in interfaceVisitable
- Specified by:
accept
in 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
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public MedicationRequest.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static MedicationRequest.Builder builder()
-
-