
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static enum
static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionIndicates if the medication is being consumed or administered as instructed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for adherenceprotected List<CodeableConcept>
Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categorystatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected DateTimeType
The date when the Medication Usage was asserted by the information source.Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.Indicates how the medication is/was or should be taken by the patient.protected DataType
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).static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for effectiveprotected Reference
The encounter that establishes the context for this MedicationUsage.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected List<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.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.protected Reference
The person or organization that provided the information about the taking of this medication.protected CodeableReference
Identifies the medication being administered.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for medicationprotected List<Annotation>
Provides extra information about the Medication Usage that is not conveyed by the other attributes.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected List<CodeableReference>
A concept, Condition or observation that supports why the medication is being/was taken.protected StringType
The full representation of the dose of the medication included in all dosage instructions.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for sourcestatic final String
Search parameter: adherencestatic final String
Search parameter: categorystatic final String
Search parameter: codestatic final String
Search parameter: effectivestatic final String
Search parameter: encounterstatic final String
Search parameter: identifierstatic final String
Search parameter: medicationstatic final String
Search parameter: patientstatic final String
Search parameter: sourcestatic final String
Search parameter: statusstatic final String
Search parameter: subjectA code representing the status of recording the medication usage.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
The person, animal or group who is/was taking the medication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectFields 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
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorMedicationUsage
(MedicationUsage.MedicationUsageStatusCodes status, CodeableReference medication, Reference subject) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddNote()
copy()
void
boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setCategory
(List<CodeableConcept> theCategory) setDateAsserted
(Date value) setDerivedFrom
(List<Reference> theDerivedFrom) setEffective
(DataType value) setEncounter
(Reference value) setIdentifier
(List<Identifier> theIdentifier) setInformationSource
(Reference value) setMedication
(CodeableReference value) setNote
(List<Annotation> theNote) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReason
(List<CodeableReference> theReason) setSubject
(Reference value) protected MedicationUsage
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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
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
A code representing the status of recording the medication usage. -
category
Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.). -
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. -
subject
The person, animal or group who is/was taking the medication. -
encounter
The encounter that establishes the context for this MedicationUsage. -
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
The date when the Medication Usage was asserted by the information source. -
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
Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage. -
reason
A concept, Condition or observation that supports why the medication is being/was taken. -
note
Provides extra information about the Medication Usage that is not conveyed by the other attributes. -
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
Indicates how the medication is/was or should be taken by the patient. -
adherence
Indicates if the medication is being consumed or administered as instructed. -
SP_ADHERENCE
Search parameter: adherenceDescription: Returns statements based on adherence or compliance
Type: token
Path: MedicationUsage.adherence
- See Also:
-
ADHERENCE
Fluent Client search parameter constant for adherenceDescription: Returns statements based on adherence or compliance
Type: token
Path: MedicationUsage.adherence
-
SP_CATEGORY
Search parameter: categoryDescription: Returns statements of this category of MedicationUsage
Type: token
Path: MedicationUsage.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Returns statements of this category of MedicationUsage
Type: token
Path: MedicationUsage.category
-
SP_EFFECTIVE
Search parameter: effectiveDescription: Date when patient was taking (or not taking) the medication
Type: date
Path: MedicationUsage.effective
- See Also:
-
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
Search parameter: encounterDescription: Returns statements for a specific encounter
Type: reference
Path: MedicationUsage.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Returns statements for a specific encounter
Type: reference
Path: MedicationUsage.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:encounter". -
SP_SOURCE
Search parameter: sourceDescription: Who or where the information in the statement came from
Type: reference
Path: MedicationUsage.informationSource
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:source". -
SP_SUBJECT
Search parameter: subjectDescription: The identity of a patient, animal or group to list statements for
Type: reference
Path: MedicationUsage.subject
- See Also:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:subject". -
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:
-
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
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:
-
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
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the person who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.patient | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:patient". -
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:
-
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
Constant for fluent queries to be used to add include statements. Specifies the path value of "MedicationUsage:medication". -
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:
-
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 Details
-
MedicationUsage
public MedicationUsage()Constructor -
MedicationUsage
public MedicationUsage(MedicationUsage.MedicationUsageStatusCodes status, CodeableReference medication, Reference subject) Constructor
-
-
Method Details
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
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
-
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
- Returns:
- A code representing the status of recording the medication usage.
-
setStatus
- Parameters:
value
- A code representing the status of recording the medication usage.
-
getCategory
- Returns:
category
(Type of medication usage (for example, drug classification like ATC, where meds would be administered, legal category of the medication.).)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist {3}
-
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
-
setMedication
- 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
- Returns:
subject
(The person, animal or group who is/was taking the medication.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The person, animal or group who is/was taking the medication.)
-
getEncounter
- Returns:
encounter
(The encounter that establishes the context for this MedicationUsage.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The encounter that establishes the context for this MedicationUsage.)
-
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
- 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
-
getEffectivePeriod
- 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
-
hasEffective
-
setEffective
- 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
- 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
-
hasDateAsserted
-
setDateAssertedElement
- 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
- Returns:
- The date when the Medication Usage was asserted by the information source.
-
setDateAsserted
- Parameters:
value
- The date when the Medication Usage was asserted by the information source.
-
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
-
setInformationSource
- 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
- Returns:
derivedFrom
(Allows linking the MedicationUsage to the underlying MedicationRequest, or to other information that supports or is used to derive the MedicationUsage.)
-
setDerivedFrom
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDerivedFrom
-
addDerivedFrom
-
addDerivedFrom
-
getDerivedFromFirstRep
- Returns:
- The first repetition of repeating field
derivedFrom
, creating it if it does not already exist {3}
-
getReason
- Returns:
reason
(A concept, Condition or observation that supports why the medication is being/was taken.)
-
setReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist {3}
-
getNote
- Returns:
note
(Provides extra information about the Medication Usage that is not conveyed by the other attributes.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist {3}
-
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
-
hasRenderedDosageInstruction
-
setRenderedDosageInstructionElement
- 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
- 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
- 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
- Returns:
dosage
(Indicates how the medication is/was or should be taken by the patient.)
-
setDosage
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDosage
-
addDosage
-
addDosage
-
getDosageFirstRep
- Returns:
- The first repetition of repeating field
dosage
, creating it if it does not already exist {3}
-
getAdherence
- Returns:
adherence
(Indicates if the medication is being consumed or administered as instructed.)
-
hasAdherence
-
setAdherence
- Parameters:
value
-adherence
(Indicates if the medication is being consumed or administered as instructed.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-