Skip to main content

HS.FHIR.DTL.vR4.Model.Resource.MedicationAdministration

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

Administration of medication to 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 = 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 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 = 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 category as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "category", XMLPROJECTION = "ELEMENT");
CodeableConcept

Type of medication usage.

medication-admin-category is the PREFERRED FHIR4 ValueSet for codes, but if you need to express meanings not found in medication-admin-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 or Episode of Care administered as part of.

Encounter | EpisodeOfCare

Property methods: contextGet(), contextGetSwizzled(), contextIsValid(), contextNewObject(), contextSet()
property device as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "device", XMLPROJECTION = "ELEMENT");
Reference

Device used to administer.

Device

Property methods: deviceBuildValueArray(), deviceCollectionToDisplay(), deviceCollectionToOdbc(), deviceDisplayToCollection(), deviceGet(), deviceGetObject(), deviceGetObjectId(), deviceGetSwizzled(), deviceIsValid(), deviceOdbcToCollection(), deviceSet(), deviceSetObject(), deviceSetObjectId()
property dosage as HS.FHIR.DTL.vR4.Model.Element.MedicationAdministration.dosage (XMLNAME = "dosage", XMLPROJECTION = "ELEMENT");
BackboneElement

Details of how medication was taken.

Property methods: dosageGet(), dosageGetSwizzled(), dosageIsValid(), dosageNewObject(), dosageSet()
property effectiveDateTime as %String (MAXLEN = 1000000, XMLNAME = "effectiveDateTime", XMLPROJECTION = "ATTRIBUTE") [ Required ];
dateTime

Start and end time of administration.

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

Start and end time of administration.

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

A list of events of interest in the lifecycle.

Provenance

Property methods: eventHistoryBuildValueArray(), eventHistoryCollectionToDisplay(), eventHistoryCollectionToOdbc(), eventHistoryDisplayToCollection(), eventHistoryGet(), eventHistoryGetObject(), eventHistoryGetObjectId(), eventHistoryGetSwizzled(), eventHistoryIsValid(), eventHistoryOdbcToCollection(), eventHistorySet(), eventHistorySetObject(), eventHistorySetObjectId()
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 instantiates as list of %String (MAXLEN = 1000000, XMLNAME = "instantiates", XMLPROJECTION = "ELEMENT");
uri

Instantiates protocol or definition.

Property methods: instantiatesBuildValueArray(), instantiatesCollectionToDisplay(), instantiatesCollectionToOdbc(), instantiatesDisplayToCollection(), instantiatesDisplayToLogical(), instantiatesGet(), instantiatesGetObject(), instantiatesGetObjectId(), instantiatesGetSwizzled(), instantiatesIsValid(), instantiatesLogicalToDisplay(), instantiatesLogicalToOdbc(), instantiatesNormalize(), instantiatesOdbcToCollection(), instantiatesSet(), instantiatesSetObject(), instantiatesSetObjectId()
property medicationCodeableConcept as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What was administered.

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 was administered.

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

Information about the administration.

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 | Procedure

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

Who performed the medication administration and what they did.

Property methods: performerBuildValueArray(), performerCollectionToDisplay(), performerCollectionToOdbc(), performerDisplayToCollection(), performerGet(), performerGetObject(), performerGetObjectId(), performerGetSwizzled(), performerIsValid(), performerOdbcToCollection(), performerSet(), performerSetObject(), performerSetObjectId()
property reasonCode as list of HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "reasonCode", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason administration performed.

any FHIR4 code may be used; reason-medication-given-codes 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 was administered.

Condition | Observation | DiagnosticReport

Property methods: reasonReferenceBuildValueArray(), reasonReferenceCollectionToDisplay(), reasonReferenceCollectionToOdbc(), reasonReferenceDisplayToCollection(), reasonReferenceGet(), reasonReferenceGetObject(), reasonReferenceGetObjectId(), reasonReferenceGetSwizzled(), reasonReferenceIsValid(), reasonReferenceOdbcToCollection(), reasonReferenceSet(), reasonReferenceSetObject(), reasonReferenceSetObjectId()
property request as HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "request", XMLPROJECTION = "ELEMENT");
Reference

Request administration performed against.

MedicationRequest

Property methods: requestGet(), requestGetSwizzled(), requestIsValid(), requestNewObject(), requestSet()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown

medication-admin-status|4.0.1 is the REQUIRED FHIR4 ValueSet for codes; you may NOT extend medication-admin-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 administration not performed.

any FHIR4 code may be used; reason-medication-not-given-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 received medication.

Patient | Group

Property methods: subjectGet(), subjectGetSwizzled(), subjectIsValid(), subjectNewObject(), subjectSet()
property supportingInformation as list of HS.FHIR.DTL.vR4.Model.Base.Reference (XMLNAME = "supportingInformation", XMLPROJECTION = "ELEMENT");
Reference

Additional information to support administration.

Any FHIR4 Resource may be indicated by this Reference

Property methods: supportingInformationBuildValueArray(), supportingInformationCollectionToDisplay(), supportingInformationCollectionToOdbc(), supportingInformationDisplayToCollection(), supportingInformationGet(), supportingInformationGetObject(), supportingInformationGetObjectId(), supportingInformationGetSwizzled(), supportingInformationIsValid(), supportingInformationOdbcToCollection(), supportingInformationSet(), supportingInformationSetObject(), supportingInformationSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab