Class MedicationUsage
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.model.MedicationUsage
-
- 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 MedicationUsage extends DomainResource
A record of a medication that is being consumed by a patient. A MedicationUsage may indicate that the patient may be taking the medication now or has taken the medication in the past or will be taking the medication in the future. The source of this information can be the patient, significant other (such as a family member or spouse), or a clinician. A common scenario where this information is captured is during the history taking process during a patient visit or stay. The medication information may come from sources such as the patient's memory, from a prescription bottle, or from a list of medications the patient, clinician or other party maintains. The primary difference between a medicationusage and a medicationadministration is that the medication administration has complete administration information and is based on actual administration information from the person who administered the medication. A medicationusage is often, if not always, less specific. There is no required date/time when the medication was administered, in fact we only know that a source has reported the patient is taking this medication, where details such as time, quantity, or rate or even medication product may be incomplete or missing or less precise. As stated earlier, the Medication Usage information may come from the patient's memory, from a prescription bottle or from a list of medications the patient, clinician or other party maintains. Medication administration is more formal and is not missing detailed information.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classMedicationUsage.MedicationUsageAdherenceComponentstatic classMedicationUsage.MedicationUsageStatusCodesstatic classMedicationUsage.MedicationUsageStatusCodesEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected MedicationUsage.MedicationUsageAdherenceComponentadherenceIndicates if the medication is being consumed or administered as instructed.static ca.uhn.fhir.rest.gclient.TokenClientParamADHERENCEFluent Client search parameter constant for adherenceprotected List<CodeableConcept>categoryType of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).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 DateTimeTypedateAssertedThe date when the Medication Usage was asserted by the information source.protected List<Reference>derivedFromAllows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.protected List<Dosage>dosageIndicates how the medication is/was or should be taken by the patient.protected DataTypeeffectiveThe interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.adherence element is Not Taking).static ca.uhn.fhir.rest.gclient.DateClientParamEFFECTIVEFluent Client search parameter constant for effectiveprotected ReferenceencounterThe encounter that establishes the context for this MedicationUsage.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected List<Identifier>identifierIdentifiers associated with this Medication Usage 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_ENCOUNTERConstant 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_SOURCEConstant 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.protected ReferenceinformationSourceThe person or organization that provided the information about the taking of this medication.protected CodeableReferencemedicationIdentifies the medication being administered.static ca.uhn.fhir.rest.gclient.ReferenceClientParamMEDICATIONFluent Client search parameter constant for medicationprotected List<Annotation>noteProvides extra information about the Medication Usage that is not conveyed by the other attributes.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected List<CodeableReference>reasonA concept, Condition or observation that supports why the medication is being/was taken.protected StringTyperenderedDosageInstructionThe full representation of the dose of the medication included in all dosage instructions.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSOURCEFluent Client search parameter constant for sourcestatic StringSP_ADHERENCESearch parameter: adherencestatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CODESearch parameter: codestatic StringSP_EFFECTIVESearch parameter: effectivestatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_MEDICATIONSearch parameter: medicationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_SOURCESearch parameter: sourcestatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected Enumeration<MedicationUsage.MedicationUsageStatusCodes>statusA code representing the status of recording the medication usage.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectThe person, animal or group who is/was taking the medication.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subject-
Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description MedicationUsage()ConstructorMedicationUsage(MedicationUsage.MedicationUsageStatusCodes status, CodeableReference medication, Reference subject)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
Identifiers associated with this Medication Usage 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.
-
status
protected Enumeration<MedicationUsage.MedicationUsageStatusCodes> status
A code representing the status of recording the medication usage.
-
category
protected List<CodeableConcept> category
Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).
-
medication
protected CodeableReference medication
Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.
-
encounter
protected Reference encounter
The encounter that establishes the context for this MedicationUsage.
-
effective
protected DataType effective
The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.adherence element is Not Taking).
-
dateAsserted
protected DateTimeType dateAsserted
The date when the Medication Usage was asserted by the information source.
-
informationSource
protected Reference informationSource
The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationUsage is derived from other resources, e.g. Claim or MedicationRequest.
-
derivedFrom
protected List<Reference> derivedFrom
Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.
-
reason
protected List<CodeableReference> reason
A concept, Condition or observation that supports why the medication is being/was taken.
-
note
protected List<Annotation> note
Provides extra information about the Medication Usage that is not conveyed by the other attributes.
-
renderedDosageInstruction
protected StringType renderedDosageInstruction
The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.
-
dosage
protected List<Dosage> dosage
Indicates how the medication is/was or should be taken by the patient.
-
adherence
protected MedicationUsage.MedicationUsageAdherenceComponent adherence
Indicates if the medication is being consumed or administered as instructed.
-
SP_ADHERENCE
public static final String SP_ADHERENCE
Search parameter: adherenceDescription: Returns statements based on adherence or compliance
Type: token
Path: MedicationUsage.adherence
- See Also:
- Constant Field Values
-
ADHERENCE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam ADHERENCE
Fluent Client search parameter constant for adherenceDescription: Returns statements based on adherence or compliance
Type: token
Path: MedicationUsage.adherence
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Returns statements of this category of MedicationUsage
Type: token
Path: MedicationUsage.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 statements of this category of MedicationUsage
Type: token
Path: MedicationUsage.category
-
SP_EFFECTIVE
public static final String SP_EFFECTIVE
Search parameter: effectiveDescription: Date when patient was taking (or not taking) the medication
Type: date
Path: MedicationUsage.effective
- See Also:
- Constant Field Values
-
EFFECTIVE
public static final ca.uhn.fhir.rest.gclient.DateClientParam EFFECTIVE
Fluent Client search parameter constant for effectiveDescription: Date when patient was taking (or not taking) the medication
Type: date
Path: MedicationUsage.effective
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: Returns statements for a specific encounter
Type: reference
Path: MedicationUsage.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Returns statements for a specific encounter
Type: reference
Path: MedicationUsage.encounter
-
INCLUDE_ENCOUNTER
public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:encounter".
-
SP_SOURCE
public static final String SP_SOURCE
Search parameter: sourceDescription: Who or where the information in the statement came from
Type: reference
Path: MedicationUsage.informationSource
- See Also:
- Constant Field Values
-
SOURCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SOURCE
Fluent Client search parameter constant for sourceDescription: Who or where the information in the statement came from
Type: reference
Path: MedicationUsage.informationSource
-
INCLUDE_SOURCE
public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:source".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient, animal or group to list statements for
Type: reference
Path: MedicationUsage.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, animal or group to list statements for
Type: reference
Path: MedicationUsage.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 "MedicationUsage:subject".
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
Fluent Client search parameter constant for codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure [ServiceRequest](servicerequest.html): What is being requested/ordered
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code | ServiceRequest.code
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.content.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
-
SP_PATIENT
public static final String 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:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
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 "MedicationUsage:patient".
-
SP_MEDICATION
public static final String SP_MEDICATION
Search parameter: medicationDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Return administrations of this medication reference [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference [MedicationUsage](medicationusage.html): Return statements of this medication reference
Type: reference
Path: MedicationAdministration.medication.reference | MedicationDispense.medication.reference | MedicationRequest.medication.reference | MedicationUsage.medication.reference
- See Also:
- Constant Field Values
-
MEDICATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam MEDICATION
Fluent Client search parameter constant for medicationDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): Return administrations of this medication reference [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine resource [MedicationRequest](medicationrequest.html): Return prescriptions for this medication reference [MedicationUsage](medicationusage.html): Return statements of this medication reference
Type: reference
Path: MedicationAdministration.medication.reference | MedicationDispense.medication.reference | MedicationRequest.medication.reference | MedicationUsage.medication.reference
-
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 "MedicationUsage:medication".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified) [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status [MedicationRequest](medicationrequest.html): Status of the prescription [MedicationUsage](medicationusage.html): Return statements that match the given status
Type: token
Path: MedicationAdministration.status | MedicationDispense.status | MedicationRequest.status | MedicationUsage.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Multiple Resources: [MedicationAdministration](medicationadministration.html): MedicationAdministration event status (for example one of active/paused/completed/nullified) [MedicationDispense](medicationdispense.html): Returns dispenses with a specified dispense status [MedicationRequest](medicationrequest.html): Status of the prescription [MedicationUsage](medicationusage.html): Return statements that match the given status
Type: token
Path: MedicationAdministration.status | MedicationDispense.status | MedicationRequest.status | MedicationUsage.status
-
-
Constructor Detail
-
MedicationUsage
public MedicationUsage()
Constructor
-
MedicationUsage
public MedicationUsage(MedicationUsage.MedicationUsageStatusCodes status, CodeableReference medication, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifiers associated with this Medication Usage 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.)
-
setIdentifier
public MedicationUsage setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public MedicationUsage addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getStatusElement
public Enumeration<MedicationUsage.MedicationUsageStatusCodes> getStatusElement()
- Returns:
status(A code representing the status of recording the medication usage.). 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 MedicationUsage setStatusElement(Enumeration<MedicationUsage.MedicationUsageStatusCodes> value)
- Parameters:
value-status(A code representing the status of recording the medication usage.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public MedicationUsage.MedicationUsageStatusCodes getStatus()
- Returns:
- A code representing the status of recording the medication usage.
-
setStatus
public MedicationUsage setStatus(MedicationUsage.MedicationUsageStatusCodes value)
- Parameters:
value- A code representing the status of recording the medication usage.
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).)
-
setCategory
public MedicationUsage setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public MedicationUsage addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist {3}
-
getMedication
public CodeableReference getMedication()
- Returns:
medication(Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)
-
hasMedication
public boolean hasMedication()
-
setMedication
public MedicationUsage setMedication(CodeableReference value)
- Parameters:
value-medication(Identifies the medication being administered. This is either a link to a resource representing the details of the medication or a simple attribute carrying a code that identifies the medication from a known list of medications.)
-
getSubject
public Reference getSubject()
- Returns:
subject(The person, animal or group who is/was taking the medication.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public MedicationUsage setSubject(Reference value)
- Parameters:
value-subject(The person, animal or group who is/was taking the medication.)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The encounter that establishes the context for this MedicationUsage.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public MedicationUsage setEncounter(Reference value)
- Parameters:
value-encounter(The encounter that establishes the context for this MedicationUsage.)
-
getEffective
public DataType getEffective()
- Returns:
effective(The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.adherence element is Not Taking).)
-
getEffectiveDateTimeType
public DateTimeType getEffectiveDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
effective(The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.adherence element is Not Taking).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEffectiveDateTimeType
public boolean hasEffectiveDateTimeType()
-
getEffectivePeriod
public Period getEffectivePeriod() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
effective(The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.adherence element is Not Taking).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEffectivePeriod
public boolean hasEffectivePeriod()
-
hasEffective
public boolean hasEffective()
-
setEffective
public MedicationUsage setEffective(DataType value)
- Parameters:
value-effective(The interval of time during which it is being asserted that the patient is/was/will be taking the medication (or was not taking, when the MedicationUsage.adherence element is Not Taking).)
-
getDateAssertedElement
public DateTimeType getDateAssertedElement()
- Returns:
dateAsserted(The date when the Medication Usage was asserted by the information source.). This is the underlying object with id, value and extensions. The accessor "getDateAsserted" gives direct access to the value
-
hasDateAssertedElement
public boolean hasDateAssertedElement()
-
hasDateAsserted
public boolean hasDateAsserted()
-
setDateAssertedElement
public MedicationUsage setDateAssertedElement(DateTimeType value)
- Parameters:
value-dateAsserted(The date when the Medication Usage was asserted by the information source.). This is the underlying object with id, value and extensions. The accessor "getDateAsserted" gives direct access to the value
-
getDateAsserted
public Date getDateAsserted()
- Returns:
- The date when the Medication Usage was asserted by the information source.
-
setDateAsserted
public MedicationUsage setDateAsserted(Date value)
- Parameters:
value- The date when the Medication Usage was asserted by the information source.
-
getInformationSource
public Reference getInformationSource()
- Returns:
informationSource(The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationUsage is derived from other resources, e.g. Claim or MedicationRequest.)
-
hasInformationSource
public boolean hasInformationSource()
-
setInformationSource
public MedicationUsage setInformationSource(Reference value)
- Parameters:
value-informationSource(The person or organization that provided the information about the taking of this medication. Note: Use derivedFrom when a MedicationUsage is derived from other resources, e.g. Claim or MedicationRequest.)
-
getDerivedFrom
public List<Reference> getDerivedFrom()
- Returns:
derivedFrom(Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.)
-
setDerivedFrom
public MedicationUsage setDerivedFrom(List<Reference> theDerivedFrom)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDerivedFrom
public boolean hasDerivedFrom()
-
addDerivedFrom
public Reference addDerivedFrom()
-
addDerivedFrom
public MedicationUsage addDerivedFrom(Reference t)
-
getDerivedFromFirstRep
public Reference getDerivedFromFirstRep()
- Returns:
- The first repetition of repeating field
derivedFrom, creating it if it does not already exist {3}
-
getReason
public List<CodeableReference> getReason()
- Returns:
reason(A concept, Condition or observation that supports why the medication is being/was taken.)
-
setReason
public MedicationUsage setReason(List<CodeableReference> theReason)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReason
public boolean hasReason()
-
addReason
public CodeableReference addReason()
-
addReason
public MedicationUsage addReason(CodeableReference t)
-
getReasonFirstRep
public CodeableReference getReasonFirstRep()
- Returns:
- The first repetition of repeating field
reason, creating it if it does not already exist {3}
-
getNote
public List<Annotation> getNote()
- Returns:
note(Provides extra information about the Medication Usage that is not conveyed by the other attributes.)
-
setNote
public MedicationUsage setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public MedicationUsage addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist {3}
-
getRenderedDosageInstructionElement
public StringType getRenderedDosageInstructionElement()
- Returns:
renderedDosageInstruction(The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.). This is the underlying object with id, value and extensions. The accessor "getRenderedDosageInstruction" gives direct access to the value
-
hasRenderedDosageInstructionElement
public boolean hasRenderedDosageInstructionElement()
-
hasRenderedDosageInstruction
public boolean hasRenderedDosageInstruction()
-
setRenderedDosageInstructionElement
public MedicationUsage setRenderedDosageInstructionElement(StringType value)
- Parameters:
value-renderedDosageInstruction(The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.). This is the underlying object with id, value and extensions. The accessor "getRenderedDosageInstruction" gives direct access to the value
-
getRenderedDosageInstruction
public String getRenderedDosageInstruction()
- Returns:
- The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.
-
setRenderedDosageInstruction
public MedicationUsage setRenderedDosageInstruction(String value)
- Parameters:
value- The full representation of the dose of the medication included in all dosage instructions. To be used when multiple dosage instructions are included to represent complex dosing such as increasing or tapering doses.
-
getDosage
public List<Dosage> getDosage()
- Returns:
dosage(Indicates how the medication is/was or should be taken by the patient.)
-
setDosage
public MedicationUsage setDosage(List<Dosage> theDosage)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasDosage
public boolean hasDosage()
-
addDosage
public MedicationUsage addDosage(Dosage t)
-
getDosageFirstRep
public Dosage getDosageFirstRep()
- Returns:
- The first repetition of repeating field
dosage, creating it if it does not already exist {3}
-
getAdherence
public MedicationUsage.MedicationUsageAdherenceComponent getAdherence()
- Returns:
adherence(Indicates if the medication is being consumed or administered as instructed.)
-
hasAdherence
public boolean hasAdherence()
-
setAdherence
public MedicationUsage setAdherence(MedicationUsage.MedicationUsageAdherenceComponent value)
- Parameters:
value-adherence(Indicates if the medication is being consumed or administered as instructed.)
-
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 MedicationUsage copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(MedicationUsage dst)
-
typedCopy
protected MedicationUsage 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
-
-