Package org.hl7.fhir.dstu2.model
Class MedicationStatement
java.lang.Object
org.hl7.fhir.dstu2.model.Base
org.hl7.fhir.dstu2.model.BaseResource
org.hl7.fhir.dstu2.model.Resource
org.hl7.fhir.dstu2.model.DomainResource
org.hl7.fhir.dstu2.model.MedicationStatement
- 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
A record of a medication that is being consumed by a patient. A
MedicationStatement 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 e.g. 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 medication statement and a medication
administration is that the medication administration has complete
administration information and is based on actual administration information
from the person who administered the medication. A medication statement 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 statement 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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected DateTimeType
The date when the medication statement was asserted by the information source.Indicates how the medication is/was used by the patient.protected Type
The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).protected List
<Identifier> External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource.protected Reference
The person who provided the information about the taking of this medication.protected Resource
The actual object that is the target of the reference (The person who provided the information about the taking of this medication.)protected Type
Identifies the medication being administered.protected StringType
Provides extra information about the medication statement that is not conveyed by the other attributes.protected Reference
The person or animal who is/was taking the medication.protected Patient
The actual object that is the target of the reference (The person or animal who is/was taking the medication.)protected Type
A reason for why the medication is being/was taken.protected List
<CodeableConcept> A code indicating why the medication was not taken.static final String
static final String
static final String
static final String
static final String
static final String
static final String
A code representing the patient or other source's judgment about the state of the medication used that this statement is about.Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.The actual objects that are the target of the reference (Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.)protected BooleanType
Set this to true if the record is saying that the medication was NOT taken.Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionMedicationStatement
(Reference patient, Enumeration<MedicationStatement.MedicationStatementStatus> status, Type medication) -
Method Summary
Modifier and TypeMethodDescriptioncopy()
boolean
equalsDeep
(Base other) boolean
equalsShallow
(Base other) fhirType()
getNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> childrenList) setDateAsserted
(Date value) setEffective
(Type value) setInformationSource
(Reference value) setMedication
(Type value) setNoteElement
(StringType value) setPatient
(Reference value) setPatientTarget
(Patient value) void
setProperty
(String name, Base value) setReasonForUse
(Type value) setWasNotTaken
(boolean value) setWasNotTakenElement
(BooleanType value) protected MedicationStatement
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionByUrl, getModifierExtension, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setText
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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, isDeleted, setId
-
Field Details
-
identifier
External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated. -
patient
The person or animal who is/was taking the medication. -
patientTarget
The actual object that is the target of the reference (The person or animal who is/was taking the medication.) -
informationSource
The person who provided the information about the taking of this medication. -
informationSourceTarget
The actual object that is the target of the reference (The person who provided the information about the taking of this medication.) -
dateAsserted
The date when the medication statement was asserted by the information source. -
status
A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed. -
wasNotTaken
Set this to true if the record is saying that the medication was NOT taken. -
reasonNotTaken
A code indicating why the medication was not taken. -
reasonForUse
A reason for why the medication is being/was taken. -
effective
The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true). -
note
Provides extra information about the medication statement that is not conveyed by the other attributes. -
supportingInformation
Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement. -
supportingInformationTarget
The actual objects that are the target of the reference (Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.) -
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. -
dosage
Indicates how the medication is/was used by the patient. -
SP_IDENTIFIER
- See Also:
-
SP_CODE
- See Also:
-
SP_PATIENT
- See Also:
-
SP_MEDICATION
- See Also:
-
SP_SOURCE
- See Also:
-
SP_EFFECTIVEDATE
- See Also:
-
SP_STATUS
- See Also:
-
-
Constructor Details
-
MedicationStatement
public MedicationStatement() -
MedicationStatement
public MedicationStatement(Reference patient, Enumeration<MedicationStatement.MedicationStatementStatus> status, Type medication)
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.)
-
hasIdentifier
-
addIdentifier
- Returns:
identifier
(External identifier - FHIR will generate its own internal identifiers (probably URLs) which do not need to be explicitly managed by the resource. The identifier here is one that would be used by another non-FHIR system - for example an automated medication pump would provide a record each time it operated; an administration while the patient was off the ward might be made with a different system and entered after the event. Particularly important if these records have to be updated.)
-
addIdentifier
-
getPatient
- Returns:
patient
(The person or animal who is/was taking the medication.)
-
hasPatient
-
setPatient
- Parameters:
value
-patient
(The person or animal who is/was taking the medication.)
-
getPatientTarget
- Returns:
patient
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person or animal who is/was taking the medication.)
-
setPatientTarget
- Parameters:
value
-patient
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person or animal who is/was taking the medication.)
-
getInformationSource
- Returns:
informationSource
(The person who provided the information about the taking of this medication.)
-
hasInformationSource
-
setInformationSource
- Parameters:
value
-informationSource
(The person who provided the information about the taking of this medication.)
-
getInformationSourceTarget
- Returns:
informationSource
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person who provided the information about the taking of this medication.)
-
setInformationSourceTarget
- Parameters:
value
-informationSource
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person who provided the information about the taking of this medication.)
-
getDateAssertedElement
- Returns:
dateAsserted
(The date when the medication statement 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 statement 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 statement was asserted by the information source.
-
setDateAsserted
- Parameters:
value
- The date when the medication statement was asserted by the information source.
-
getStatusElement
- Returns:
status
(A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
public MedicationStatement setStatusElement(Enumeration<MedicationStatement.MedicationStatementStatus> value) - Parameters:
value
-status
(A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.). 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 patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.
-
setStatus
- Parameters:
value
- A code representing the patient or other source's judgment about the state of the medication used that this statement is about. Generally this will be active or completed.
-
getWasNotTakenElement
- Returns:
wasNotTaken
(Set this to true if the record is saying that the medication was NOT taken.). This is the underlying object with id, value and extensions. The accessor "getWasNotTaken" gives direct access to the value
-
hasWasNotTakenElement
-
hasWasNotTaken
-
setWasNotTakenElement
- Parameters:
value
-wasNotTaken
(Set this to true if the record is saying that the medication was NOT taken.). This is the underlying object with id, value and extensions. The accessor "getWasNotTaken" gives direct access to the value
-
getWasNotTaken
- Returns:
- Set this to true if the record is saying that the medication was NOT taken.
-
setWasNotTaken
- Parameters:
value
- Set this to true if the record is saying that the medication was NOT taken.
-
getReasonNotTaken
- Returns:
reasonNotTaken
(A code indicating why the medication was not taken.)
-
hasReasonNotTaken
-
addReasonNotTaken
- Returns:
reasonNotTaken
(A code indicating why the medication was not taken.)
-
addReasonNotTaken
-
getReasonForUse
- Returns:
reasonForUse
(A reason for why the medication is being/was taken.)
-
getReasonForUseCodeableConcept
public CodeableConcept getReasonForUseCodeableConcept() throws org.hl7.fhir.exceptions.FHIRException- Returns:
reasonForUse
(A reason for why the medication is being/was taken.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReasonForUseCodeableConcept
-
getReasonForUseReference
- Returns:
reasonForUse
(A reason for why the medication is being/was taken.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReasonForUseReference
-
hasReasonForUse
-
setReasonForUse
- Parameters:
value
-reasonForUse
(A reason for why the medication is being/was taken.)
-
getEffective
- Returns:
effective
(The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).)
-
getEffectiveDateTimeType
- Returns:
effective
(The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEffectiveDateTimeType
-
getEffectivePeriod
- Returns:
effective
(The interval of time during which it is being asserted that the patient was taking the medication (or was not taking, when the wasNotGiven element is true).)- 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 was taking the medication (or was not taking, when the wasNotGiven element is true).)
-
getNoteElement
- Returns:
note
(Provides extra information about the medication statement that is not conveyed by the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
-
hasNoteElement
-
hasNote
-
setNoteElement
- Parameters:
value
-note
(Provides extra information about the medication statement that is not conveyed by the other attributes.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
-
getNote
- Returns:
- Provides extra information about the medication statement that is not conveyed by the other attributes.
-
setNote
- Parameters:
value
- Provides extra information about the medication statement that is not conveyed by the other attributes.
-
getSupportingInformation
- Returns:
supportingInformation
(Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.)
-
hasSupportingInformation
-
addSupportingInformation
- Returns:
supportingInformation
(Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.)
-
addSupportingInformation
-
getSupportingInformationTarget
- Returns:
supportingInformation
(The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Allows linking the MedicationStatement to the underlying MedicationOrder, or to other information that supports the MedicationStatement.)
-
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.)
-
getMedicationCodeableConcept
- 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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMedicationCodeableConcept
-
getMedicationReference
- 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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasMedicationReference
-
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.)
-
getDosage
- Returns:
dosage
(Indicates how the medication is/was used by the patient.)
-
hasDosage
-
addDosage
- Returns:
dosage
(Indicates how the medication is/was used by the patient.)
-
addDosage
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
setProperty
- Overrides:
setProperty
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
-
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
-