Skip to main content

HS.FHIR.vSTU3.Model.Resource.MedicationAdministration

deprecated class HS.FHIR.vSTU3.Model.Resource.MedicationAdministration extends HS.FHIR.vSTU3.Model.Base.DomainResource

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Describes the event of a patient consuming or otherwise being administered a medication. This may be as simple as swallowing a tablet or it may be a long running infusion. Related resources tie this event to the authorizing prescription, and the specific encounter between patient and health care practitioner.
If the element is present, it must have either a @value, an @id, or extensions

Property Inventory

Method 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 = MedicationAdministration;
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 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.

Properties

property category as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
Indicates the type of medication administration and where the medication is expected to be consumed or administered.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property context as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "context", XMLPROJECTION = "ELEMENT");
The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property definition as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "definition", XMLPROJECTION = "ELEMENT");
A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this event.
Property methods: definitionBuildValueArray(), definitionCollectionToDisplay(), definitionCollectionToOdbc(), definitionDisplayToCollection(), definitionGet(), definitionGetObject(), definitionGetObjectId(), definitionGetSwizzled(), definitionIsValid(), definitionOdbcToCollection(), definitionSet(), definitionSetObject(), definitionSetObjectId()
property device as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT");
The device used in administering the medication to the patient. For example, a particular infusion pump.
Property methods: deviceBuildValueArray(), deviceCollectionToDisplay(), deviceCollectionToOdbc(), deviceDisplayToCollection(), deviceGet(), deviceGetObject(), deviceGetObjectId(), deviceGetSwizzled(), deviceIsValid(), deviceOdbcToCollection(), deviceSet(), deviceSetObject(), deviceSetObjectId()
property dosage as HS.FHIR.vSTU3.Model.Resource.MedicationAdministration.Dosage (XMLNAME = "dosage", XMLPROJECTION = "ELEMENT");
Describes the medication dosage information details e.g. dose, rate, site, route, etc.
Property methods: dosageGet(), dosageGetSwizzled(), dosageIsValid(), dosageNewObject(), dosageSet()
property effectiveDateTime as HS.FHIR.vSTU3.Model.Datatype.DateTime (XMLNAME = "effectiveDateTime", XMLPROJECTION = "ELEMENT");
Property methods: effectiveDateTimeGet(), effectiveDateTimeGetSwizzled(), effectiveDateTimeIsValid(), effectiveDateTimeNewObject(), effectiveDateTimeSet()
property effectivePeriod as HS.FHIR.vSTU3.Model.Base.Period (XMLNAME = "effectivePeriod", XMLPROJECTION = "ELEMENT");
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property eventHistory as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "eventHistory", XMLPROJECTION = "ELEMENT");
A summary of the events of interest that have occurred, such as when the administration was verified.
Property methods: eventHistoryBuildValueArray(), eventHistoryCollectionToDisplay(), eventHistoryCollectionToOdbc(), eventHistoryDisplayToCollection(), eventHistoryGet(), eventHistoryGetObject(), eventHistoryGetObjectId(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryOdbcToCollection(), eventHistorySet(), eventHistorySetObject(), eventHistorySetObjectId()
property identifier as list of HS.FHIR.vSTU3.Model.Base.Identifier (XMLNAME = "identifier", XMLPROJECTION = "ELEMENT");
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.
Property methods: identifierBuildValueArray(), identifierCollectionToDisplay(), identifierCollectionToOdbc(), identifierDisplayToCollection(), identifierGet(), identifierGetObject(), identifierGetObjectId(), identifierGetSwizzled(), identifierIsValid(), identifierOdbcToCollection(), identifierSet(), identifierSetObject(), identifierSetObjectId()
property medicationCodeableConcept as HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT");
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "medicationReference", XMLPROJECTION = "ELEMENT");
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property notGiven as HS.FHIR.vSTU3.Model.Datatype.Boolean (XMLNAME = "notGiven", XMLPROJECTION = "ELEMENT");
Set this to true if the record is saying that the medication was NOT administered.
Property methods: notGivenGet(), notGivenGetSwizzled(), notGivenIsValid(), notGivenNewObject(), notGivenSet()
property note as list of HS.FHIR.vSTU3.Model.Base.Annotation (XMLNAME = "note", XMLPROJECTION = "ELEMENT");
Extra information about the medication administration that is not conveyed by the other attributes.
Property methods: noteBuildValueArray(), noteCollectionToDisplay(), noteCollectionToOdbc(), noteDisplayToCollection(), noteGet(), noteGetObject(), noteGetObjectId(), noteGetSwizzled(), noteIsValid(), noteOdbcToCollection(), noteSet(), noteSetObject(), noteSetObjectId()
property partOf as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "partOf", XMLPROJECTION = "ELEMENT");
A larger event of which this particular event is a component or step.
Property methods: partOfBuildValueArray(), partOfCollectionToDisplay(), partOfCollectionToOdbc(), partOfDisplayToCollection(), partOfGet(), partOfGetObject(), partOfGetObjectId(), partOfGetSwizzled(), partOfIsValid(), partOfOdbcToCollection(), partOfSet(), partOfSetObject(), partOfSetObjectId()
property performer as list of HS.FHIR.vSTU3.Model.Resource.MedicationAdministration.Performer (XMLNAME = "performer", XMLPROJECTION = "ELEMENT");
The individual who was responsible for giving the medication to the patient.
Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property prescription as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "prescription", XMLPROJECTION = "ELEMENT");
The original request, instruction or authority to perform the administration.
Property methods: prescriptionGet(), prescriptionGetSwizzled(), prescriptionIsValid(), prescriptionNewObject(), prescriptionSet()
property reasonCode as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
A code indicating why the medication was given.
Property methods: reasonCodeBuildValueArray(), reasonCodeCollectionToDisplay(), reasonCodeCollectionToOdbc(), reasonCodeDisplayToCollection(), reasonCodeGet(), reasonCodeGetObject(), reasonCodeGetObjectId(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeOdbcToCollection(), reasonCodeSet(), reasonCodeSetObject(), reasonCodeSetObjectId()
property reasonNotGiven as list of HS.FHIR.vSTU3.Model.Base.CodeableConcept (XMLNAME = "reasonNotGiven", XMLPROJECTION = "ELEMENT");
A code indicating why the administration was not performed.
Property methods: reasonNotGivenBuildValueArray(), reasonNotGivenCollectionToDisplay(), reasonNotGivenCollectionToOdbc(), reasonNotGivenDisplayToCollection(), reasonNotGivenGet(), reasonNotGivenGetObject(), reasonNotGivenGetObjectId(), reasonNotGivenGetSwizzled(), reasonNotGivenIsValid(), reasonNotGivenOdbcToCollection(), reasonNotGivenSet(), reasonNotGivenSetObject(), reasonNotGivenSetObjectId()
property reasonReference as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "reasonReference", XMLPROJECTION = "ELEMENT");
Condition or observation that supports why the medication was administered.
Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property status as HS.FHIR.vSTU3.Model.Base.MedicationAdministrationStatus (XMLNAME = "status", XMLPROJECTION = "ELEMENT") [ Required ];
Will generally be set to show that the administration has been completed. For some long running administrations such as infusions it is possible for an administration to be started but not completed or it may be paused while some other process is under way.
Property methods: statusGet(), statusGetSwizzled(), statusIsValid(), statusNewObject(), statusSet()
property subject as HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "subject", XMLPROJECTION = "ELEMENT") [ Required ];
The person or animal or group receiving the medication.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInformation as list of HS.FHIR.vSTU3.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Additional information (for example, patient height and weight) that supports the administration of the medication.
Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Methods

deprecated method SetCategory(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "category" property.
deprecated method SetContext(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "context" property.
deprecated method SetDefinition(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "definition" property.
deprecated method SetDevice(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "device" property.
deprecated method SetEffectiveDateTime(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "effectiveDateTime" property.
deprecated method SetEffectivePeriod(pStart As %String = "", pEnd As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "effectivePeriod" property.
deprecated method SetEventHistory(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "eventHistory" property.
deprecated method SetIdentifier(pValue As %String = "", pSystem As %String = "", pUse As %String = "", pTypeCode As %String = "", pTypeSystem As %String = "", pTypeDisplay As %String = "", pTypeText As %String = "", pId As %String = "", pStart As %String = "", pEnd As %String = "", pAssignerReference As %String = "", pAssignerDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "identifier" property.
deprecated method SetMedicationCodeableConcept(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "medicationCodeableConcept" property.
deprecated method SetMedicationReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "medicationReference" property.
deprecated method SetNotGiven(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "notGiven" property.
deprecated method SetPartOf(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "partOf" property.
deprecated method SetPrescription(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "prescription" property.
deprecated method SetReasonCode(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonCode" property.
deprecated method SetReasonNotGiven(pCode As %String = "", pDisplay As %String = "", pSystem As %String = "", pText As %String = "", pVersion As %String = "", pUserSelected As %String = "", pId As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonNotGiven" property.
deprecated method SetReasonReference(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "reasonReference" property.
deprecated method SetStatus(pValue As %String = "", pExtension As %RegisteredObject = "", pId As %String = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "status" property.
deprecated method SetSubject(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Set method for the "subject" property.
deprecated method SetSupportingInformation(pReference As %String = "", pDisplay As %String = "", pExtension As %RegisteredObject = "") as %Status
THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.
Insert method for the "supportingInformation" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab