Skip to main content

HS.FHIRModel.R4.MedicationAdministration

class HS.FHIRModel.R4.MedicationAdministration extends HS.FHIRModel.FHIRClassSuper

*****************************************
** MedicationAdministration generated class schema
*****************************************
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.

Property Inventory

Method Inventory

Parameters

parameter XMLTYPE = R4_MEDICATIONADMINISTRATION;
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 _effectiveDateTime as HS.FHIRModel.R4.Element;
Extensions for effectiveDateTime
Property methods: _effectiveDateTimeGet(), _effectiveDateTimeGetSwizzled(), _effectiveDateTimeIsValid(), _effectiveDateTimeNewObject(), _effectiveDateTimeSet()
property _implicitRules as HS.FHIRModel.R4.Element;
Extensions for implicitRules
Property methods: _implicitRulesGet(), _implicitRulesGetSwizzled(), _implicitRulesIsValid(), _implicitRulesNewObject(), _implicitRulesSet()
property _instantiates as HS.FHIRModel.R4.SeqOfElement;
Extensions for instantiates
Property methods: _instantiatesGet(), _instantiatesGetSwizzled(), _instantiatesIsValid(), _instantiatesNewObject(), _instantiatesSet()
property _language as HS.FHIRModel.R4.Element;
Extensions for language
Property methods: _languageGet(), _languageGetSwizzled(), _languageIsValid(), _languageNewObject(), _languageSet()
property _status as HS.FHIRModel.R4.Element;
Extensions for status
Property methods: _statusGet(), _statusGetSwizzled(), _statusIsValid(), _statusNewObject(), _statusSet()
property category as HS.FHIRModel.R4.CodeableConcept;
Indicates where the medication is expected to be consumed or administered.
Property methods: categoryGet(), categoryGetSwizzled(), categoryIsValid(), categoryNewObject(), categorySet()
property contained as HS.FHIRModel.R4.SeqOfResourceList;
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Property methods: containedGet(), containedGetSwizzled(), containedIsValid(), containedNewObject(), containedSet()
property context as HS.FHIRModel.R4.Reference;
The visit, admission, or other contact between patient and health care provider during which the medication administration was performed.
Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property device as HS.FHIRModel.R4.SeqOfReference;
The device used in administering the medication to the patient. For example, a particular infusion pump.
Property methods: deviceGet(), deviceGetSwizzled(), deviceIsValid(), deviceNewObject(), deviceSet()
Describes the medication dosage information details e.g. dose, rate, site, route, etc.
Property methods: dosageGet(), dosageGetSwizzled(), dosageIsValid(), dosageNewObject(), dosageSet()
property effectiveDateTime as %String;
A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
Property methods: effectiveDateTimeDisplayToLogical(), effectiveDateTimeGet(), effectiveDateTimeIsValid(), effectiveDateTimeLogicalToDisplay(), effectiveDateTimeLogicalToOdbc(), effectiveDateTimeNormalize(), effectiveDateTimeSet()
property effectivePeriod as HS.FHIRModel.R4.Period;
A specific date/time or interval of time during which the administration took place (or did not take place, when the 'notGiven' attribute is true). For many administrations, such as swallowing a tablet the use of dateTime is more appropriate.
Property methods: effectivePeriodGet(), effectivePeriodGetSwizzled(), effectivePeriodIsValid(), effectivePeriodNewObject(), effectivePeriodSet()
property eventHistory as HS.FHIRModel.R4.SeqOfReference;
A summary of the events of interest that have occurred, such as when the administration was verified.
Property methods: eventHistoryGet(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryNewObject(), eventHistorySet()
property extension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Property methods: extensionGet(), extensionGetSwizzled(), extensionIsValid(), extensionNewObject(), extensionSet()
property fhirID as %String;
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Property methods: fhirIDDisplayToLogical(), fhirIDGet(), fhirIDIsValid(), fhirIDLogicalToDisplay(), fhirIDLogicalToOdbc(), fhirIDNormalize(), fhirIDSet()
property identifier as HS.FHIRModel.R4.SeqOfIdentifier;
Identifiers associated with this Medication Administration that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate. They are business identifiers assigned to this resource by the performer or other systems and remain constant as the resource is updated and propagates from server to server.
Property methods: identifierGet(), identifierGetSwizzled(), identifierIsValid(), identifierNewObject(), identifierSet()
property implicitRules as %String;
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Property methods: implicitRulesDisplayToLogical(), implicitRulesGet(), implicitRulesIsValid(), implicitRulesLogicalToDisplay(), implicitRulesLogicalToOdbc(), implicitRulesNormalize(), implicitRulesSet()
property instantiates as HS.FHIRModel.R4.SeqOfString;
A protocol, guideline, orderset, or other definition that was adhered to in whole or in part by this event.
Property methods: instantiatesGet(), instantiatesGetSwizzled(), instantiatesIsValid(), instantiatesNewObject(), instantiatesSet()
property language as %String;
The base language in which the resource is written.
Property methods: languageDisplayToLogical(), languageGet(), languageIsValid(), languageLogicalToDisplay(), languageLogicalToOdbc(), languageNormalize(), languageSet()
property medicationCodeableConcept as HS.FHIRModel.R4.CodeableConcept;
Identifies the medication that was 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.
Property methods: medicationCodeableConceptGet(), medicationCodeableConceptGetSwizzled(), medicationCodeableConceptIsValid(), medicationCodeableConceptNewObject(), medicationCodeableConceptSet()
property medicationReference as HS.FHIRModel.R4.Reference;
Identifies the medication that was 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.
Property methods: medicationReferenceGet(), medicationReferenceGetSwizzled(), medicationReferenceIsValid(), medicationReferenceNewObject(), medicationReferenceSet()
property meta as HS.FHIRModel.R4.Meta;
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Property methods: metaGet(), metaGetSwizzled(), metaIsValid(), metaNewObject(), metaSet()
property modifierExtension as HS.FHIRModel.R4.SeqOfExtension;
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Property methods: modifierExtensionGet(), modifierExtensionGetSwizzled(), modifierExtensionIsValid(), modifierExtensionNewObject(), modifierExtensionSet()
Extra information about the medication administration that is not conveyed by the other attributes.
Property methods: noteGet(), noteGetSwizzled(), noteIsValid(), noteNewObject(), noteSet()
property partOf as HS.FHIRModel.R4.SeqOfReference;
A larger event of which this particular event is a component or step.
Property methods: partOfGet(), partOfGetSwizzled(), partOfIsValid(), partOfNewObject(), partOfSet()
Indicates who or what performed the medication administration and how they were involved.
Property methods: performerGet(), performerGetSwizzled(), performerIsValid(), performerNewObject(), performerSet()
property reasonCode as HS.FHIRModel.R4.SeqOfCodeableConcept;
A code indicating why the medication was given.
Property methods: reasonCodeGet(), reasonCodeGetSwizzled(), reasonCodeIsValid(), reasonCodeNewObject(), reasonCodeSet()
property reasonReference as HS.FHIRModel.R4.SeqOfReference;
Condition or observation that supports why the medication was administered.
Property methods: reasonReferenceGet(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceNewObject(), reasonReferenceSet()
property request as HS.FHIRModel.R4.Reference;
The original request, instruction or authority to perform the administration.
Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestSet()
property resourceType as %String [ InitialExpression = "MedicationAdministration" , Required ];
This is a MedicationAdministration resource
Property methods: resourceTypeDisplayToLogical(), resourceTypeGet(), resourceTypeIsValid(), resourceTypeLogicalToDisplay(), resourceTypeLogicalToOdbc(), resourceTypeNormalize(), resourceTypeSet()
property status as %String;
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: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property statusReason as HS.FHIRModel.R4.SeqOfCodeableConcept;
A code indicating why the administration was not performed.
Property methods: statusReasonGet(), statusReasonGetSwizzled(), statusReasonIsValid(), statusReasonNewObject(), statusReasonSet()
property subject as HS.FHIRModel.R4.Reference [ Required ];
The person or animal or group receiving the medication.
Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInformation as HS.FHIRModel.R4.SeqOfReference;
Additional information (for example, patient height and weight) that supports the administration of the medication.
Property methods: supportingInformationGet(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationNewObject(), supportingInformationSet()
property text as HS.FHIRModel.R4.Narrative;
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Property methods: textGet(), textGetSwizzled(), textIsValid(), textNewObject(), textSet()

Methods

method IncludeCategory()
method IncludeContained()
method IncludeContext()
method IncludeDevice()
method IncludeDosage()
method IncludeEffectivePeriod()
method IncludeEventHistory()
method IncludeExtension()
method IncludeIdentifier()
method IncludeInstantiates()
method IncludeMedicationCodeableConcept()
method IncludeMedicationReference()
method IncludeMeta()
method IncludeModifierExtension()
method IncludeNote()
method IncludePartOf()
method IncludePerformer()
method IncludeReasonCode()
method IncludeReasonReference()
method IncludeRequest()
method IncludeStatusReason()
method IncludeSubject()
method IncludeSupportingInformation()
method IncludeText()
method _getProperties() as %DynamicArray
Inherited description: Return an array of the defined properties of this class in the definition order that they were discovered in the the HL7FHIR JSchema document
method toDao() as %DynamicAbstractObject
Inherited description: >

The toDao() method casts the set to a DAO.

Inherited Members

Inherited Methods

FeedbackOpens in a new tab