Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.MedicationStatement

class HS.FHIR.DTL.vDSTU2.Model.Resource.MedicationStatement extends HS.FHIR.DTL.vDSTU2.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 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 dosage as list of HS.FHIR.DTL.vDSTU2.Model.Element.MedicationStatement.dosage (XMLNAME = "dosage", XMLPROJECTION = "ELEMENT");
BackboneElement

Details of how medication was 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

Over what period was medication consumed?

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

Over what period was medication consumed?

Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property identifier as list of HS.FHIR.DTL.vDSTU2.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.vDSTU2.Model.Base.Reference (XMLNAME = "informationSource", XMLPROJECTION = "ELEMENT");
Reference

Patient | Practitioner | RelatedPerson

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

What medication was taken.

any FHIR2 code from any ValueSet may be used.

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

What medication was taken.

Medication.

Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property note as %String (MAXLEN = 1000000, XMLNAME = "note", XMLPROJECTION = "ATTRIBUTE");
string

Further information about the statement.

Property methods: noteDisplayToLogical(), noteGet(), noteIsValid(), noteLogicalToDisplay(), noteLogicalToOdbc(), noteNormalize(), noteSet()
property patient as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "patient", XMLPROJECTION = "ELEMENT") [ Required ];
Reference

Who is/was taking the medication.

Patient

Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property reasonForUseCodeableConcept as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reasonForUseCodeableConcept", XMLPROJECTION = "ELEMENT");
CodeableConcept

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

Property methods: reasonForUseCodeableConceptGet(), reasonForUseCodeableConceptGetSwizzled(), reasonForUseCodeableConceptIsValid(), reasonForUseCodeableConceptNewObject(), reasonForUseCodeableConceptSet()
property reasonForUseReference as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "reasonForUseReference", XMLPROJECTION = "ELEMENT");
Reference

Condition.

Property methods: reasonForUseReferenceGet(), reasonForUseReferenceGetSwizzled(), reasonForUseReferenceIsValid(), reasonForUseReferenceNewObject(), reasonForUseReferenceSet()
property reasonNotTaken as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reasonNotTaken", XMLPROJECTION = "ELEMENT");
CodeableConcept

True if asserting medication was not given.

any FHIR2 code may be used; reason-medication-not-given-codes shows EXAMPLE codes, but you may use codes from any ValueSet.

Property methods: reasonNotTakenBuildValueArray(), reasonNotTakenCollectionToDisplay(), reasonNotTakenCollectionToOdbc(), reasonNotTakenDisplayToCollection(), reasonNotTakenGet(), reasonNotTakenGetObject(), reasonNotTakenGetObjectId(), reasonNotTakenGetSwizzled(), reasonNotTakenIsValid(), reasonNotTakenOdbcToCollection(), reasonNotTakenSet(), reasonNotTakenSetObject(), reasonNotTakenSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

active | completed | entered-in-error | intended

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property supportingInformation as list of HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Reference

Additional supporting information.

Any FHIR2 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()
property wasNotTaken as %Boolean (XMLNAME = "wasNotTaken", XMLPROJECTION = "ATTRIBUTE");
boolean

True if medication is/was not being taken.

Property methods: wasNotTakenDisplayToLogical(), wasNotTakenGet(), wasNotTakenIsValid(), wasNotTakenLogicalToDisplay(), wasNotTakenLogicalToXSD(), wasNotTakenNormalize(), wasNotTakenSet(), wasNotTakenXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab