ca.uhn.fhir.model.dstu.resource.Provenance Maven / Gradle / Ivy
package ca.uhn.fhir.model.dstu.resource;
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.dstu.composite.AddressDt;
import ca.uhn.fhir.model.dstu.valueset.AdministrativeGenderCodesEnum;
import ca.uhn.fhir.model.dstu.valueset.AdmitSourceEnum;
import ca.uhn.fhir.model.dstu.resource.AdverseReaction;
import ca.uhn.fhir.model.dstu.valueset.AggregationModeEnum;
import ca.uhn.fhir.model.dstu.valueset.AlertStatusEnum;
import ca.uhn.fhir.model.dstu.resource.AllergyIntolerance;
import ca.uhn.fhir.model.dstu.valueset.AnimalSpeciesEnum;
import ca.uhn.fhir.model.dstu.resource.Appointment;
import ca.uhn.fhir.model.dstu.composite.AttachmentDt;
import ca.uhn.fhir.model.dstu.resource.Availability;
import ca.uhn.fhir.model.dstu.valueset.BindingConformanceEnum;
import ca.uhn.fhir.model.dstu.resource.CarePlan;
import ca.uhn.fhir.model.dstu.valueset.CarePlanActivityCategoryEnum;
import ca.uhn.fhir.model.dstu.valueset.CarePlanActivityStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.CarePlanGoalStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.CarePlanStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.CausalityExpectationEnum;
import ca.uhn.fhir.model.dstu.composite.CodeableConceptDt;
import ca.uhn.fhir.model.dstu.composite.CodingDt;
import ca.uhn.fhir.model.dstu.valueset.CompositionAttestationModeEnum;
import ca.uhn.fhir.model.dstu.valueset.CompositionStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.ConceptMapEquivalenceEnum;
import ca.uhn.fhir.model.dstu.resource.Condition;
import ca.uhn.fhir.model.dstu.valueset.ConditionRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ConditionStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.ConformanceEventModeEnum;
import ca.uhn.fhir.model.dstu.valueset.ConformanceStatementStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.ConstraintSeverityEnum;
import ca.uhn.fhir.model.dstu.composite.ContactDt;
import ca.uhn.fhir.model.dstu.valueset.ContactUseEnum;
import ca.uhn.fhir.model.dstu.valueset.CriticalityEnum;
import ca.uhn.fhir.model.dstu.valueset.DataTypeEnum;
import ca.uhn.fhir.model.dstu.resource.Device;
import ca.uhn.fhir.model.dstu.resource.DeviceObservationReport;
import ca.uhn.fhir.model.dstu.resource.DiagnosticOrder;
import ca.uhn.fhir.model.dstu.valueset.DiagnosticOrderPriorityEnum;
import ca.uhn.fhir.model.dstu.valueset.DiagnosticOrderStatusEnum;
import ca.uhn.fhir.model.dstu.resource.DiagnosticReport;
import ca.uhn.fhir.model.dstu.valueset.DiagnosticReportStatusEnum;
import ca.uhn.fhir.model.dstu.resource.DocumentManifest;
import ca.uhn.fhir.model.dstu.valueset.DocumentModeEnum;
import ca.uhn.fhir.model.dstu.resource.DocumentReference;
import ca.uhn.fhir.model.dstu.valueset.DocumentReferenceStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.DocumentRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu.resource.Encounter;
import ca.uhn.fhir.model.dstu.valueset.EncounterClassEnum;
import ca.uhn.fhir.model.dstu.valueset.EncounterStateEnum;
import ca.uhn.fhir.model.dstu.valueset.EncounterTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ExposureTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ExtensionContextEnum;
import ca.uhn.fhir.model.dstu.valueset.FHIRDefinedTypeEnum;
import ca.uhn.fhir.model.dstu.resource.FamilyHistory;
import ca.uhn.fhir.model.dstu.valueset.FilterOperatorEnum;
import ca.uhn.fhir.model.dstu.resource.GVFMeta;
import ca.uhn.fhir.model.dstu.resource.Group;
import ca.uhn.fhir.model.dstu.valueset.GroupTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.HierarchicalRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu.composite.HumanNameDt;
import ca.uhn.fhir.model.dstu.composite.IdentifierDt;
import ca.uhn.fhir.model.dstu.valueset.IdentifierUseEnum;
import ca.uhn.fhir.model.dstu.valueset.ImagingModalityEnum;
import ca.uhn.fhir.model.dstu.resource.ImagingStudy;
import ca.uhn.fhir.model.dstu.resource.Immunization;
import ca.uhn.fhir.model.dstu.valueset.ImmunizationReasonCodesEnum;
import ca.uhn.fhir.model.dstu.resource.ImmunizationRecommendation;
import ca.uhn.fhir.model.dstu.valueset.ImmunizationRecommendationDateCriterionCodesEnum;
import ca.uhn.fhir.model.dstu.valueset.ImmunizationRecommendationStatusCodesEnum;
import ca.uhn.fhir.model.dstu.valueset.ImmunizationRouteCodesEnum;
import ca.uhn.fhir.model.dstu.valueset.InstanceAvailabilityEnum;
import ca.uhn.fhir.model.dstu.valueset.IssueSeverityEnum;
import ca.uhn.fhir.model.dstu.valueset.IssueTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.LinkTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ListModeEnum;
import ca.uhn.fhir.model.dstu.resource.Location;
import ca.uhn.fhir.model.dstu.valueset.LocationModeEnum;
import ca.uhn.fhir.model.dstu.valueset.LocationStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.LocationTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.MaritalStatusCodesEnum;
import ca.uhn.fhir.model.dstu.resource.Media;
import ca.uhn.fhir.model.dstu.valueset.MediaTypeEnum;
import ca.uhn.fhir.model.dstu.resource.Medication;
import ca.uhn.fhir.model.dstu.resource.MedicationAdministration;
import ca.uhn.fhir.model.dstu.valueset.MedicationAdministrationStatusEnum;
import ca.uhn.fhir.model.dstu.resource.MedicationDispense;
import ca.uhn.fhir.model.dstu.valueset.MedicationDispenseStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.MedicationKindEnum;
import ca.uhn.fhir.model.dstu.resource.MedicationPrescription;
import ca.uhn.fhir.model.dstu.valueset.MedicationPrescriptionStatusEnum;
import ca.uhn.fhir.model.dstu.resource.MedicationStatement;
import ca.uhn.fhir.model.dstu.valueset.MessageEventEnum;
import ca.uhn.fhir.model.dstu.valueset.MessageSignificanceCategoryEnum;
import ca.uhn.fhir.model.dstu.valueset.MessageTransportEnum;
import ca.uhn.fhir.model.dstu.resource.Microarray;
import ca.uhn.fhir.model.dstu.valueset.ModalityEnum;
import ca.uhn.fhir.model.dstu.resource.Observation;
import ca.uhn.fhir.model.dstu.valueset.ObservationRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ObservationReliabilityEnum;
import ca.uhn.fhir.model.dstu.valueset.ObservationStatusEnum;
import ca.uhn.fhir.model.dstu.resource.OperationOutcome;
import ca.uhn.fhir.model.dstu.resource.Order;
import ca.uhn.fhir.model.dstu.valueset.OrderOutcomeStatusEnum;
import ca.uhn.fhir.model.dstu.resource.Organization;
import ca.uhn.fhir.model.dstu.valueset.OrganizationTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ParticipantTypeEnum;
import ca.uhn.fhir.model.dstu.resource.Patient;
import ca.uhn.fhir.model.dstu.composite.PeriodDt;
import ca.uhn.fhir.model.dstu.resource.Practitioner;
import ca.uhn.fhir.model.dstu.valueset.PractitionerRoleEnum;
import ca.uhn.fhir.model.dstu.valueset.PractitionerSpecialtyEnum;
import ca.uhn.fhir.model.dstu.resource.Procedure;
import ca.uhn.fhir.model.dstu.valueset.ProcedureRelationshipTypeEnum;
import ca.uhn.fhir.model.dstu.resource.Profile;
import ca.uhn.fhir.model.dstu.valueset.PropertyRepresentationEnum;
import ca.uhn.fhir.model.dstu.valueset.ProvenanceEntityRoleEnum;
import ca.uhn.fhir.model.dstu.valueset.QuantityCompararatorEnum;
import ca.uhn.fhir.model.dstu.composite.QuantityDt;
import ca.uhn.fhir.model.dstu.valueset.QueryOutcomeEnum;
import ca.uhn.fhir.model.dstu.valueset.QuestionnaireGroupNameEnum;
import ca.uhn.fhir.model.dstu.valueset.QuestionnaireNameEnum;
import ca.uhn.fhir.model.dstu.valueset.QuestionnaireStatusEnum;
import ca.uhn.fhir.model.dstu.composite.RangeDt;
import ca.uhn.fhir.model.dstu.composite.RatioDt;
import ca.uhn.fhir.model.dstu.valueset.ReactionSeverityEnum;
import ca.uhn.fhir.model.dstu.resource.RelatedPerson;
import ca.uhn.fhir.model.dstu.valueset.ResourceProfileStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.ResourceTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.ResponseTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.RestfulConformanceModeEnum;
import ca.uhn.fhir.model.dstu.valueset.RestfulOperationSystemEnum;
import ca.uhn.fhir.model.dstu.valueset.RestfulOperationTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.RestfulSecurityServiceEnum;
import ca.uhn.fhir.model.dstu.composite.SampledDataDt;
import ca.uhn.fhir.model.dstu.composite.ScheduleDt;
import ca.uhn.fhir.model.dstu.valueset.SearchParamTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventActionEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventObjectLifecycleEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventObjectRoleEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventObjectTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventOutcomeEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventParticipantNetworkTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.SecurityEventSourceTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.SensitivityStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.SensitivityTypeEnum;
import ca.uhn.fhir.model.dstu.resource.SequencingAnalysis;
import ca.uhn.fhir.model.dstu.resource.SequencingLab;
import ca.uhn.fhir.model.dstu.valueset.SlicingRulesEnum;
import ca.uhn.fhir.model.dstu.resource.Slot;
import ca.uhn.fhir.model.dstu.resource.Specimen;
import ca.uhn.fhir.model.dstu.valueset.SpecimenCollectionMethodEnum;
import ca.uhn.fhir.model.dstu.resource.Substance;
import ca.uhn.fhir.model.dstu.valueset.SupplyDispenseStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.SupplyItemTypeEnum;
import ca.uhn.fhir.model.dstu.valueset.SupplyStatusEnum;
import ca.uhn.fhir.model.dstu.valueset.SupplyTypeEnum;
import ca.uhn.fhir.model.api.TemporalPrecisionEnum;
import ca.uhn.fhir.model.dstu.resource.ValueSet;
import ca.uhn.fhir.model.dstu.valueset.ValueSetStatusEnum;
import ca.uhn.fhir.model.api.ExtensionDt;
import ca.uhn.fhir.model.api.IResource;
import ca.uhn.fhir.model.dstu.composite.AgeDt;
import ca.uhn.fhir.model.dstu.composite.DurationDt;
import ca.uhn.fhir.model.dstu.composite.ResourceReferenceDt;
import ca.uhn.fhir.model.dstu.resource.Binary;
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.BoundCodeableConceptDt;
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.IdrefDt;
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.StringDt;
import ca.uhn.fhir.model.primitive.UriDt;
/**
* HAPI/FHIR Provenance Resource
* (Who, What, When for a set of resources)
*
*
* Definition:
* Provenance information that describes the activity that led to the creation of a set of resources. This information can be used to help determine their reliability or trace where the information in them came from. The focus of the provenance resource is record keeping, audit and traceability, and not explicit statements of clinical significance
*
*
*
* Requirements:
*
*
*
*
* Profile Definition:
* http://hl7.org/fhir/profiles/Provenance
*
*
*/
@ResourceDef(name="Provenance", profile="http://hl7.org/fhir/profiles/Provenance", id="provenance")
public class Provenance extends ca.uhn.fhir.model.dstu.resource.BaseResource
implements IResource {
/**
* Search parameter constant for target
*
* Description:
* Type: reference
* Path: Provenance.target
*
*/
@SearchParamDefinition(name="target", path="Provenance.target", description="", type="reference" )
public static final String SP_TARGET = "target";
/**
* Fluent Client search parameter constant for target
*
* Description:
* Type: reference
* Path: Provenance.target
*
*/
public static final ReferenceClientParam TARGET = new ReferenceClientParam(SP_TARGET);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "Provenance.target".
*/
public static final Include INCLUDE_TARGET = new Include("Provenance.target");
/**
* Search parameter constant for start
*
* Description:
* Type: date
* Path: Provenance.period.start
*
*/
@SearchParamDefinition(name="start", path="Provenance.period.start", description="", type="date" )
public static final String SP_START = "start";
/**
* Fluent Client search parameter constant for start
*
* Description:
* Type: date
* Path: Provenance.period.start
*
*/
public static final DateClientParam START = new DateClientParam(SP_START);
/**
* Search parameter constant for end
*
* Description:
* Type: date
* Path: Provenance.period.end
*
*/
@SearchParamDefinition(name="end", path="Provenance.period.end", description="", type="date" )
public static final String SP_END = "end";
/**
* Fluent Client search parameter constant for end
*
* Description:
* Type: date
* Path: Provenance.period.end
*
*/
public static final DateClientParam END = new DateClientParam(SP_END);
/**
* Search parameter constant for location
*
* Description:
* Type: reference
* Path: Provenance.location
*
*/
@SearchParamDefinition(name="location", path="Provenance.location", description="", type="reference" )
public static final String SP_LOCATION = "location";
/**
* Fluent Client search parameter constant for location
*
* Description:
* Type: reference
* Path: Provenance.location
*
*/
public static final ReferenceClientParam LOCATION = new ReferenceClientParam(SP_LOCATION);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "Provenance.location".
*/
public static final Include INCLUDE_LOCATION = new Include("Provenance.location");
/**
* Search parameter constant for party
*
* Description:
* Type: token
* Path: Provenance.agent.reference
*
*/
@SearchParamDefinition(name="party", path="Provenance.agent.reference", description="", type="token" )
public static final String SP_PARTY = "party";
/**
* Fluent Client search parameter constant for party
*
* Description:
* Type: token
* Path: Provenance.agent.reference
*
*/
public static final TokenClientParam PARTY = new TokenClientParam(SP_PARTY);
/**
* Search parameter constant for partytype
*
* Description:
* Type: token
* Path: Provenance.agent.type
*
*/
@SearchParamDefinition(name="partytype", path="Provenance.agent.type", description="", type="token" )
public static final String SP_PARTYTYPE = "partytype";
/**
* Fluent Client search parameter constant for partytype
*
* Description:
* Type: token
* Path: Provenance.agent.type
*
*/
public static final TokenClientParam PARTYTYPE = new TokenClientParam(SP_PARTYTYPE);
@Child(name="target", order=0, min=1, max=Child.MAX_UNLIMITED, summary=false, modifier=false, type={
IResource.class })
@Description(
shortDefinition="Target resource(s) (usually version specific)",
formalDefinition="The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity"
)
private java.util.List myTarget;
@Child(name="period", type=PeriodDt.class, order=1, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="When the activity occurred",
formalDefinition="The period during which the activity occurred"
)
private PeriodDt myPeriod;
@Child(name="recorded", type=InstantDt.class, order=2, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="When the activity was recorded / updated",
formalDefinition="The instant of time at which the activity was recorded"
)
private InstantDt myRecorded;
@Child(name="reason", type=CodeableConceptDt.class, order=3, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Reason the activity is occurring",
formalDefinition="The reason that the activity was taking place"
)
private CodeableConceptDt myReason;
@Child(name="location", order=4, min=0, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.Location.class })
@Description(
shortDefinition="Where the activity occurred, if relevant",
formalDefinition="Where the activity occurred, if relevant"
)
private ResourceReferenceDt myLocation;
@Child(name="policy", type=UriDt.class, order=5, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="Policy or plan the activity was defined by",
formalDefinition="Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc."
)
private java.util.List myPolicy;
@Child(name="agent", order=6, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="Person, organization, records, etc. involved in creating resource",
formalDefinition="An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility"
)
private java.util.List myAgent;
@Child(name="entity", order=7, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="An entity used in this activity",
formalDefinition="An entity used in this activity"
)
private java.util.List myEntity;
@Child(name="integritySignature", type=StringDt.class, order=8, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Base64 signature (DigSig) - integrity check",
formalDefinition="A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation."
)
private StringDt myIntegritySignature;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myTarget, myPeriod, myRecorded, myReason, myLocation, myPolicy, myAgent, myEntity, myIntegritySignature);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myTarget, myPeriod, myRecorded, myReason, myLocation, myPolicy, myAgent, myEntity, myIntegritySignature);
}
/**
* Gets the value(s) for target (Target resource(s) (usually version specific)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity
*
*/
public java.util.List getTarget() {
if (myTarget == null) {
myTarget = new java.util.ArrayList();
}
return myTarget;
}
/**
* Gets the value(s) for target (Target resource(s) (usually version specific)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity
*
*/
public java.util.List getTargetElement() {
if (myTarget == null) {
myTarget = new java.util.ArrayList();
}
return myTarget;
}
/**
* Sets the value(s) for target (Target resource(s) (usually version specific))
*
*
* Definition:
* The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity
*
*/
public Provenance setTarget(java.util.List theValue) {
myTarget = theValue;
return this;
}
/**
* Adds and returns a new value for target (Target resource(s) (usually version specific))
*
*
* Definition:
* The resource(s) that were generated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity
*
*/
public ResourceReferenceDt addTarget() {
ResourceReferenceDt newType = new ResourceReferenceDt();
getTarget().add(newType);
return newType;
}
/**
* Gets the value(s) for period (When the activity occurred).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The period during which the activity occurred
*
*/
public PeriodDt getPeriod() {
if (myPeriod == null) {
myPeriod = new PeriodDt();
}
return myPeriod;
}
/**
* Gets the value(s) for period (When the activity occurred).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The period during which the activity occurred
*
*/
public PeriodDt getPeriodElement() {
if (myPeriod == null) {
myPeriod = new PeriodDt();
}
return myPeriod;
}
/**
* Sets the value(s) for period (When the activity occurred)
*
*
* Definition:
* The period during which the activity occurred
*
*/
public Provenance setPeriod(PeriodDt theValue) {
myPeriod = theValue;
return this;
}
/**
* Gets the value(s) for recorded (When the activity was recorded / updated).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The instant of time at which the activity was recorded
*
*/
public InstantDt getRecorded() {
if (myRecorded == null) {
myRecorded = new InstantDt();
}
return myRecorded;
}
/**
* Gets the value(s) for recorded (When the activity was recorded / updated).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The instant of time at which the activity was recorded
*
*/
public InstantDt getRecordedElement() {
if (myRecorded == null) {
myRecorded = new InstantDt();
}
return myRecorded;
}
/**
* Sets the value(s) for recorded (When the activity was recorded / updated)
*
*
* Definition:
* The instant of time at which the activity was recorded
*
*/
public Provenance setRecorded(InstantDt theValue) {
myRecorded = theValue;
return this;
}
/**
* Sets the value for recorded (When the activity was recorded / updated)
*
*
* Definition:
* The instant of time at which the activity was recorded
*
*/
public Provenance setRecordedWithMillisPrecision( Date theDate) {
myRecorded = new InstantDt(theDate);
return this;
}
/**
* Sets the value for recorded (When the activity was recorded / updated)
*
*
* Definition:
* The instant of time at which the activity was recorded
*
*/
public Provenance setRecorded( Date theDate, TemporalPrecisionEnum thePrecision) {
myRecorded = new InstantDt(theDate, thePrecision);
return this;
}
/**
* Gets the value(s) for reason (Reason the activity is occurring).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The reason that the activity was taking place
*
*/
public CodeableConceptDt getReason() {
if (myReason == null) {
myReason = new CodeableConceptDt();
}
return myReason;
}
/**
* Gets the value(s) for reason (Reason the activity is occurring).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The reason that the activity was taking place
*
*/
public CodeableConceptDt getReasonElement() {
if (myReason == null) {
myReason = new CodeableConceptDt();
}
return myReason;
}
/**
* Sets the value(s) for reason (Reason the activity is occurring)
*
*
* Definition:
* The reason that the activity was taking place
*
*/
public Provenance setReason(CodeableConceptDt theValue) {
myReason = theValue;
return this;
}
/**
* Gets the value(s) for location (Where the activity occurred, if relevant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Where the activity occurred, if relevant
*
*/
public ResourceReferenceDt getLocation() {
if (myLocation == null) {
myLocation = new ResourceReferenceDt();
}
return myLocation;
}
/**
* Gets the value(s) for location (Where the activity occurred, if relevant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Where the activity occurred, if relevant
*
*/
public ResourceReferenceDt getLocationElement() {
if (myLocation == null) {
myLocation = new ResourceReferenceDt();
}
return myLocation;
}
/**
* Sets the value(s) for location (Where the activity occurred, if relevant)
*
*
* Definition:
* Where the activity occurred, if relevant
*
*/
public Provenance setLocation(ResourceReferenceDt theValue) {
myLocation = theValue;
return this;
}
/**
* Gets the value(s) for policy (Policy or plan the activity was defined by).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
*
*/
public java.util.List getPolicy() {
if (myPolicy == null) {
myPolicy = new java.util.ArrayList();
}
return myPolicy;
}
/**
* Gets the value(s) for policy (Policy or plan the activity was defined by).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
*
*/
public java.util.List getPolicyElement() {
if (myPolicy == null) {
myPolicy = new java.util.ArrayList();
}
return myPolicy;
}
/**
* Sets the value(s) for policy (Policy or plan the activity was defined by)
*
*
* Definition:
* Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
*
*/
public Provenance setPolicy(java.util.List theValue) {
myPolicy = theValue;
return this;
}
/**
* Adds and returns a new value for policy (Policy or plan the activity was defined by)
*
*
* Definition:
* Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
*
*/
public UriDt addPolicy() {
UriDt newType = new UriDt();
getPolicy().add(newType);
return newType;
}
/**
* Gets the first repetition for policy (Policy or plan the activity was defined by),
* creating it if it does not already exist.
*
*
* Definition:
* Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
*
*/
public UriDt getPolicyFirstRep() {
if (getPolicy().isEmpty()) {
return addPolicy();
}
return getPolicy().get(0);
}
/**
* Adds a new value for policy (Policy or plan the activity was defined by)
*
*
* Definition:
* Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc.
*
*
* @return Returns a reference to this object, to allow for simple chaining.
*/
public Provenance addPolicy( String theUri) {
if (myPolicy == null) {
myPolicy = new java.util.ArrayList();
}
myPolicy.add(new UriDt(theUri));
return this;
}
/**
* Gets the value(s) for agent (Person, organization, records, etc. involved in creating resource).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
*
*/
public java.util.List getAgent() {
if (myAgent == null) {
myAgent = new java.util.ArrayList();
}
return myAgent;
}
/**
* Gets the value(s) for agent (Person, organization, records, etc. involved in creating resource).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
*
*/
public java.util.List getAgentElement() {
if (myAgent == null) {
myAgent = new java.util.ArrayList();
}
return myAgent;
}
/**
* Sets the value(s) for agent (Person, organization, records, etc. involved in creating resource)
*
*
* Definition:
* An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
*
*/
public Provenance setAgent(java.util.List theValue) {
myAgent = theValue;
return this;
}
/**
* Adds and returns a new value for agent (Person, organization, records, etc. involved in creating resource)
*
*
* Definition:
* An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
*
*/
public Agent addAgent() {
Agent newType = new Agent();
getAgent().add(newType);
return newType;
}
/**
* Gets the first repetition for agent (Person, organization, records, etc. involved in creating resource),
* creating it if it does not already exist.
*
*
* Definition:
* An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
*
*/
public Agent getAgentFirstRep() {
if (getAgent().isEmpty()) {
return addAgent();
}
return getAgent().get(0);
}
/**
* Gets the value(s) for entity (An entity used in this activity).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* An entity used in this activity
*
*/
public java.util.List getEntity() {
if (myEntity == null) {
myEntity = new java.util.ArrayList();
}
return myEntity;
}
/**
* Gets the value(s) for entity (An entity used in this activity).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* An entity used in this activity
*
*/
public java.util.List getEntityElement() {
if (myEntity == null) {
myEntity = new java.util.ArrayList();
}
return myEntity;
}
/**
* Sets the value(s) for entity (An entity used in this activity)
*
*
* Definition:
* An entity used in this activity
*
*/
public Provenance setEntity(java.util.List theValue) {
myEntity = theValue;
return this;
}
/**
* Adds and returns a new value for entity (An entity used in this activity)
*
*
* Definition:
* An entity used in this activity
*
*/
public Entity addEntity() {
Entity newType = new Entity();
getEntity().add(newType);
return newType;
}
/**
* Gets the first repetition for entity (An entity used in this activity),
* creating it if it does not already exist.
*
*
* Definition:
* An entity used in this activity
*
*/
public Entity getEntityFirstRep() {
if (getEntity().isEmpty()) {
return addEntity();
}
return getEntity().get(0);
}
/**
* Gets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.
*
*/
public StringDt getIntegritySignature() {
if (myIntegritySignature == null) {
myIntegritySignature = new StringDt();
}
return myIntegritySignature;
}
/**
* Gets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.
*
*/
public StringDt getIntegritySignatureElement() {
if (myIntegritySignature == null) {
myIntegritySignature = new StringDt();
}
return myIntegritySignature;
}
/**
* Sets the value(s) for integritySignature (Base64 signature (DigSig) - integrity check)
*
*
* Definition:
* A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.
*
*/
public Provenance setIntegritySignature(StringDt theValue) {
myIntegritySignature = theValue;
return this;
}
/**
* Sets the value for integritySignature (Base64 signature (DigSig) - integrity check)
*
*
* Definition:
* A digital signature on the target resource(s). The signature should match a Provenance.agent.reference in the provenance resource. The signature is only added to support checking cryptographic integrity of the resource, and not to represent workflow and clinical aspects of the signing process, or to support non-repudiation.
*
*/
public Provenance setIntegritySignature( String theString) {
myIntegritySignature = new StringDt(theString);
return this;
}
/**
* Block class for child element: Provenance.agent (Person, organization, records, etc. involved in creating resource)
*
*
* Definition:
* An agent takes a role in an activity such that the agent can be assigned some degree of responsibility for the activity taking place. An agent can be a person, a piece of software, an inanimate object, an organization, or other entities that may be ascribed responsibility
*
*/
@Block()
public static class Agent
extends BaseIdentifiableElement implements IResourceBlock {
@Child(name="role", type=CodingDt.class, order=0, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="e.g. author | overseer | enterer | attester | source | cc: +",
formalDefinition="The role that the participant played"
)
private CodingDt myRole;
@Child(name="type", type=CodingDt.class, order=1, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="e.g. Resource | Person | Application | Record | Document +",
formalDefinition="The type of the participant"
)
private CodingDt myType;
@Child(name="reference", type=UriDt.class, order=2, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Identity of agent (urn or url)",
formalDefinition="Identity of participant. May be a logical or physical uri and maybe absolute or relative"
)
private UriDt myReference;
@Child(name="display", type=StringDt.class, order=3, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Human description of participant",
formalDefinition="Human-readable description of the participant"
)
private StringDt myDisplay;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myRole, myType, myReference, myDisplay);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myRole, myType, myReference, myDisplay);
}
/**
* Gets the value(s) for role (e.g. author | overseer | enterer | attester | source | cc: +).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The role that the participant played
*
*/
public CodingDt getRole() {
if (myRole == null) {
myRole = new CodingDt();
}
return myRole;
}
/**
* Gets the value(s) for role (e.g. author | overseer | enterer | attester | source | cc: +).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The role that the participant played
*
*/
public CodingDt getRoleElement() {
if (myRole == null) {
myRole = new CodingDt();
}
return myRole;
}
/**
* Sets the value(s) for role (e.g. author | overseer | enterer | attester | source | cc: +)
*
*
* Definition:
* The role that the participant played
*
*/
public Agent setRole(CodingDt theValue) {
myRole = theValue;
return this;
}
/**
* Gets the value(s) for type (e.g. Resource | Person | Application | Record | Document +).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The type of the participant
*
*/
public CodingDt getType() {
if (myType == null) {
myType = new CodingDt();
}
return myType;
}
/**
* Gets the value(s) for type (e.g. Resource | Person | Application | Record | Document +).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The type of the participant
*
*/
public CodingDt getTypeElement() {
if (myType == null) {
myType = new CodingDt();
}
return myType;
}
/**
* Sets the value(s) for type (e.g. Resource | Person | Application | Record | Document +)
*
*
* Definition:
* The type of the participant
*
*/
public Agent setType(CodingDt theValue) {
myType = theValue;
return this;
}
/**
* Gets the value(s) for reference (Identity of agent (urn or url)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public UriDt getReference() {
if (myReference == null) {
myReference = new UriDt();
}
return myReference;
}
/**
* Gets the value(s) for reference (Identity of agent (urn or url)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public UriDt getReferenceElement() {
if (myReference == null) {
myReference = new UriDt();
}
return myReference;
}
/**
* Sets the value(s) for reference (Identity of agent (urn or url))
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public Agent setReference(UriDt theValue) {
myReference = theValue;
return this;
}
/**
* Sets the value for reference (Identity of agent (urn or url))
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public Agent setReference( String theUri) {
myReference = new UriDt(theUri);
return this;
}
/**
* Gets the value(s) for display (Human description of participant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Human-readable description of the participant
*
*/
public StringDt getDisplay() {
if (myDisplay == null) {
myDisplay = new StringDt();
}
return myDisplay;
}
/**
* Gets the value(s) for display (Human description of participant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Human-readable description of the participant
*
*/
public StringDt getDisplayElement() {
if (myDisplay == null) {
myDisplay = new StringDt();
}
return myDisplay;
}
/**
* Sets the value(s) for display (Human description of participant)
*
*
* Definition:
* Human-readable description of the participant
*
*/
public Agent setDisplay(StringDt theValue) {
myDisplay = theValue;
return this;
}
/**
* Sets the value for display (Human description of participant)
*
*
* Definition:
* Human-readable description of the participant
*
*/
public Agent setDisplay( String theString) {
myDisplay = new StringDt(theString);
return this;
}
}
/**
* Block class for child element: Provenance.entity (An entity used in this activity)
*
*
* Definition:
* An entity used in this activity
*
*/
@Block()
public static class Entity
extends BaseIdentifiableElement implements IResourceBlock {
@Child(name="role", type=CodeDt.class, order=0, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="derivation | revision | quotation | source",
formalDefinition="How the entity was used during the activity"
)
private BoundCodeDt myRole;
@Child(name="type", type=CodingDt.class, order=1, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Resource Type, or something else",
formalDefinition="The type of the entity. If the entity is a resource, then this is a resource type"
)
private CodingDt myType;
@Child(name="reference", type=UriDt.class, order=2, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Identity of participant (urn or url)",
formalDefinition="Identity of participant. May be a logical or physical uri and maybe absolute or relative"
)
private UriDt myReference;
@Child(name="display", type=StringDt.class, order=3, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Human description of participant",
formalDefinition="Human-readable description of the entity"
)
private StringDt myDisplay;
@Child(name="agent", type=Agent.class, order=4, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Entity is attributed to this agent",
formalDefinition="The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity"
)
private Agent myAgent;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myRole, myType, myReference, myDisplay, myAgent);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myRole, myType, myReference, myDisplay, myAgent);
}
/**
* Gets the value(s) for role (derivation | revision | quotation | source).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* How the entity was used during the activity
*
*/
public BoundCodeDt getRole() {
if (myRole == null) {
myRole = new BoundCodeDt(ProvenanceEntityRoleEnum.VALUESET_BINDER);
}
return myRole;
}
/**
* Gets the value(s) for role (derivation | revision | quotation | source).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* How the entity was used during the activity
*
*/
public BoundCodeDt getRoleElement() {
if (myRole == null) {
myRole = new BoundCodeDt(ProvenanceEntityRoleEnum.VALUESET_BINDER);
}
return myRole;
}
/**
* Sets the value(s) for role (derivation | revision | quotation | source)
*
*
* Definition:
* How the entity was used during the activity
*
*/
public Entity setRole(BoundCodeDt theValue) {
myRole = theValue;
return this;
}
/**
* Sets the value(s) for role (derivation | revision | quotation | source)
*
*
* Definition:
* How the entity was used during the activity
*
*/
public Entity setRole(ProvenanceEntityRoleEnum theValue) {
getRole().setValueAsEnum(theValue);
return this;
}
/**
* Gets the value(s) for type (Resource Type, or something else).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The type of the entity. If the entity is a resource, then this is a resource type
*
*/
public CodingDt getType() {
if (myType == null) {
myType = new CodingDt();
}
return myType;
}
/**
* Gets the value(s) for type (Resource Type, or something else).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The type of the entity. If the entity is a resource, then this is a resource type
*
*/
public CodingDt getTypeElement() {
if (myType == null) {
myType = new CodingDt();
}
return myType;
}
/**
* Sets the value(s) for type (Resource Type, or something else)
*
*
* Definition:
* The type of the entity. If the entity is a resource, then this is a resource type
*
*/
public Entity setType(CodingDt theValue) {
myType = theValue;
return this;
}
/**
* Gets the value(s) for reference (Identity of participant (urn or url)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public UriDt getReference() {
if (myReference == null) {
myReference = new UriDt();
}
return myReference;
}
/**
* Gets the value(s) for reference (Identity of participant (urn or url)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public UriDt getReferenceElement() {
if (myReference == null) {
myReference = new UriDt();
}
return myReference;
}
/**
* Sets the value(s) for reference (Identity of participant (urn or url))
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public Entity setReference(UriDt theValue) {
myReference = theValue;
return this;
}
/**
* Sets the value for reference (Identity of participant (urn or url))
*
*
* Definition:
* Identity of participant. May be a logical or physical uri and maybe absolute or relative
*
*/
public Entity setReference( String theUri) {
myReference = new UriDt(theUri);
return this;
}
/**
* Gets the value(s) for display (Human description of participant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Human-readable description of the entity
*
*/
public StringDt getDisplay() {
if (myDisplay == null) {
myDisplay = new StringDt();
}
return myDisplay;
}
/**
* Gets the value(s) for display (Human description of participant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Human-readable description of the entity
*
*/
public StringDt getDisplayElement() {
if (myDisplay == null) {
myDisplay = new StringDt();
}
return myDisplay;
}
/**
* Sets the value(s) for display (Human description of participant)
*
*
* Definition:
* Human-readable description of the entity
*
*/
public Entity setDisplay(StringDt theValue) {
myDisplay = theValue;
return this;
}
/**
* Sets the value for display (Human description of participant)
*
*
* Definition:
* Human-readable description of the entity
*
*/
public Entity setDisplay( String theString) {
myDisplay = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for agent (Entity is attributed to this agent).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity
*
*/
public Agent getAgent() {
if (myAgent == null) {
myAgent = new Agent();
}
return myAgent;
}
/**
* Gets the value(s) for agent (Entity is attributed to this agent).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity
*
*/
public Agent getAgentElement() {
if (myAgent == null) {
myAgent = new Agent();
}
return myAgent;
}
/**
* Sets the value(s) for agent (Entity is attributed to this agent)
*
*
* Definition:
* The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity
*
*/
public Entity setAgent(Agent theValue) {
myAgent = theValue;
return this;
}
}
@Override
public String getResourceName() {
return "Provenance";
}
public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum() {
return ca.uhn.fhir.context.FhirVersionEnum.DSTU1;
}
}