Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.MedicationStatement

class HS.FHIR.DTL.vR4.Model.Resource.MedicationStatement extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

Record of medication being taken by a patient.

Property Inventory

Parameters

parameter ELEMENTQUALIFIED = 1;
Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = MedicationStatement;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLPROJECTION = ELEMENT;
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = MedicationStatement;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.

Properties

property basedOn as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "basedOn", XMLPROJECTION = "ELEMENT");
Reference

Fulfils plan, proposal or order.

MedicationRequest | CarePlan | ServiceRequest

Property methods: basedOnBuildValueArray(), basedOnCollectionToDisplay(), basedOnCollectionToOdbc(), basedOnDisplayToCollection(), basedOnGet(), basedOnGetObject(), basedOnGetObjectId(), basedOnGetSwizzled(), basedOnIsValid(), basedOnOdbcToCollection(), basedOnSet(), basedOnSetObject(), basedOnSetObjectId()
property category as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of medication usage.

medication-statement-category is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in medication-statement-category, you may use codes from any ValueSet.

Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property context as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
Reference

Encounter / Episode associated with MedicationStatement.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property dateAsserted as %String (MAXLEN = 1000000, XMLNAME = "dateAsserted", XMLPROJECTION = "ATTRIBUTE");
dateTime

When the statement was asserted?

Property methods: dateAssertedDisplayToLogical(), dateAssertedGet(), dateAssertedIsValid(), dateAssertedLogicalToDisplay(), dateAssertedLogicalToOdbc(), dateAssertedNormalize(), dateAssertedSet()
property derivedFrom as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "derivedFrom", XMLPROJECTION = "ELEMENT");
Reference

Additional supporting information.

Any FHIR4 Resource may be indicated by this Reference

Property methods: derivedFromBuildValueArray(), derivedFromCollectionToDisplay(), derivedFromCollectionToOdbc(), derivedFromDisplayToCollection(), derivedFromGet(), derivedFromGetObject(), derivedFromGetObjectId(), derivedFromGetSwizzled(), derivedFromIsValid(), derivedFromOdbcToCollection(), derivedFromSet(), derivedFromSetObject(), derivedFromSetObjectId()
property dosage as list of HS.FHIR.DTL.vR4.Model.Element.Dosage (XMLNAME = "dosage", XMLPROJECTION = "ELEMENT");
Dosage

Details of how medication is/was taken or should be taken.

Property methods: dosageBuildValueArray(), dosageCollectionToDisplay(), dosageCollectionToOdbc(), dosageDisplayToCollection(), dosageGet(), dosageGetObject(), dosageGetObjectId(), dosageGetSwizzled(), dosageIsValid(), dosageOdbcToCollection(), dosageSet(), dosageSetObject(), dosageSetObjectId()
property effectiveDateTime as %String (MAXLEN = 1000000, XMLNAME = "effectiveDateTime", XMLPROJECTION = "ATTRIBUTE");
dateTime

The date/time or interval when the medication is/was/will be taken.

Property methods: effectiveDateTimeDisplayToLogical(), effectiveDateTimeGet(), effectiveDateTimeIsValid(), effectiveDateTimeLogicalToDisplay(), effectiveDateTimeLogicalToOdbc(), effectiveDateTimeNormalize(), effectiveDateTimeSet()
property effectivePeriod as HS.FHIR.DTL.vR4.Model.Datatype.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
Period

The date/time or interval when the medication is/was/will be taken.

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property identifier as list of HS.FHIR.DTL.vR4.Model.Datatype.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
Identifier

External identifier.

Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property informationSource as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "informationSource", XMLPROJECTION = "ELEMENT");
Reference

Person or organization that provided the information about the taking of this medication.

Patient | Practitioner | PractitionerRole | RelatedPerson | Organization

Property methods: informationSourceGet(), informationSourceGetSwizzled(), informationSourceIsValid(), informationSourceNewObject(), informationSourceSet()
property medicationCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What medication was taken.

any FHIR4 code may be used; medication-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "medicationReference", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

What medication was taken.

Medication.

Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property note as list of HS.FHIR.DTL.vR4.Model.Datatype.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Annotation

Further information about the statement.

Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
Reference

Part of referenced event.

MedicationAdministration | MedicationDispense | MedicationStatement | Procedure | Observation

Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for why the medication is being/was taken.

any FHIR4 code may be used; condition-code shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonReference as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Reference

Condition or observation that supports why the medication is being/was taken.

Condition | Observation | DiagnosticReport

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

active | completed | entered-in-error | intended | stopped | on-hold | unknown | not-taken

medication-statement-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend medication-statement-status|4.0.1 and you may NOT use codes from other ValueSets.

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusReasonBuildValueArray(), statusReasonCollectionToDisplay(), statusReasonCollectionToOdbc(), statusReasonDisplayToCollection(), statusReasonGet(), statusReasonGetObject(), statusReasonGetObjectId(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonOdbcToCollection(), statusReasonSet(), statusReasonSetObject(), statusReasonSetObjectId(), statusSet()
property statusReason as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "statusReason", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason for current status.

any FHIR4 code may be used; reason-medication-status-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: statusReasonBuildValueArray(), statusReasonCollectionToDisplay(), statusReasonCollectionToOdbc(), statusReasonDisplayToCollection(), statusReasonGet(), statusReasonGetObject(), statusReasonGetObjectId(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonOdbcToCollection(), statusReasonSet(), statusReasonSetObject(), statusReasonSetObjectId()
property subject as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who is/was taking the medication.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab