Skip to main content

HS.FHIR.vDSTU2.Model.Resource.MedicationAdministration

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

THIS DATA OBJECT MODEL CLASS IS DEPRECATED - Use %DynamicObject or HS.FHIRObject.* instead.

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 = 0;
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 device as list of HS.FHIR.vDSTU2.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.vDSTU2.Model.Resource.MedicationAdministration.Dosage (XMLNAME = "dosage");
Describes the medication dosage information details e.g. dose, rate, site, route, etc.
Property methods: dosageGet(), dosageGetSwizzled(), dosageIsValid(), dosageNewObject(), dosageSet()
property effectiveTimeDateTime as HS.FHIR.vDSTU2.Model.Datatype.DateTime (XMLNAME = "effectiveTimeDateTime");
Property methods: effectiveTimeDateTimeGet(), effectiveTimeDateTimeGetSwizzled(), effectiveTimeDateTimeIsValid(), effectiveTimeDateTimeNewObject(), effectiveTimeDateTimeSet()
property effectiveTimePeriod as HS.FHIR.vDSTU2.Model.Base.Period (XMLNAME = "effectiveTimePeriod");
Property methods: effectiveTimePeriodGet(), effectiveTimePeriodGetSwizzled(), effectiveTimePeriodIsValid(), effectiveTimePeriodNewObject(), effectiveTimePeriodSet()
property encounter as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "encounter");
The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
property identifier as list of HS.FHIR.vDSTU2.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.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "medicationCodeableConcept");
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "medicationReference");
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property note as HS.FHIR.vDSTU2.Model.Datatype.String (XMLNAME = "note");
Extra information about the medication administration that is not conveyed by the other attributes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property patient as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "patient") [ Required ];
The person or animal receiving the medication.
Property methods: patientGet(), patientGetSwizzled(), patientIsValid(), patientNewObject(), patientSet()
property practitioner as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "practitioner");
The individual who was responsible for giving the medication to the patient.
Property methods: practitionerGet(), practitionerGetSwizzled(), practitionerIsValid(), practitionerNewObject(), practitionerSet()
property prescription as HS.FHIR.vDSTU2.Model.Base.Reference (XMLNAME = "prescription");
The original request, instruction or authority to perform the administration.
Property methods: prescriptionGet(), prescriptionGetSwizzled(), prescriptionIsValid(), prescriptionNewObject(), prescriptionSet()
property reasonGiven as list of HS.FHIR.vDSTU2.Model.Base.CodeableConcept (XMLNAME = "reasonGiven", XMLPROJECTION = "ELEMENT");
A code indicating why the medication was given.
Property methods: reasonGivenBuildValueArray(), reasonGivenCollectionToDisplay(), reasonGivenCollectionToOdbc(), reasonGivenDisplayToCollection(), reasonGivenGet(), reasonGivenGetObject(), reasonGivenGetObjectId(), reasonGivenGetSwizzled(), reasonGivenIsValid(), reasonGivenOdbcToCollection(), reasonGivenSet(), reasonGivenSetObject(), reasonGivenSetObjectId()
property reasonNotGiven as list of HS.FHIR.vDSTU2.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 status as HS.FHIR.vDSTU2.Model.Base.MedicationAdministrationStatus (XMLNAME = "status") [ 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 wasNotGiven as HS.FHIR.vDSTU2.Model.Datatype.Boolean (XMLNAME = "wasNotGiven");
Set this to true if the record is saying that the medication was NOT administered.
Property methods: wasNotGivenGet(), wasNotGivenGetSwizzled(), wasNotGivenIsValid(), wasNotGivenNewObject(), wasNotGivenSet()

Methods

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 SetEffectiveTimeDateTime(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 "effectiveTimeDateTime" property.
deprecated method SetEffectiveTimePeriod(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 "effectiveTimePeriod" property.
deprecated method SetEncounter(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 "encounter" 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 SetNote(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 "note" property.
deprecated method SetPatient(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 "patient" property.
deprecated method SetPractitioner(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 "practitioner" 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 SetReasonGiven(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 "reasonGiven" 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 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 SetWasNotGiven(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 "wasNotGiven" property.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab