Class MedicationRequest
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.MedicationRequest
-
- 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 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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedicationRequest.MedicationRequestDispenseRequestComponentstatic classMedicationRequest.MedicationRequestIntentstatic classMedicationRequest.MedicationRequestIntentEnumFactorystatic classMedicationRequest.MedicationRequestPrioritystatic classMedicationRequest.MedicationRequestPriorityEnumFactorystatic classMedicationRequest.MedicationRequestRequesterComponentstatic classMedicationRequest.MedicationRequestStatusstatic classMedicationRequest.MedicationRequestStatusEnumFactorystatic classMedicationRequest.MedicationRequestSubstitutionComponent
-
Field Summary
Fields Modifier and Type Field Description protected DateTimeTypeauthoredOnThe date (and perhaps time) when the prescription was initially written or authored on.static ca.uhn.fhir.rest.gclient.DateClientParamAUTHOREDONFluent Client search parameter constant for authoredonprotected List<Reference>basedOnA plan or request that is fulfilled in whole or in part by this medication request.protected List<Resource>basedOnTargetThe actual objects that are the target of the reference (A plan or request that is fulfilled in whole or in part by this medication request.)protected CodeableConceptcategoryIndicates the type of medication order and where the medication is expected to be consumed or administered.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categorystatic ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected ReferencecontextA link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.static ca.uhn.fhir.rest.gclient.ReferenceClientParamCONTEXTFluent Client search parameter constant for contextprotected ResourcecontextTargetThe actual object that is the target of the reference (A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<Reference>definitionProtocol or definition followed by this request.protected List<Resource>definitionTargetThe actual objects that are the target of the reference (Protocol or definition followed by this request.)protected List<Reference>detectedIssueIndicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.protected List<DetectedIssue>detectedIssueTargetThe actual objects that are the target of the reference (Indicates an actual or potential clinical issue with or between one or more active or proposed clinical actions for a patient; e.g.protected MedicationRequest.MedicationRequestDispenseRequestComponentdispenseRequestIndicates the specific details for the dispense or medication supply part of a medication request (also known as a Medication Prescription or Medication Order).protected List<Dosage>dosageInstructionIndicates how the medication is to be used by the patient.protected List<Reference>eventHistoryLinks 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.protected List<Provenance>eventHistoryTargetThe actual objects that are the target of the reference (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.)protected IdentifiergroupIdentifierA 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.protected List<Identifier>identifierThis records 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.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_CONTEXTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_INTENDED_DISPENSERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_MEDICATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REQUESTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINTENDED_DISPENSERFluent Client search parameter constant for intended-dispenserprotected Enumeration<MedicationRequest.MedicationRequestIntent>intentWhether the request is a proposal, plan, or an original order.static ca.uhn.fhir.rest.gclient.TokenClientParamINTENTFluent Client search parameter constant for intentprotected TypemedicationIdentifies the medication being requested.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMEDICATIONFluent Client search parameter constant for medicationprotected List<Annotation>noteExtra information about the prescription that could not be conveyed by the other attributes.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected Enumeration<MedicationRequest.MedicationRequestPriority>priorityIndicates how quickly the Medication Request should be addressed with respect to other requests.static ca.uhn.fhir.rest.gclient.TokenClientParamPRIORITYFluent Client search parameter constant for priorityprotected ReferencepriorPrescriptionA link to a resource representing an earlier order related order or prescription.protected MedicationRequestpriorPrescriptionTargetThe actual object that is the target of the reference (A link to a resource representing an earlier order related order or prescription.)protected List<CodeableConcept>reasonCodeThe reason or the indication for ordering the medication.protected List<Reference>reasonReferenceCondition or observation that supports why the medication was ordered.protected List<Resource>reasonReferenceTargetThe actual objects that are the target of the reference (Condition or observation that supports why the medication was ordered.)protected ReferencerecorderThe person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.protected PractitionerrecorderTargetThe actual object that is the target of the reference (The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)protected MedicationRequest.MedicationRequestRequesterComponentrequesterThe individual, organization or device that initiated the request and has responsibility for its activation.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREQUESTERFluent Client search parameter constant for requesterstatic StringSP_AUTHOREDONSearch parameter: authoredonstatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CODESearch parameter: codestatic StringSP_CONTEXTSearch parameter: contextstatic StringSP_DATESearch parameter: datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INTENDED_DISPENSERSearch parameter: intended-dispenserstatic StringSP_INTENTSearch parameter: intentstatic StringSP_MEDICATIONSearch parameter: medicationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PRIORITYSearch parameter: prioritystatic StringSP_REQUESTERSearch parameter: requesterstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected Enumeration<MedicationRequest.MedicationRequestStatus>statusA code specifying the current state of the order.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectA link to a resource representing the person or set of individuals to whom the medication will be given.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected ResourcesubjectTargetThe actual object that is the target of the reference (A link to a resource representing the person or set of individuals to whom the medication will be given.)protected MedicationRequest.MedicationRequestSubstitutionComponentsubstitutionIndicates whether or not substitution can or should be part of the dispense.protected List<Reference>supportingInformationInclude additional information (for example, patient height and weight) that supports the ordering of the medication.protected List<Resource>supportingInformationTargetThe actual objects that are the target of the reference (Include additional information (for example, patient height and weight) that supports the ordering of the medication.)-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MedicationRequest()ConstructorMedicationRequest(Enumeration<MedicationRequest.MedicationRequestIntent> intent, Type medication, Reference subject)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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
This records 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. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.
-
definition
protected List<Reference> definition
Protocol or definition followed by this request.
-
definitionTarget
protected List<Resource> definitionTarget
The actual objects that are the target of the reference (Protocol or definition followed by this request.)
-
basedOn
protected List<Reference> basedOn
A plan or request that is fulfilled in whole or in part by this medication request.
-
basedOnTarget
protected List<Resource> basedOnTarget
The actual objects that are the target of the reference (A plan or request that is fulfilled in whole or in part by this medication request.)
-
groupIdentifier
protected Identifier groupIdentifier
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.
-
status
protected Enumeration<MedicationRequest.MedicationRequestStatus> status
A code specifying the current state of the order. Generally this will be active or completed state.
-
intent
protected Enumeration<MedicationRequest.MedicationRequestIntent> intent
Whether the request is a proposal, plan, or an original order.
-
category
protected CodeableConcept category
Indicates the type of medication order and where the medication is expected to be consumed or administered.
-
priority
protected Enumeration<MedicationRequest.MedicationRequestPriority> priority
Indicates how quickly the Medication Request should be addressed with respect to other requests.
-
medication
protected Type medication
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.
-
subject
protected Reference subject
A link to a resource representing the person or set of individuals to whom the medication will be given.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (A link to a resource representing the person or set of individuals to whom the medication will be given.)
-
context
protected Reference context
A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.
-
contextTarget
protected Resource contextTarget
The actual object that is the target of the reference (A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)
-
supportingInformation
protected List<Reference> supportingInformation
Include additional information (for example, patient height and weight) that supports the ordering of the medication.
-
supportingInformationTarget
protected List<Resource> supportingInformationTarget
The actual objects that are the target of the reference (Include additional information (for example, patient height and weight) that supports the ordering of the medication.)
-
authoredOn
protected DateTimeType authoredOn
The date (and perhaps time) when the prescription was initially written or authored on.
-
requester
protected MedicationRequest.MedicationRequestRequesterComponent requester
The individual, organization or device that initiated the request and has responsibility for its activation.
-
recorder
protected Reference recorder
The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.
-
recorderTarget
protected Practitioner recorderTarget
The actual object that is the target of the reference (The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)
-
reasonCode
protected List<CodeableConcept> reasonCode
The reason or the indication for ordering the medication.
-
reasonReference
protected List<Reference> reasonReference
Condition or observation that supports why the medication was ordered.
-
reasonReferenceTarget
protected List<Resource> reasonReferenceTarget
The actual objects that are the target of the reference (Condition or observation that supports why the medication was ordered.)
-
note
protected List<Annotation> note
Extra information about the prescription that could not be conveyed by the other attributes.
-
dosageInstruction
protected List<Dosage> dosageInstruction
Indicates how the medication is to be used by the patient.
-
dispenseRequest
protected MedicationRequest.MedicationRequestDispenseRequestComponent 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). 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.
-
substitution
protected MedicationRequest.MedicationRequestSubstitutionComponent substitution
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.
-
priorPrescription
protected Reference priorPrescription
A link to a resource representing an earlier order related order or prescription.
-
priorPrescriptionTarget
protected MedicationRequest priorPrescriptionTarget
The actual object that is the target of the reference (A link to a resource representing an earlier order related order or prescription.)
-
detectedIssue
protected List<Reference> detectedIssue
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.
-
detectedIssueTarget
protected List<DetectedIssue> detectedIssueTarget
The actual objects that are the target of the reference (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.)
-
eventHistory
protected List<Reference> eventHistory
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.
-
eventHistoryTarget
protected List<Provenance> eventHistoryTarget
The actual objects that are the target of the reference (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.)
-
SP_REQUESTER
public static final String SP_REQUESTER
Search parameter: requesterDescription: Returns prescriptions prescribed by this prescriber
Type: reference
Path: MedicationRequest.requester.agent
- See Also:
- Constant Field Values
-
REQUESTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
Fluent Client search parameter constant for requesterDescription: Returns prescriptions prescribed by this prescriber
Type: reference
Path: MedicationRequest.requester.agent
-
INCLUDE_REQUESTER
public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:requester".
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Returns medication request to be administered on a specific date
Type: date
Path: MedicationRequest.dosageInstruction.timing.event
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Returns medication request to be administered on a specific date
Type: date
Path: MedicationRequest.dosageInstruction.timing.event
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Return prescriptions with this external identifier
Type: token
Path: MedicationRequest.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Return prescriptions with this external identifier
Type: token
Path: MedicationRequest.identifier
-
SP_INTENDED_DISPENSER
public static final String SP_INTENDED_DISPENSER
Search parameter: intended-dispenserDescription: Returns prescriptions intended to be dispensed by this Organization
Type: reference
Path: MedicationRequest.dispenseRequest.performer
- See Also:
- Constant Field Values
-
INTENDED_DISPENSER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INTENDED_DISPENSER
Fluent Client search parameter constant for intended-dispenserDescription: Returns prescriptions intended to be dispensed by this Organization
Type: reference
Path: MedicationRequest.dispenseRequest.performer
-
INCLUDE_INTENDED_DISPENSER
public static final ca.uhn.fhir.model.api.Include INCLUDE_INTENDED_DISPENSER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:intended-dispenser".
-
SP_AUTHOREDON
public static final String SP_AUTHOREDON
Search parameter: authoredonDescription: Return prescriptions written on this date
Type: date
Path: MedicationRequest.authoredOn
- See Also:
- Constant Field Values
-
AUTHOREDON
public static final ca.uhn.fhir.rest.gclient.DateClientParam AUTHOREDON
Fluent Client search parameter constant for authoredonDescription: Return prescriptions written on this date
Type: date
Path: MedicationRequest.authoredOn
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Return prescriptions of this medication code
Type: token
Path: MedicationRequest.medicationCodeableConcept
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Return prescriptions of this medication code
Type: token
Path: MedicationRequest.medicationCodeableConcept
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient to list orders for
Type: reference
Path: MedicationRequest.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 to list orders for
Type: reference
Path: MedicationRequest.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 "MedicationRequest:subject".
-
SP_MEDICATION
public static final String SP_MEDICATION
Search parameter: medicationDescription: Return prescriptions of this medication reference
Type: reference
Path: MedicationRequest.medicationReference
- See Also:
- Constant Field Values
-
MEDICATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
Fluent Client search parameter constant for medicationDescription: Return prescriptions of this medication reference
Type: reference
Path: MedicationRequest.medicationReference
-
INCLUDE_MEDICATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_MEDICATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:medication".
-
SP_PRIORITY
public static final String SP_PRIORITY
Search parameter: priorityDescription: Returns prescriptions with different priorities
Type: token
Path: MedicationRequest.priority
- See Also:
- Constant Field Values
-
PRIORITY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY
Fluent Client search parameter constant for priorityDescription: Returns prescriptions with different priorities
Type: token
Path: MedicationRequest.priority
-
SP_INTENT
public static final String SP_INTENT
Search parameter: intentDescription: Returns prescriptions with different intents
Type: token
Path: MedicationRequest.intent
- See Also:
- Constant Field Values
-
INTENT
public static final ca.uhn.fhir.rest.gclient.TokenClientParam INTENT
Fluent Client search parameter constant for intentDescription: Returns prescriptions with different intents
Type: token
Path: MedicationRequest.intent
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Returns prescriptions for a specific patient
Type: reference
Path: MedicationRequest.subject
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Returns prescriptions for a specific patient
Type: reference
Path: MedicationRequest.subject
-
INCLUDE_PATIENT
public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:patient".
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Return prescriptions with this encounter or episode of care identifier
Type: reference
Path: MedicationRequest.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: Return prescriptions with this encounter or episode of care identifier
Type: reference
Path: MedicationRequest.context
-
INCLUDE_CONTEXT
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationRequest:context".
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Returns prescriptions with different categories
Type: token
Path: MedicationRequest.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: Returns prescriptions with different categories
Type: token
Path: MedicationRequest.category
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Status of the prescription
Type: token
Path: MedicationRequest.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Status of the prescription
Type: token
Path: MedicationRequest.status
-
-
Constructor Detail
-
MedicationRequest
public MedicationRequest()
Constructor
-
MedicationRequest
public MedicationRequest(Enumeration<MedicationRequest.MedicationRequestIntent> intent, Type medication, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(This records 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. For example a re-imbursement system might issue its own id for each prescription that is created. This is particularly important where FHIR only provides part of an entire workflow process where records must be tracked through an entire system.)
-
setIdentifier
public MedicationRequest setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public MedicationRequest addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getDefinition
public List<Reference> getDefinition()
- Returns:
definition(Protocol or definition followed by this request.)
-
setDefinition
public MedicationRequest setDefinition(List<Reference> theDefinition)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDefinition
public boolean hasDefinition()
-
addDefinition
public Reference addDefinition()
-
addDefinition
public MedicationRequest addDefinition(Reference t)
-
getDefinitionFirstRep
public Reference getDefinitionFirstRep()
- Returns:
- The first repetition of repeating field
definition, creating it if it does not already exist
-
getDefinitionTarget
@Deprecated public List<Resource> getDefinitionTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn(A plan or request that is fulfilled in whole or in part by this medication request.)
-
setBasedOn
public MedicationRequest setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public MedicationRequest addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<Resource> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getGroupIdentifier
public Identifier getGroupIdentifier()
- Returns:
groupIdentifier(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.)
-
hasGroupIdentifier
public boolean hasGroupIdentifier()
-
setGroupIdentifier
public MedicationRequest setGroupIdentifier(Identifier value)
- Parameters:
value-groupIdentifier(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.)
-
getStatusElement
public Enumeration<MedicationRequest.MedicationRequestStatus> getStatusElement()
- Returns:
status(A code specifying the current state of the order. Generally this will be active or completed state.). 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 MedicationRequest setStatusElement(Enumeration<MedicationRequest.MedicationRequestStatus> value)
- Parameters:
value-status(A code specifying the current state of the order. Generally this will be active or completed state.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public MedicationRequest.MedicationRequestStatus getStatus()
- Returns:
- A code specifying the current state of the order. Generally this will be active or completed state.
-
setStatus
public MedicationRequest setStatus(MedicationRequest.MedicationRequestStatus value)
- Parameters:
value- A code specifying the current state of the order. Generally this will be active or completed state.
-
getIntentElement
public Enumeration<MedicationRequest.MedicationRequestIntent> getIntentElement()
- Returns:
intent(Whether the request is a proposal, plan, or an original order.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
hasIntentElement
public boolean hasIntentElement()
-
hasIntent
public boolean hasIntent()
-
setIntentElement
public MedicationRequest setIntentElement(Enumeration<MedicationRequest.MedicationRequestIntent> value)
- Parameters:
value-intent(Whether the request is a proposal, plan, or an original order.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
getIntent
public MedicationRequest.MedicationRequestIntent getIntent()
- Returns:
- Whether the request is a proposal, plan, or an original order.
-
setIntent
public MedicationRequest setIntent(MedicationRequest.MedicationRequestIntent value)
- Parameters:
value- Whether the request is a proposal, plan, or an original order.
-
getCategory
public CodeableConcept getCategory()
- Returns:
category(Indicates the type of medication order and where the medication is expected to be consumed or administered.)
-
hasCategory
public boolean hasCategory()
-
setCategory
public MedicationRequest setCategory(CodeableConcept value)
- Parameters:
value-category(Indicates the type of medication order and where the medication is expected to be consumed or administered.)
-
getPriorityElement
public Enumeration<MedicationRequest.MedicationRequestPriority> getPriorityElement()
- Returns:
priority(Indicates how quickly the Medication Request should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
public boolean hasPriorityElement()
-
hasPriority
public boolean hasPriority()
-
setPriorityElement
public MedicationRequest setPriorityElement(Enumeration<MedicationRequest.MedicationRequestPriority> value)
- Parameters:
value-priority(Indicates how quickly the Medication Request should be addressed with respect to other requests.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
public MedicationRequest.MedicationRequestPriority getPriority()
- Returns:
- Indicates how quickly the Medication Request should be addressed with respect to other requests.
-
setPriority
public MedicationRequest setPriority(MedicationRequest.MedicationRequestPriority value)
- Parameters:
value- Indicates how quickly the Medication Request should be addressed with respect to other requests.
-
getMedication
public Type getMedication()
- Returns:
medication(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.)
-
getMedicationCodeableConcept
public CodeableConcept getMedicationCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
medication(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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMedicationCodeableConcept
public boolean hasMedicationCodeableConcept()
-
getMedicationReference
public Reference getMedicationReference() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
medication(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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMedicationReference
public boolean hasMedicationReference()
-
hasMedication
public boolean hasMedication()
-
setMedication
public MedicationRequest setMedication(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value-medication(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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getSubject
public Reference getSubject()
- Returns:
subject(A link to a resource representing the person or set of individuals to whom the medication will be given.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public MedicationRequest setSubject(Reference value)
- Parameters:
value-subject(A link to a resource representing the person or set of individuals to whom the medication will be given.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subjectThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person or set of individuals to whom the medication will be given.)
-
setSubjectTarget
public MedicationRequest setSubjectTarget(Resource value)
- Parameters:
value-subjectThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing the person or set of individuals to whom the medication will be given.)
-
getContext
public Reference getContext()
- Returns:
context(A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)
-
hasContext
public boolean hasContext()
-
setContext
public MedicationRequest setContext(Reference value)
- Parameters:
value-context(A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
contextThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)
-
setContextTarget
public MedicationRequest setContextTarget(Resource value)
- Parameters:
value-contextThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to an encounter, or episode of care, that identifies the particular occurrence or set occurrences of contact between patient and health care provider.)
-
getSupportingInformation
public List<Reference> getSupportingInformation()
- Returns:
supportingInformation(Include additional information (for example, patient height and weight) that supports the ordering of the medication.)
-
setSupportingInformation
public MedicationRequest setSupportingInformation(List<Reference> theSupportingInformation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInformation
public boolean hasSupportingInformation()
-
addSupportingInformation
public Reference addSupportingInformation()
-
addSupportingInformation
public MedicationRequest addSupportingInformation(Reference t)
-
getSupportingInformationFirstRep
public Reference getSupportingInformationFirstRep()
- Returns:
- The first repetition of repeating field
supportingInformation, creating it if it does not already exist
-
getSupportingInformationTarget
@Deprecated public List<Resource> getSupportingInformationTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getAuthoredOnElement
public DateTimeType getAuthoredOnElement()
- Returns:
authoredOn(The date (and perhaps time) when the prescription was initially written or authored on.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
hasAuthoredOnElement
public boolean hasAuthoredOnElement()
-
hasAuthoredOn
public boolean hasAuthoredOn()
-
setAuthoredOnElement
public MedicationRequest setAuthoredOnElement(DateTimeType value)
- Parameters:
value-authoredOn(The date (and perhaps time) when the prescription was initially written or authored on.). This is the underlying object with id, value and extensions. The accessor "getAuthoredOn" gives direct access to the value
-
getAuthoredOn
public Date getAuthoredOn()
- Returns:
- The date (and perhaps time) when the prescription was initially written or authored on.
-
setAuthoredOn
public MedicationRequest setAuthoredOn(Date value)
- Parameters:
value- The date (and perhaps time) when the prescription was initially written or authored on.
-
getRequester
public MedicationRequest.MedicationRequestRequesterComponent getRequester()
- Returns:
requester(The individual, organization or device that initiated the request and has responsibility for its activation.)
-
hasRequester
public boolean hasRequester()
-
setRequester
public MedicationRequest setRequester(MedicationRequest.MedicationRequestRequesterComponent value)
- Parameters:
value-requester(The individual, organization or device that initiated the request and has responsibility for its activation.)
-
getRecorder
public Reference getRecorder()
- Returns:
recorder(The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)
-
hasRecorder
public boolean hasRecorder()
-
setRecorder
public MedicationRequest setRecorder(Reference value)
- Parameters:
value-recorder(The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)
-
getRecorderTarget
public Practitioner getRecorderTarget()
- Returns:
recorderThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)
-
setRecorderTarget
public MedicationRequest setRecorderTarget(Practitioner value)
- Parameters:
value-recorderThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person who entered the order on behalf of another individual for example in the case of a verbal or a telephone order.)
-
getReasonCode
public List<CodeableConcept> getReasonCode()
- Returns:
reasonCode(The reason or the indication for ordering the medication.)
-
setReasonCode
public MedicationRequest setReasonCode(List<CodeableConcept> theReasonCode)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonCode
public boolean hasReasonCode()
-
addReasonCode
public CodeableConcept addReasonCode()
-
addReasonCode
public MedicationRequest addReasonCode(CodeableConcept t)
-
getReasonCodeFirstRep
public CodeableConcept getReasonCodeFirstRep()
- Returns:
- The first repetition of repeating field
reasonCode, creating it if it does not already exist
-
getReasonReference
public List<Reference> getReasonReference()
- Returns:
reasonReference(Condition or observation that supports why the medication was ordered.)
-
setReasonReference
public MedicationRequest setReasonReference(List<Reference> theReasonReference)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReasonReference
public boolean hasReasonReference()
-
addReasonReference
public Reference addReasonReference()
-
addReasonReference
public MedicationRequest addReasonReference(Reference t)
-
getReasonReferenceFirstRep
public Reference getReasonReferenceFirstRep()
- Returns:
- The first repetition of repeating field
reasonReference, creating it if it does not already exist
-
getReasonReferenceTarget
@Deprecated public List<Resource> getReasonReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getNote
public List<Annotation> getNote()
- Returns:
note(Extra information about the prescription that could not be conveyed by the other attributes.)
-
setNote
public MedicationRequest setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public MedicationRequest addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist
-
getDosageInstruction
public List<Dosage> getDosageInstruction()
- Returns:
dosageInstruction(Indicates how the medication is to be used by the patient.)
-
setDosageInstruction
public MedicationRequest setDosageInstruction(List<Dosage> theDosageInstruction)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDosageInstruction
public boolean hasDosageInstruction()
-
addDosageInstruction
public Dosage addDosageInstruction()
-
addDosageInstruction
public MedicationRequest addDosageInstruction(Dosage t)
-
getDosageInstructionFirstRep
public Dosage getDosageInstructionFirstRep()
- Returns:
- The first repetition of repeating field
dosageInstruction, creating it if it does not already exist
-
getDispenseRequest
public MedicationRequest.MedicationRequestDispenseRequestComponent getDispenseRequest()
- Returns:
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). 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.)
-
hasDispenseRequest
public boolean hasDispenseRequest()
-
setDispenseRequest
public MedicationRequest setDispenseRequest(MedicationRequest.MedicationRequestDispenseRequestComponent value)
- Parameters:
value-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). 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.)
-
getSubstitution
public MedicationRequest.MedicationRequestSubstitutionComponent getSubstitution()
- Returns:
substitution(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.)
-
hasSubstitution
public boolean hasSubstitution()
-
setSubstitution
public MedicationRequest setSubstitution(MedicationRequest.MedicationRequestSubstitutionComponent value)
- Parameters:
value-substitution(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.)
-
getPriorPrescription
public Reference getPriorPrescription()
- Returns:
priorPrescription(A link to a resource representing an earlier order related order or prescription.)
-
hasPriorPrescription
public boolean hasPriorPrescription()
-
setPriorPrescription
public MedicationRequest setPriorPrescription(Reference value)
- Parameters:
value-priorPrescription(A link to a resource representing an earlier order related order or prescription.)
-
getPriorPrescriptionTarget
public MedicationRequest getPriorPrescriptionTarget()
- Returns:
priorPrescriptionThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A link to a resource representing an earlier order related order or prescription.)
-
setPriorPrescriptionTarget
public MedicationRequest setPriorPrescriptionTarget(MedicationRequest value)
- Parameters:
value-priorPrescriptionThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (A link to a resource representing an earlier order related order or prescription.)
-
getDetectedIssue
public List<Reference> getDetectedIssue()
- Returns:
detectedIssue(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.)
-
setDetectedIssue
public MedicationRequest setDetectedIssue(List<Reference> theDetectedIssue)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDetectedIssue
public boolean hasDetectedIssue()
-
addDetectedIssue
public Reference addDetectedIssue()
-
addDetectedIssue
public MedicationRequest addDetectedIssue(Reference t)
-
getDetectedIssueFirstRep
public Reference getDetectedIssueFirstRep()
- Returns:
- The first repetition of repeating field
detectedIssue, creating it if it does not already exist
-
getDetectedIssueTarget
@Deprecated public List<DetectedIssue> getDetectedIssueTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addDetectedIssueTarget
@Deprecated public DetectedIssue addDetectedIssueTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getEventHistory
public List<Reference> getEventHistory()
- Returns:
eventHistory(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.)
-
setEventHistory
public MedicationRequest setEventHistory(List<Reference> theEventHistory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEventHistory
public boolean hasEventHistory()
-
addEventHistory
public Reference addEventHistory()
-
addEventHistory
public MedicationRequest addEventHistory(Reference t)
-
getEventHistoryFirstRep
public Reference getEventHistoryFirstRep()
- Returns:
- The first repetition of repeating field
eventHistory, creating it if it does not already exist
-
getEventHistoryTarget
@Deprecated public List<Provenance> getEventHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addEventHistoryTarget
@Deprecated public Provenance addEventHistoryTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
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 MedicationRequest copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected MedicationRequest 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
-
-