Skip to main content

HS.FHIR.DTL.vDSTU2.Model.Resource.MedicationAdministration

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

Details of how medication was taken.

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

Start and end time of administration.

Property methods: effectiveTimeDateTimeDisplayToLogical(), effectiveTimeDateTimeGet(), effectiveTimeDateTimeIsValid(), effectiveTimeDateTimeLogicalToDisplay(), effectiveTimeDateTimeLogicalToOdbc(), effectiveTimeDateTimeNormalize(), effectiveTimeDateTimeSet()
property effectiveTimePeriod as HS.FHIR.DTL.vDSTU2.Model.Datatype.Period (XMLNAME = "effectiveTimePeriod", XMLPROJECTION = "ELEMENT") [ Required ];
Period

Start and end time of administration.

Property methods: effectiveTimePeriodGet(), effectiveTimePeriodGetSwizzled(), effectiveTimePeriodIsValid(), effectiveTimePeriodNewObject(), effectiveTimePeriodSet()
property encounter as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "encounter", XMLPROJECTION = "ELEMENT");
Reference

Encounter administered as part of.

Encounter

Property methods: encounterGet(), encounterGetSwizzled(), encounterIsValid(), encounterNewObject(), encounterSet()
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 medicationCodeableConcept as HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "medicationCodeableConcept", XMLPROJECTION = "ELEMENT") [ Required ];
CodeableConcept

What was administered.

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

Medication.

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

Information about the administration.

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 received medication.

Patient

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

Who administered substance.

Practitioner | Patient | RelatedPerson

Property methods: practitionerGet(), practitionerGetSwizzled(), practitionerIsValid(), practitionerNewObject(), practitionerSet()
property prescription as HS.FHIR.DTL.vDSTU2.Model.Base.Reference (XMLNAME = "prescription", XMLPROJECTION = "ELEMENT");
Reference

Order administration performed against.

MedicationOrder

Property methods: prescriptionGet(), prescriptionGetSwizzled(), prescriptionIsValid(), prescriptionNewObject(), prescriptionSet()
property reasonGiven as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reasonGiven", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason administration performed.

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

Property methods: reasonGivenBuildValueArray(), reasonGivenCollectionToDisplay(), reasonGivenCollectionToOdbc(), reasonGivenDisplayToCollection(), reasonGivenGet(), reasonGivenGetObject(), reasonGivenGetObjectId(), reasonGivenGetSwizzled(), reasonGivenIsValid(), reasonGivenOdbcToCollection(), reasonGivenSet(), reasonGivenSetObject(), reasonGivenSetObjectId()
property reasonNotGiven as list of HS.FHIR.DTL.vDSTU2.Model.Datatype.CodeableConcept (XMLNAME = "reasonNotGiven", XMLPROJECTION = "ELEMENT");
CodeableConcept

Reason administration not performed.

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

Property methods: reasonNotGivenBuildValueArray(), reasonNotGivenCollectionToDisplay(), reasonNotGivenCollectionToOdbc(), reasonNotGivenDisplayToCollection(), reasonNotGivenGet(), reasonNotGivenGetObject(), reasonNotGivenGetObjectId(), reasonNotGivenGetSwizzled(), reasonNotGivenIsValid(), reasonNotGivenOdbcToCollection(), reasonNotGivenSet(), reasonNotGivenSetObject(), reasonNotGivenSetObjectId()
property status as %String (MAXLEN = 1000000, XMLNAME = "status", XMLPROJECTION = "ATTRIBUTE") [ Required ];
code

in-progress | on-hold | completed | entered-in-error | stopped

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

Property methods: statusDisplayToLogical(), statusGet(), statusIsValid(), statusLogicalToDisplay(), statusLogicalToOdbc(), statusNormalize(), statusSet()
property wasNotGiven as %Boolean (XMLNAME = "wasNotGiven", XMLPROJECTION = "ATTRIBUTE");
boolean

True if medication not administered.

Property methods: wasNotGivenDisplayToLogical(), wasNotGivenGet(), wasNotGivenIsValid(), wasNotGivenLogicalToDisplay(), wasNotGivenLogicalToXSD(), wasNotGivenNormalize(), wasNotGivenSet(), wasNotGivenXSDToLogical()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab