ca.uhn.fhir.model.dstu2.resource.MedicationAdministration Maven / Gradle / Ivy
package ca.uhn.fhir.model.dstu2.resource;
import java.math.BigDecimal;
import java.net.URI;
import java.util.*;
import ca.uhn.fhir.model.api.*;
import ca.uhn.fhir.model.api.annotation.*;
import ca.uhn.fhir.rest.gclient.*;
import ca.uhn.fhir.model.dstu2.valueset.AccountStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ActionListEnum;
import ca.uhn.fhir.model.dstu2.composite.AddressDt;
import ca.uhn.fhir.model.dstu2.valueset.AdjudicationCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.AdjudicationErrorCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.AdjustmentReasonCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.AdministrativeGenderEnum;
import ca.uhn.fhir.model.dstu2.valueset.AdmitSourceEnum;
import ca.uhn.fhir.model.dstu2.resource.AllergyIntolerance;
import ca.uhn.fhir.model.dstu2.valueset.AllergyIntoleranceCategoryEnum;
import ca.uhn.fhir.model.dstu2.valueset.AllergyIntoleranceCertaintyEnum;
import ca.uhn.fhir.model.dstu2.valueset.AllergyIntoleranceCriticalityEnum;
import ca.uhn.fhir.model.dstu2.valueset.AllergyIntoleranceSeverityEnum;
import ca.uhn.fhir.model.dstu2.valueset.AllergyIntoleranceStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.AllergyIntoleranceTypeEnum;
import ca.uhn.fhir.model.dstu2.composite.AnnotationDt;
import ca.uhn.fhir.model.dstu2.valueset.AnswerFormatEnum;
import ca.uhn.fhir.model.dstu2.resource.Appointment;
import ca.uhn.fhir.model.dstu2.valueset.AppointmentStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.AssertionDirectionTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.AssertionOperatorTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.AssertionResponseTypesEnum;
import ca.uhn.fhir.model.dstu2.composite.AttachmentDt;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventActionEnum;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventObjectLifecycleEnum;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventObjectRoleEnum;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventObjectTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventOutcomeEnum;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventParticipantNetworkTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.AuditEventSourceTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.BindingStrengthEnum;
import ca.uhn.fhir.model.dstu2.resource.BodySite;
import ca.uhn.fhir.model.dstu2.valueset.BundleTypeEnum;
import ca.uhn.fhir.model.dstu2.resource.CarePlan;
import ca.uhn.fhir.model.dstu2.valueset.CarePlanActivityStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.CarePlanRelationshipEnum;
import ca.uhn.fhir.model.dstu2.valueset.CarePlanStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Claim;
import ca.uhn.fhir.model.dstu2.resource.ClaimResponse;
import ca.uhn.fhir.model.dstu2.valueset.ClaimTypeEnum;
import ca.uhn.fhir.model.dstu2.resource.ClinicalImpression;
import ca.uhn.fhir.model.dstu2.valueset.ClinicalImpressionStatusEnum;
import ca.uhn.fhir.model.dstu2.composite.CodeableConceptDt;
import ca.uhn.fhir.model.dstu2.composite.CodingDt;
import ca.uhn.fhir.model.dstu2.resource.CommunicationRequest;
import ca.uhn.fhir.model.dstu2.valueset.CommunicationRequestStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.CommunicationStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Composition;
import ca.uhn.fhir.model.dstu2.valueset.CompositionAttestationModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.CompositionStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ConceptMapEquivalenceEnum;
import ca.uhn.fhir.model.dstu2.resource.Condition;
import ca.uhn.fhir.model.dstu2.valueset.ConditionCategoryCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.ConditionClinicalStatusCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.ConditionVerificationStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ConditionalDeleteStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Conformance;
import ca.uhn.fhir.model.dstu2.valueset.ConformanceEventModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ConformanceResourceStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ConformanceStatementKindEnum;
import ca.uhn.fhir.model.dstu2.composite.ContactPointDt;
import ca.uhn.fhir.model.dstu2.valueset.ContentTypeEnum;
import ca.uhn.fhir.model.dstu2.resource.Contract;
import ca.uhn.fhir.model.dstu2.resource.Coverage;
import ca.uhn.fhir.model.dstu2.valueset.DataElementStringencyEnum;
import ca.uhn.fhir.model.dstu2.valueset.DaysOfWeekEnum;
import ca.uhn.fhir.model.dstu2.valueset.DetectedIssueSeverityEnum;
import ca.uhn.fhir.model.dstu2.resource.Device;
import ca.uhn.fhir.model.dstu2.resource.DeviceComponent;
import ca.uhn.fhir.model.dstu2.resource.DeviceMetric;
import ca.uhn.fhir.model.dstu2.valueset.DeviceMetricCalibrationStateEnum;
import ca.uhn.fhir.model.dstu2.valueset.DeviceMetricCalibrationTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.DeviceMetricCategoryEnum;
import ca.uhn.fhir.model.dstu2.valueset.DeviceMetricColorEnum;
import ca.uhn.fhir.model.dstu2.valueset.DeviceMetricOperationalStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.DeviceStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.DeviceUseRequest;
import ca.uhn.fhir.model.dstu2.valueset.DeviceUseRequestPriorityEnum;
import ca.uhn.fhir.model.dstu2.valueset.DeviceUseRequestStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.DiagnosticOrder;
import ca.uhn.fhir.model.dstu2.valueset.DiagnosticOrderPriorityEnum;
import ca.uhn.fhir.model.dstu2.valueset.DiagnosticOrderStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.DiagnosticReport;
import ca.uhn.fhir.model.dstu2.valueset.DiagnosticReportStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.DigitalMediaTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.DocumentModeEnum;
import ca.uhn.fhir.model.dstu2.resource.DocumentReference;
import ca.uhn.fhir.model.dstu2.valueset.DocumentReferenceStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.DocumentRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu2.composite.ElementDefinitionDt;
import ca.uhn.fhir.model.dstu2.resource.EligibilityRequest;
import ca.uhn.fhir.model.dstu2.resource.Encounter;
import ca.uhn.fhir.model.dstu2.valueset.EncounterClassEnum;
import ca.uhn.fhir.model.dstu2.valueset.EncounterLocationStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.EncounterStateEnum;
import ca.uhn.fhir.model.dstu2.resource.EnrollmentRequest;
import ca.uhn.fhir.model.dstu2.resource.EpisodeOfCare;
import ca.uhn.fhir.model.dstu2.valueset.EpisodeOfCareStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ExtensionContextEnum;
import ca.uhn.fhir.model.dstu2.valueset.FamilyHistoryStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.FamilyMemberHistory;
import ca.uhn.fhir.model.dstu2.valueset.FilterOperatorEnum;
import ca.uhn.fhir.model.dstu2.valueset.FlagStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Goal;
import ca.uhn.fhir.model.dstu2.valueset.GoalPriorityEnum;
import ca.uhn.fhir.model.dstu2.valueset.GoalStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Group;
import ca.uhn.fhir.model.dstu2.valueset.GroupTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.GuideDependencyTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.GuidePageKindEnum;
import ca.uhn.fhir.model.dstu2.valueset.GuideResourcePurposeEnum;
import ca.uhn.fhir.model.dstu2.valueset.HTTPVerbEnum;
import ca.uhn.fhir.model.dstu2.resource.HealthcareService;
import ca.uhn.fhir.model.dstu2.composite.HumanNameDt;
import ca.uhn.fhir.model.dstu2.composite.IdentifierDt;
import ca.uhn.fhir.model.dstu2.valueset.IdentifierTypeCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.IdentityAssuranceLevelEnum;
import ca.uhn.fhir.model.dstu2.resource.ImagingObjectSelection;
import ca.uhn.fhir.model.dstu2.resource.ImagingStudy;
import ca.uhn.fhir.model.dstu2.resource.Immunization;
import ca.uhn.fhir.model.dstu2.valueset.InstanceAvailabilityEnum;
import ca.uhn.fhir.model.dstu2.valueset.IssueSeverityEnum;
import ca.uhn.fhir.model.dstu2.valueset.IssueTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.KOStitleEnum;
import ca.uhn.fhir.model.dstu2.valueset.LinkTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ListModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ListOrderCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.ListStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Location;
import ca.uhn.fhir.model.dstu2.valueset.LocationModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.LocationStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.LocationTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.MaritalStatusCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.MeasmntPrincipleEnum;
import ca.uhn.fhir.model.dstu2.resource.Media;
import ca.uhn.fhir.model.dstu2.resource.Medication;
import ca.uhn.fhir.model.dstu2.valueset.MedicationAdministrationStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.MedicationDispenseStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.MedicationOrder;
import ca.uhn.fhir.model.dstu2.valueset.MedicationOrderStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.MedicationStatement;
import ca.uhn.fhir.model.dstu2.valueset.MedicationStatementStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.MessageEventEnum;
import ca.uhn.fhir.model.dstu2.valueset.MessageSignificanceCategoryEnum;
import ca.uhn.fhir.model.dstu2.valueset.MessageTransportEnum;
import ca.uhn.fhir.model.dstu2.resource.NamingSystem;
import ca.uhn.fhir.model.dstu2.valueset.NamingSystemIdentifierTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.NamingSystemTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.NoteTypeEnum;
import ca.uhn.fhir.model.dstu2.resource.NutritionOrder;
import ca.uhn.fhir.model.dstu2.valueset.NutritionOrderStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Observation;
import ca.uhn.fhir.model.dstu2.valueset.ObservationRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ObservationStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.OperationDefinition;
import ca.uhn.fhir.model.dstu2.valueset.OperationKindEnum;
import ca.uhn.fhir.model.dstu2.resource.OperationOutcome;
import ca.uhn.fhir.model.dstu2.valueset.OperationParameterUseEnum;
import ca.uhn.fhir.model.dstu2.resource.Order;
import ca.uhn.fhir.model.dstu2.valueset.OrderStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Organization;
import ca.uhn.fhir.model.dstu2.valueset.ParticipantRequiredEnum;
import ca.uhn.fhir.model.dstu2.valueset.ParticipantStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ParticipantTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ParticipationStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Patient;
import ca.uhn.fhir.model.dstu2.valueset.PayeeTypeCodesEnum;
import ca.uhn.fhir.model.dstu2.composite.PeriodDt;
import ca.uhn.fhir.model.dstu2.resource.Person;
import ca.uhn.fhir.model.dstu2.resource.Practitioner;
import ca.uhn.fhir.model.dstu2.resource.Procedure;
import ca.uhn.fhir.model.dstu2.resource.ProcedureRequest;
import ca.uhn.fhir.model.dstu2.valueset.ProcedureRequestPriorityEnum;
import ca.uhn.fhir.model.dstu2.valueset.ProcedureRequestStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.ProcedureStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.ProcessRequest;
import ca.uhn.fhir.model.dstu2.valueset.ProvenanceEntityRoleEnum;
import ca.uhn.fhir.model.dstu2.composite.QuantityDt;
import ca.uhn.fhir.model.dstu2.resource.Questionnaire;
import ca.uhn.fhir.model.dstu2.resource.QuestionnaireResponse;
import ca.uhn.fhir.model.dstu2.valueset.QuestionnaireResponseStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.QuestionnaireStatusEnum;
import ca.uhn.fhir.model.dstu2.composite.RangeDt;
import ca.uhn.fhir.model.dstu2.composite.RatioDt;
import ca.uhn.fhir.model.dstu2.valueset.ReferralMethodEnum;
import ca.uhn.fhir.model.dstu2.resource.ReferralRequest;
import ca.uhn.fhir.model.dstu2.valueset.ReferralStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.RelatedPerson;
import ca.uhn.fhir.model.dstu2.valueset.RemittanceOutcomeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ResourceTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ResourceVersionPolicyEnum;
import ca.uhn.fhir.model.dstu2.valueset.ResponseTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.RestfulConformanceModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.RestfulSecurityServiceEnum;
import ca.uhn.fhir.model.dstu2.resource.RiskAssessment;
import ca.uhn.fhir.model.dstu2.valueset.RulesetCodesEnum;
import ca.uhn.fhir.model.dstu2.composite.SampledDataDt;
import ca.uhn.fhir.model.dstu2.resource.Schedule;
import ca.uhn.fhir.model.dstu2.valueset.SearchEntryModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.SearchModifierCodeEnum;
import ca.uhn.fhir.model.dstu2.valueset.SearchParamTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.ServiceProvisionConditionsEnum;
import ca.uhn.fhir.model.dstu2.composite.SignatureDt;
import ca.uhn.fhir.model.dstu2.resource.Slot;
import ca.uhn.fhir.model.dstu2.valueset.SlotStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Specimen;
import ca.uhn.fhir.model.dstu2.valueset.SpecimenStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.StructureDefinition;
import ca.uhn.fhir.model.dstu2.valueset.StructureDefinitionKindEnum;
import ca.uhn.fhir.model.dstu2.valueset.SubscriptionChannelTypeEnum;
import ca.uhn.fhir.model.dstu2.valueset.SubscriptionStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.Substance;
import ca.uhn.fhir.model.dstu2.valueset.SubstanceCategoryCodesEnum;
import ca.uhn.fhir.model.dstu2.valueset.SupplyDeliveryStatusEnum;
import ca.uhn.fhir.model.dstu2.resource.SupplyRequest;
import ca.uhn.fhir.model.dstu2.valueset.SupplyRequestStatusEnum;
import ca.uhn.fhir.model.dstu2.valueset.SystemRestfulInteractionEnum;
import ca.uhn.fhir.model.api.TemporalPrecisionEnum;
import ca.uhn.fhir.model.dstu2.composite.TimingDt;
import ca.uhn.fhir.model.dstu2.valueset.TransactionModeEnum;
import ca.uhn.fhir.model.dstu2.valueset.TypeRestfulInteractionEnum;
import ca.uhn.fhir.model.dstu2.valueset.UnknownContentCodeEnum;
import ca.uhn.fhir.model.dstu2.valueset.UseEnum;
import ca.uhn.fhir.model.dstu2.resource.ValueSet;
import ca.uhn.fhir.model.dstu2.valueset.VisionBaseEnum;
import ca.uhn.fhir.model.dstu2.valueset.VisionEyesEnum;
import ca.uhn.fhir.model.dstu2.resource.VisionPrescription;
import ca.uhn.fhir.model.dstu2.valueset.XPathUsageTypeEnum;
import ca.uhn.fhir.model.api.IResource;
import ca.uhn.fhir.model.dstu2.composite.AgeDt;
import ca.uhn.fhir.model.dstu2.composite.BoundCodeableConceptDt;
import ca.uhn.fhir.model.dstu2.composite.DurationDt;
import ca.uhn.fhir.model.dstu2.composite.MoneyDt;
import ca.uhn.fhir.model.dstu2.composite.NarrativeDt;
import ca.uhn.fhir.model.dstu2.composite.ResourceReferenceDt;
import ca.uhn.fhir.model.dstu2.composite.SimpleQuantityDt;
import ca.uhn.fhir.model.primitive.Base64BinaryDt;
import ca.uhn.fhir.model.primitive.BooleanDt;
import ca.uhn.fhir.model.primitive.BoundCodeDt;
import ca.uhn.fhir.model.primitive.CodeDt;
import ca.uhn.fhir.model.primitive.DateDt;
import ca.uhn.fhir.model.primitive.DateTimeDt;
import ca.uhn.fhir.model.primitive.DecimalDt;
import ca.uhn.fhir.model.primitive.IdDt;
import ca.uhn.fhir.model.primitive.InstantDt;
import ca.uhn.fhir.model.primitive.IntegerDt;
import ca.uhn.fhir.model.primitive.OidDt;
import ca.uhn.fhir.model.primitive.PositiveIntDt;
import ca.uhn.fhir.model.primitive.StringDt;
import ca.uhn.fhir.model.primitive.TimeDt;
import ca.uhn.fhir.model.primitive.UnsignedIntDt;
import ca.uhn.fhir.model.primitive.UriDt;
/**
* HAPI/FHIR MedicationAdministration Resource
* (clinical.medication)
*
*
* Definition:
* 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
*
*
*
* Requirements:
*
*
*
*
* Profile Definition:
* http://hl7.org/fhir/profiles/MedicationAdministration
*
*
*/
@ResourceDef(name="MedicationAdministration", profile="http://hl7.org/fhir/profiles/MedicationAdministration", id="medicationadministration")
public class MedicationAdministration extends ca.uhn.fhir.model.dstu2.resource.BaseResource
implements IResource
{
/**
* Search parameter constant for device
*
* Description: Return administrations with this administration device identity
* Type: reference
* Path: MedicationAdministration.device
*
*/
@SearchParamDefinition(name="device", path="MedicationAdministration.device", description="Return administrations with this administration device identity", type="reference"
, providesMembershipIn={
@Compartment(name="Practitioner") }
)
public static final String SP_DEVICE = "device";
/**
* Fluent Client search parameter constant for device
*
* Description: Return administrations with this administration device identity
* Type: reference
* Path: MedicationAdministration.device
*
*/
public static final ReferenceClientParam DEVICE = new ReferenceClientParam(SP_DEVICE);
/**
* Search parameter constant for encounter
*
* Description: Return administrations that share this encounter
* Type: reference
* Path: MedicationAdministration.encounter
*
*/
@SearchParamDefinition(name="encounter", path="MedicationAdministration.encounter", description="Return administrations that share this encounter", type="reference"
, providesMembershipIn={
@Compartment(name="Encounter") }
)
public static final String SP_ENCOUNTER = "encounter";
/**
* Fluent Client search parameter constant for encounter
*
* Description: Return administrations that share this encounter
* Type: reference
* Path: MedicationAdministration.encounter
*
*/
public static final ReferenceClientParam ENCOUNTER = new ReferenceClientParam(SP_ENCOUNTER);
/**
* Search parameter constant for identifier
*
* Description: Return administrations with this external identifier
* Type: token
* Path: MedicationAdministration.identifier
*
*/
@SearchParamDefinition(name="identifier", path="MedicationAdministration.identifier", description="Return administrations with this external identifier", type="token"
)
public static final String SP_IDENTIFIER = "identifier";
/**
* Fluent Client search parameter constant for identifier
*
* Description: Return administrations with this external identifier
* Type: token
* Path: MedicationAdministration.identifier
*
*/
public static final TokenClientParam IDENTIFIER = new TokenClientParam(SP_IDENTIFIER);
/**
* Search parameter constant for medication
*
* Description: Return administrations of this medication resource
* Type: reference
* Path: MedicationAdministration.medicationReference
*
*/
@SearchParamDefinition(name="medication", path="MedicationAdministration.medicationReference", description="Return administrations of this medication resource", type="reference"
)
public static final String SP_MEDICATION = "medication";
/**
* Fluent Client search parameter constant for medication
*
* Description: Return administrations of this medication resource
* Type: reference
* Path: MedicationAdministration.medicationReference
*
*/
public static final ReferenceClientParam MEDICATION = new ReferenceClientParam(SP_MEDICATION);
/**
* Search parameter constant for code
*
* Description: Return administrations of this medication code
* Type: token
* Path: MedicationAdministration.medicationCodeableConcept
*
*/
@SearchParamDefinition(name="code", path="MedicationAdministration.medicationCodeableConcept", description="Return administrations of this medication code", type="token"
)
public static final String SP_CODE = "code";
/**
* Fluent Client search parameter constant for code
*
* Description: Return administrations of this medication code
* Type: token
* Path: MedicationAdministration.medicationCodeableConcept
*
*/
public static final TokenClientParam CODE = new TokenClientParam(SP_CODE);
/**
* Search parameter constant for notgiven
*
* Description: Administrations that were not made
* Type: token
* Path: MedicationAdministration.wasNotGiven
*
*/
@SearchParamDefinition(name="notgiven", path="MedicationAdministration.wasNotGiven", description="Administrations that were not made", type="token"
)
public static final String SP_NOTGIVEN = "notgiven";
/**
* Fluent Client search parameter constant for notgiven
*
* Description: Administrations that were not made
* Type: token
* Path: MedicationAdministration.wasNotGiven
*
*/
public static final TokenClientParam NOTGIVEN = new TokenClientParam(SP_NOTGIVEN);
/**
* Search parameter constant for patient
*
* Description: The identity of a patient to list administrations for
* Type: reference
* Path: MedicationAdministration.patient
*
*/
@SearchParamDefinition(name="patient", path="MedicationAdministration.patient", description="The identity of a patient to list administrations for", type="reference"
, providesMembershipIn={
@Compartment(name="Patient") }
)
public static final String SP_PATIENT = "patient";
/**
* Fluent Client search parameter constant for patient
*
* Description: The identity of a patient to list administrations for
* Type: reference
* Path: MedicationAdministration.patient
*
*/
public static final ReferenceClientParam PATIENT = new ReferenceClientParam(SP_PATIENT);
/**
* Search parameter constant for prescription
*
* Description: The identity of a prescription to list administrations from
* Type: reference
* Path: MedicationAdministration.prescription
*
*/
@SearchParamDefinition(name="prescription", path="MedicationAdministration.prescription", description="The identity of a prescription to list administrations from", type="reference"
)
public static final String SP_PRESCRIPTION = "prescription";
/**
* Fluent Client search parameter constant for prescription
*
* Description: The identity of a prescription to list administrations from
* Type: reference
* Path: MedicationAdministration.prescription
*
*/
public static final ReferenceClientParam PRESCRIPTION = new ReferenceClientParam(SP_PRESCRIPTION);
/**
* Search parameter constant for status
*
* Description: MedicationAdministration event status (for example one of active/paused/completed/nullified)
* Type: token
* Path: MedicationAdministration.status
*
*/
@SearchParamDefinition(name="status", path="MedicationAdministration.status", description="MedicationAdministration event status (for example one of active/paused/completed/nullified)", type="token"
)
public static final String SP_STATUS = "status";
/**
* Fluent Client search parameter constant for status
*
* Description: MedicationAdministration event status (for example one of active/paused/completed/nullified)
* Type: token
* Path: MedicationAdministration.status
*
*/
public static final TokenClientParam STATUS = new TokenClientParam(SP_STATUS);
/**
* Search parameter constant for effectivetime
*
* Description: Date administration happened (or did not happen)
* Type: date
* Path: MedicationAdministration.effectiveTime[x]
*
*/
@SearchParamDefinition(name="effectivetime", path="MedicationAdministration.effectiveTime[x]", description="Date administration happened (or did not happen)", type="date"
)
public static final String SP_EFFECTIVETIME = "effectivetime";
/**
* Fluent Client search parameter constant for effectivetime
*
* Description: Date administration happened (or did not happen)
* Type: date
* Path: MedicationAdministration.effectiveTime[x]
*
*/
public static final DateClientParam EFFECTIVETIME = new DateClientParam(SP_EFFECTIVETIME);
/**
* Search parameter constant for practitioner
*
* Description:
* Type: reference
* Path: MedicationAdministration.practitioner
*
*/
@SearchParamDefinition(name="practitioner", path="MedicationAdministration.practitioner", description="", type="reference"
, providesMembershipIn={
@Compartment(name="RelatedPerson") }
)
public static final String SP_PRACTITIONER = "practitioner";
/**
* Fluent Client search parameter constant for practitioner
*
* Description:
* Type: reference
* Path: MedicationAdministration.practitioner
*
*/
public static final ReferenceClientParam PRACTITIONER = new ReferenceClientParam(SP_PRACTITIONER);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "MedicationAdministration:device".
*/
public static final Include INCLUDE_DEVICE = new Include("MedicationAdministration:device");
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "MedicationAdministration:encounter".
*/
public static final Include INCLUDE_ENCOUNTER = new Include("MedicationAdministration:encounter");
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "MedicationAdministration:medication".
*/
public static final Include INCLUDE_MEDICATION = new Include("MedicationAdministration:medication");
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "MedicationAdministration:patient".
*/
public static final Include INCLUDE_PATIENT = new Include("MedicationAdministration:patient");
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "MedicationAdministration:practitioner".
*/
public static final Include INCLUDE_PRACTITIONER = new Include("MedicationAdministration:practitioner");
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "MedicationAdministration:prescription".
*/
public static final Include INCLUDE_PRESCRIPTION = new Include("MedicationAdministration:prescription");
@Child(name="identifier", type=IdentifierDt.class, order=0, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="id",
formalDefinition="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."
)
private java.util.List myIdentifier;
@Child(name="status", type=CodeDt.class, order=1, min=1, max=1, summary=false, modifier=true)
@Description(
shortDefinition="status",
formalDefinition="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."
)
@ca.uhn.fhir.model.api.annotation.Binding(valueSet = "http://hl7.org/fhir/ValueSet/medication-admin-status")
private BoundCodeDt myStatus;
@Child(name="patient", order=2, min=1, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu2.resource.Patient.class
})
@Description(
shortDefinition="who.focus",
formalDefinition="The person or animal receiving the medication."
)
private ResourceReferenceDt myPatient;
@Child(name="practitioner", order=3, min=0, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu2.resource.Practitioner.class,
ca.uhn.fhir.model.dstu2.resource.Patient.class,
ca.uhn.fhir.model.dstu2.resource.RelatedPerson.class
})
@Description(
shortDefinition="who.actor",
formalDefinition="The individual who was responsible for giving the medication to the patient."
)
private ResourceReferenceDt myPractitioner;
@Child(name="encounter", order=4, min=0, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu2.resource.Encounter.class
})
@Description(
shortDefinition="context",
formalDefinition="The visit, admission or other contact between patient and health care provider the medication administration was performed as part of."
)
private ResourceReferenceDt myEncounter;
@Child(name="prescription", order=5, min=0, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu2.resource.MedicationOrder.class
})
@Description(
shortDefinition="",
formalDefinition="The original request, instruction or authority to perform the administration."
)
private ResourceReferenceDt myPrescription;
@Child(name="wasNotGiven", type=BooleanDt.class, order=6, min=0, max=1, summary=false, modifier=true)
@Description(
shortDefinition="",
formalDefinition="Set this to true if the record is saying that the medication was NOT administered."
)
private BooleanDt myWasNotGiven;
@Child(name="reasonNotGiven", type=CodeableConceptDt.class, order=7, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="A code indicating why the administration was not performed."
)
private java.util.List myReasonNotGiven;
@Child(name="reasonGiven", type=CodeableConceptDt.class, order=8, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="A code indicating why the medication was given."
)
private java.util.List myReasonGiven;
@Child(name="effectiveTime", order=9, min=1, max=1, summary=false, modifier=false, type={
DateTimeDt.class,
PeriodDt.class
})
@Description(
shortDefinition="when.done",
formalDefinition="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."
)
private IDatatype myEffectiveTime;
@Child(name="medication", order=10, min=1, max=1, summary=false, modifier=false, type={
CodeableConceptDt.class,
Medication.class
})
@Description(
shortDefinition="",
formalDefinition="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."
)
private IDatatype myMedication;
@Child(name="device", order=11, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu2.resource.Device.class
})
@Description(
shortDefinition="",
formalDefinition="The device used in administering the medication to the patient. For example, a particular infusion pump"
)
private java.util.List myDevice;
@Child(name="note", type=StringDt.class, order=12, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="Extra information about the medication administration that is not conveyed by the other attributes."
)
private StringDt myNote;
@Child(name="dosage", order=13, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="Describes the medication dosage information details e.g. dose, rate, site, route, etc."
)
private Dosage myDosage;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myIdentifier, myStatus, myPatient, myPractitioner, myEncounter, myPrescription, myWasNotGiven, myReasonNotGiven, myReasonGiven, myEffectiveTime, myMedication, myDevice, myNote, myDosage);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myIdentifier, myStatus, myPatient, myPractitioner, myEncounter, myPrescription, myWasNotGiven, myReasonNotGiven, myReasonGiven, myEffectiveTime, myMedication, myDevice, myNote, myDosage);
}
/**
* Gets the value(s) for identifier (id).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* 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.
*
*/
public java.util.List getIdentifier() {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList();
}
return myIdentifier;
}
/**
* Sets the value(s) for identifier (id)
*
*
* Definition:
* 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.
*
*/
public MedicationAdministration setIdentifier(java.util.List theValue) {
myIdentifier = theValue;
return this;
}
/**
* Adds and returns a new value for identifier (id)
*
*
* Definition:
* 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.
*
*/
public IdentifierDt addIdentifier() {
IdentifierDt newType = new IdentifierDt();
getIdentifier().add(newType);
return newType;
}
/**
* Adds a given new value for identifier (id)
*
*
* Definition:
* 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.
*
* @param theValue The identifier to add (must not be null)
*/
public MedicationAdministration addIdentifier(IdentifierDt theValue) {
if (theValue == null) {
throw new NullPointerException("theValue must not be null");
}
getIdentifier().add(theValue);
return this;
}
/**
* Gets the first repetition for identifier (id),
* creating it if it does not already exist.
*
*
* Definition:
* 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.
*
*/
public IdentifierDt getIdentifierFirstRep() {
if (getIdentifier().isEmpty()) {
return addIdentifier();
}
return getIdentifier().get(0);
}
/**
* Gets the value(s) for status (status).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* 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.
*
*/
public BoundCodeDt getStatusElement() {
if (myStatus == null) {
myStatus = new BoundCodeDt(MedicationAdministrationStatusEnum.VALUESET_BINDER);
}
return myStatus;
}
/**
* Gets the value(s) for status (status).
* creating it if it does
* not exist. This method may return null.
*
*
* Definition:
* 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.
*
*/
public String getStatus() {
return getStatusElement().getValue();
}
/**
* Sets the value(s) for status (status)
*
*
* Definition:
* 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.
*
*/
public MedicationAdministration setStatus(BoundCodeDt theValue) {
myStatus = theValue;
return this;
}
/**
* Sets the value(s) for status (status)
*
*
* Definition:
* 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.
*
*/
public MedicationAdministration setStatus(MedicationAdministrationStatusEnum theValue) {
setStatus(new BoundCodeDt(MedicationAdministrationStatusEnum.VALUESET_BINDER, theValue));
/*
getStatusElement().setValueAsEnum(theValue);
*/
return this;
}
/**
* Gets the value(s) for patient (who.focus).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The person or animal receiving the medication.
*
*/
public ResourceReferenceDt getPatient() {
if (myPatient == null) {
myPatient = new ResourceReferenceDt();
}
return myPatient;
}
/**
* Sets the value(s) for patient (who.focus)
*
*
* Definition:
* The person or animal receiving the medication.
*
*/
public MedicationAdministration setPatient(ResourceReferenceDt theValue) {
myPatient = theValue;
return this;
}
/**
* Gets the value(s) for practitioner (who.actor).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The individual who was responsible for giving the medication to the patient.
*
*/
public ResourceReferenceDt getPractitioner() {
if (myPractitioner == null) {
myPractitioner = new ResourceReferenceDt();
}
return myPractitioner;
}
/**
* Sets the value(s) for practitioner (who.actor)
*
*
* Definition:
* The individual who was responsible for giving the medication to the patient.
*
*/
public MedicationAdministration setPractitioner(ResourceReferenceDt theValue) {
myPractitioner = theValue;
return this;
}
/**
* Gets the value(s) for encounter (context).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
*
*/
public ResourceReferenceDt getEncounter() {
if (myEncounter == null) {
myEncounter = new ResourceReferenceDt();
}
return myEncounter;
}
/**
* Sets the value(s) for encounter (context)
*
*
* Definition:
* The visit, admission or other contact between patient and health care provider the medication administration was performed as part of.
*
*/
public MedicationAdministration setEncounter(ResourceReferenceDt theValue) {
myEncounter = theValue;
return this;
}
/**
* Gets the value(s) for prescription ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The original request, instruction or authority to perform the administration.
*
*/
public ResourceReferenceDt getPrescription() {
if (myPrescription == null) {
myPrescription = new ResourceReferenceDt();
}
return myPrescription;
}
/**
* Sets the value(s) for prescription ()
*
*
* Definition:
* The original request, instruction or authority to perform the administration.
*
*/
public MedicationAdministration setPrescription(ResourceReferenceDt theValue) {
myPrescription = theValue;
return this;
}
/**
* Gets the value(s) for wasNotGiven ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Set this to true if the record is saying that the medication was NOT administered.
*
*/
public BooleanDt getWasNotGivenElement() {
if (myWasNotGiven == null) {
myWasNotGiven = new BooleanDt();
}
return myWasNotGiven;
}
/**
* Gets the value(s) for wasNotGiven ().
* creating it if it does
* not exist. This method may return null.
*
*
* Definition:
* Set this to true if the record is saying that the medication was NOT administered.
*
*/
public Boolean getWasNotGiven() {
return getWasNotGivenElement().getValue();
}
/**
* Sets the value(s) for wasNotGiven ()
*
*
* Definition:
* Set this to true if the record is saying that the medication was NOT administered.
*
*/
public MedicationAdministration setWasNotGiven(BooleanDt theValue) {
myWasNotGiven = theValue;
return this;
}
/**
* Sets the value for wasNotGiven ()
*
*
* Definition:
* Set this to true if the record is saying that the medication was NOT administered.
*
*/
public MedicationAdministration setWasNotGiven( boolean theBoolean) {
myWasNotGiven = new BooleanDt(theBoolean);
return this;
}
/**
* Gets the value(s) for reasonNotGiven ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A code indicating why the administration was not performed.
*
*/
public java.util.List getReasonNotGiven() {
if (myReasonNotGiven == null) {
myReasonNotGiven = new java.util.ArrayList();
}
return myReasonNotGiven;
}
/**
* Sets the value(s) for reasonNotGiven ()
*
*
* Definition:
* A code indicating why the administration was not performed.
*
*/
public MedicationAdministration setReasonNotGiven(java.util.List theValue) {
myReasonNotGiven = theValue;
return this;
}
/**
* Adds and returns a new value for reasonNotGiven ()
*
*
* Definition:
* A code indicating why the administration was not performed.
*
*/
public CodeableConceptDt addReasonNotGiven() {
CodeableConceptDt newType = new CodeableConceptDt();
getReasonNotGiven().add(newType);
return newType;
}
/**
* Adds a given new value for reasonNotGiven ()
*
*
* Definition:
* A code indicating why the administration was not performed.
*
* @param theValue The reasonNotGiven to add (must not be null)
*/
public MedicationAdministration addReasonNotGiven(CodeableConceptDt theValue) {
if (theValue == null) {
throw new NullPointerException("theValue must not be null");
}
getReasonNotGiven().add(theValue);
return this;
}
/**
* Gets the first repetition for reasonNotGiven (),
* creating it if it does not already exist.
*
*
* Definition:
* A code indicating why the administration was not performed.
*
*/
public CodeableConceptDt getReasonNotGivenFirstRep() {
if (getReasonNotGiven().isEmpty()) {
return addReasonNotGiven();
}
return getReasonNotGiven().get(0);
}
/**
* Gets the value(s) for reasonGiven ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A code indicating why the medication was given.
*
*/
public java.util.List getReasonGiven() {
if (myReasonGiven == null) {
myReasonGiven = new java.util.ArrayList();
}
return myReasonGiven;
}
/**
* Sets the value(s) for reasonGiven ()
*
*
* Definition:
* A code indicating why the medication was given.
*
*/
public MedicationAdministration setReasonGiven(java.util.List theValue) {
myReasonGiven = theValue;
return this;
}
/**
* Adds and returns a new value for reasonGiven ()
*
*
* Definition:
* A code indicating why the medication was given.
*
*/
public CodeableConceptDt addReasonGiven() {
CodeableConceptDt newType = new CodeableConceptDt();
getReasonGiven().add(newType);
return newType;
}
/**
* Adds a given new value for reasonGiven ()
*
*
* Definition:
* A code indicating why the medication was given.
*
* @param theValue The reasonGiven to add (must not be null)
*/
public MedicationAdministration addReasonGiven(CodeableConceptDt theValue) {
if (theValue == null) {
throw new NullPointerException("theValue must not be null");
}
getReasonGiven().add(theValue);
return this;
}
/**
* Gets the first repetition for reasonGiven (),
* creating it if it does not already exist.
*
*
* Definition:
* A code indicating why the medication was given.
*
*/
public CodeableConceptDt getReasonGivenFirstRep() {
if (getReasonGiven().isEmpty()) {
return addReasonGiven();
}
return getReasonGiven().get(0);
}
/**
* Gets the value(s) for effectiveTime[x] (when.done).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* 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.
*
*/
public IDatatype getEffectiveTime() {
return myEffectiveTime;
}
/**
* Sets the value(s) for effectiveTime[x] (when.done)
*
*
* Definition:
* 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.
*
*/
public MedicationAdministration setEffectiveTime(IDatatype theValue) {
myEffectiveTime = theValue;
return this;
}
/**
* Gets the value(s) for medication[x] ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* 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.
*
*/
public IDatatype getMedication() {
return myMedication;
}
/**
* Sets the value(s) for medication[x] ()
*
*
* Definition:
* 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.
*
*/
public MedicationAdministration setMedication(IDatatype theValue) {
myMedication = theValue;
return this;
}
/**
* Gets the value(s) for device ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The device used in administering the medication to the patient. For example, a particular infusion pump
*
*/
public java.util.List getDevice() {
if (myDevice == null) {
myDevice = new java.util.ArrayList();
}
return myDevice;
}
/**
* Sets the value(s) for device ()
*
*
* Definition:
* The device used in administering the medication to the patient. For example, a particular infusion pump
*
*/
public MedicationAdministration setDevice(java.util.List theValue) {
myDevice = theValue;
return this;
}
/**
* Adds and returns a new value for device ()
*
*
* Definition:
* The device used in administering the medication to the patient. For example, a particular infusion pump
*
*/
public ResourceReferenceDt addDevice() {
ResourceReferenceDt newType = new ResourceReferenceDt();
getDevice().add(newType);
return newType;
}
/**
* Gets the value(s) for note ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Extra information about the medication administration that is not conveyed by the other attributes.
*
*/
public StringDt getNoteElement() {
if (myNote == null) {
myNote = new StringDt();
}
return myNote;
}
/**
* Gets the value(s) for note ().
* creating it if it does
* not exist. This method may return null.
*
*
* Definition:
* Extra information about the medication administration that is not conveyed by the other attributes.
*
*/
public String getNote() {
return getNoteElement().getValue();
}
/**
* Sets the value(s) for note ()
*
*
* Definition:
* Extra information about the medication administration that is not conveyed by the other attributes.
*
*/
public MedicationAdministration setNote(StringDt theValue) {
myNote = theValue;
return this;
}
/**
* Sets the value for note ()
*
*
* Definition:
* Extra information about the medication administration that is not conveyed by the other attributes.
*
*/
public MedicationAdministration setNote( String theString) {
myNote = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for dosage ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Describes the medication dosage information details e.g. dose, rate, site, route, etc.
*
*/
public Dosage getDosage() {
if (myDosage == null) {
myDosage = new Dosage();
}
return myDosage;
}
/**
* Sets the value(s) for dosage ()
*
*
* Definition:
* Describes the medication dosage information details e.g. dose, rate, site, route, etc.
*
*/
public MedicationAdministration setDosage(Dosage theValue) {
myDosage = theValue;
return this;
}
/**
* Block class for child element: MedicationAdministration.dosage ()
*
*
* Definition:
* Describes the medication dosage information details e.g. dose, rate, site, route, etc.
*
*/
@Block()
public static class Dosage
extends BaseIdentifiableElement
implements IResourceBlock {
@Child(name="text", type=StringDt.class, order=0, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication."
)
private StringDt myText;
@Child(name="site", order=1, min=0, max=1, summary=false, modifier=false, type={
CodeableConceptDt.class,
BodySite.class
})
@Description(
shortDefinition="",
formalDefinition="A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\""
)
private IDatatype mySite;
@Child(name="route", type=CodeableConceptDt.class, order=2, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc."
)
private CodeableConceptDt myRoute;
@Child(name="method", type=CodeableConceptDt.class, order=3, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV."
)
private CodeableConceptDt myMethod;
@Child(name="quantity", type=SimpleQuantityDt.class, order=4, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="",
formalDefinition="The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection."
)
private SimpleQuantityDt myQuantity;
@Child(name="rate", order=5, min=0, max=1, summary=false, modifier=false, type={
RatioDt.class,
RangeDt.class
})
@Description(
shortDefinition="",
formalDefinition="Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours."
)
private IDatatype myRate;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myText, mySite, myRoute, myMethod, myQuantity, myRate);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myText, mySite, myRoute, myMethod, myQuantity, myRate);
}
/**
* Gets the value(s) for text ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
*
*/
public StringDt getTextElement() {
if (myText == null) {
myText = new StringDt();
}
return myText;
}
/**
* Gets the value(s) for text ().
* creating it if it does
* not exist. This method may return null.
*
*
* Definition:
* Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
*
*/
public String getText() {
return getTextElement().getValue();
}
/**
* Sets the value(s) for text ()
*
*
* Definition:
* Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
*
*/
public Dosage setText(StringDt theValue) {
myText = theValue;
return this;
}
/**
* Sets the value for text ()
*
*
* Definition:
* Free text dosage instructions can be used for cases where the instructions are too complex to code. When coded instructions are present, the free text instructions may still be present for display to humans taking or administering the medication.
*
*/
public Dosage setText( String theString) {
myText = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for site[x] ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"
*
*/
public IDatatype getSite() {
return mySite;
}
/**
* Sets the value(s) for site[x] ()
*
*
* Definition:
* A coded specification of the anatomic site where the medication first entered the body. For example, \"left arm\"
*
*/
public Dosage setSite(IDatatype theValue) {
mySite = theValue;
return this;
}
/**
* Gets the value(s) for route ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
*
*/
public CodeableConceptDt getRoute() {
if (myRoute == null) {
myRoute = new CodeableConceptDt();
}
return myRoute;
}
/**
* Sets the value(s) for route ()
*
*
* Definition:
* A code specifying the route or physiological path of administration of a therapeutic agent into or onto the patient. For example, topical, intravenous, etc.
*
*/
public Dosage setRoute(CodeableConceptDt theValue) {
myRoute = theValue;
return this;
}
/**
* Gets the value(s) for method ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
*
*/
public CodeableConceptDt getMethod() {
if (myMethod == null) {
myMethod = new CodeableConceptDt();
}
return myMethod;
}
/**
* Sets the value(s) for method ()
*
*
* Definition:
* A coded value indicating the method by which the medication is intended to be or was introduced into or on the body. This attribute will most often NOT be populated. It is most commonly used for injections. For example, Slow Push, Deep IV.
*
*/
public Dosage setMethod(CodeableConceptDt theValue) {
myMethod = theValue;
return this;
}
/**
* Gets the value(s) for quantity ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
*
*/
public SimpleQuantityDt getQuantity() {
if (myQuantity == null) {
myQuantity = new SimpleQuantityDt();
}
return myQuantity;
}
/**
* Sets the value(s) for quantity ()
*
*
* Definition:
* The amount of the medication given at one administration event. Use this value when the administration is essentially an instantaneous event such as a swallowing a tablet or giving an injection.
*
*/
public Dosage setQuantity(SimpleQuantityDt theValue) {
myQuantity = theValue;
return this;
}
/**
* Gets the value(s) for rate[x] ().
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
*
*/
public IDatatype getRate() {
return myRate;
}
/**
* Sets the value(s) for rate[x] ()
*
*
* Definition:
* Identifies the speed with which the medication was or will be introduced into the patient. Typically the rate for an infusion e.g. 100 ml per 1 hour or 100 ml/hr. May also be expressed as a rate per unit of time e.g. 500 ml per 2 hours. Currently we do not specify a default of '1' in the denominator, but this is being discussed. Other examples: 200 mcg/min or 200 mcg/1 minute; 1 liter/8 hours.
*
*/
public Dosage setRate(IDatatype theValue) {
myRate = theValue;
return this;
}
}
@Override
public String getResourceName() {
return "MedicationAdministration";
}
public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum() {
return ca.uhn.fhir.context.FhirVersionEnum.DSTU2;
}
}