
ca.uhn.fhir.model.dstu.resource.DocumentReference 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 DocumentReference Resource
* (A reference to a document)
*
*
* Definition:
* A reference to a document
*
*
*
* Requirements:
*
*
*
*
* Profile Definition:
* http://hl7.org/fhir/profiles/DocumentReference
*
*
*/
@ResourceDef(name="DocumentReference", profile="http://hl7.org/fhir/profiles/DocumentReference", id="documentreference")
public class DocumentReference extends ca.uhn.fhir.model.dstu.resource.BaseResource
implements IResource {
/**
* Search parameter constant for identifier
*
* Description:
* Type: token
* Path: DocumentReference.masterIdentifier | DocumentReference.identifier
*
*/
@SearchParamDefinition(name="identifier", path="DocumentReference.masterIdentifier | DocumentReference.identifier", description="", type="token" )
public static final String SP_IDENTIFIER = "identifier";
/**
* Fluent Client search parameter constant for identifier
*
* Description:
* Type: token
* Path: DocumentReference.masterIdentifier | DocumentReference.identifier
*
*/
public static final TokenClientParam IDENTIFIER = new TokenClientParam(SP_IDENTIFIER);
/**
* Search parameter constant for subject
*
* Description:
* Type: reference
* Path: DocumentReference.subject
*
*/
@SearchParamDefinition(name="subject", path="DocumentReference.subject", description="", type="reference" )
public static final String SP_SUBJECT = "subject";
/**
* Fluent Client search parameter constant for subject
*
* Description:
* Type: reference
* Path: DocumentReference.subject
*
*/
public static final ReferenceClientParam SUBJECT = new ReferenceClientParam(SP_SUBJECT);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "DocumentReference.subject".
*/
public static final Include INCLUDE_SUBJECT = new Include("DocumentReference.subject");
/**
* Search parameter constant for type
*
* Description:
* Type: token
* Path: DocumentReference.type
*
*/
@SearchParamDefinition(name="type", path="DocumentReference.type", description="", type="token" )
public static final String SP_TYPE = "type";
/**
* Fluent Client search parameter constant for type
*
* Description:
* Type: token
* Path: DocumentReference.type
*
*/
public static final TokenClientParam TYPE = new TokenClientParam(SP_TYPE);
/**
* Search parameter constant for class
*
* Description:
* Type: token
* Path: DocumentReference.class
*
*/
@SearchParamDefinition(name="class", path="DocumentReference.class", description="", type="token" )
public static final String SP_CLASS = "class";
/**
* Fluent Client search parameter constant for class
*
* Description:
* Type: token
* Path: DocumentReference.class
*
*/
public static final TokenClientParam CLASS = new TokenClientParam(SP_CLASS);
/**
* Search parameter constant for author
*
* Description:
* Type: reference
* Path: DocumentReference.author
*
*/
@SearchParamDefinition(name="author", path="DocumentReference.author", description="", type="reference" )
public static final String SP_AUTHOR = "author";
/**
* Fluent Client search parameter constant for author
*
* Description:
* Type: reference
* Path: DocumentReference.author
*
*/
public static final ReferenceClientParam AUTHOR = new ReferenceClientParam(SP_AUTHOR);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "DocumentReference.author".
*/
public static final Include INCLUDE_AUTHOR = new Include("DocumentReference.author");
/**
* Search parameter constant for custodian
*
* Description:
* Type: reference
* Path: DocumentReference.custodian
*
*/
@SearchParamDefinition(name="custodian", path="DocumentReference.custodian", description="", type="reference" )
public static final String SP_CUSTODIAN = "custodian";
/**
* Fluent Client search parameter constant for custodian
*
* Description:
* Type: reference
* Path: DocumentReference.custodian
*
*/
public static final ReferenceClientParam CUSTODIAN = new ReferenceClientParam(SP_CUSTODIAN);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "DocumentReference.custodian".
*/
public static final Include INCLUDE_CUSTODIAN = new Include("DocumentReference.custodian");
/**
* Search parameter constant for authenticator
*
* Description:
* Type: reference
* Path: DocumentReference.authenticator
*
*/
@SearchParamDefinition(name="authenticator", path="DocumentReference.authenticator", description="", type="reference" )
public static final String SP_AUTHENTICATOR = "authenticator";
/**
* Fluent Client search parameter constant for authenticator
*
* Description:
* Type: reference
* Path: DocumentReference.authenticator
*
*/
public static final ReferenceClientParam AUTHENTICATOR = new ReferenceClientParam(SP_AUTHENTICATOR);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "DocumentReference.authenticator".
*/
public static final Include INCLUDE_AUTHENTICATOR = new Include("DocumentReference.authenticator");
/**
* Search parameter constant for created
*
* Description:
* Type: date
* Path: DocumentReference.created
*
*/
@SearchParamDefinition(name="created", path="DocumentReference.created", description="", type="date" )
public static final String SP_CREATED = "created";
/**
* Fluent Client search parameter constant for created
*
* Description:
* Type: date
* Path: DocumentReference.created
*
*/
public static final DateClientParam CREATED = new DateClientParam(SP_CREATED);
/**
* Search parameter constant for indexed
*
* Description:
* Type: date
* Path: DocumentReference.indexed
*
*/
@SearchParamDefinition(name="indexed", path="DocumentReference.indexed", description="", type="date" )
public static final String SP_INDEXED = "indexed";
/**
* Fluent Client search parameter constant for indexed
*
* Description:
* Type: date
* Path: DocumentReference.indexed
*
*/
public static final DateClientParam INDEXED = new DateClientParam(SP_INDEXED);
/**
* Search parameter constant for status
*
* Description:
* Type: token
* Path: DocumentReference.status
*
*/
@SearchParamDefinition(name="status", path="DocumentReference.status", description="", type="token" )
public static final String SP_STATUS = "status";
/**
* Fluent Client search parameter constant for status
*
* Description:
* Type: token
* Path: DocumentReference.status
*
*/
public static final TokenClientParam STATUS = new TokenClientParam(SP_STATUS);
/**
* Search parameter constant for relatesto
*
* Description:
* Type: reference
* Path: DocumentReference.relatesTo.target
*
*/
@SearchParamDefinition(name="relatesto", path="DocumentReference.relatesTo.target", description="", type="reference" )
public static final String SP_RELATESTO = "relatesto";
/**
* Fluent Client search parameter constant for relatesto
*
* Description:
* Type: reference
* Path: DocumentReference.relatesTo.target
*
*/
public static final ReferenceClientParam RELATESTO = new ReferenceClientParam(SP_RELATESTO);
/**
* Constant for fluent queries to be used to add include statements. Specifies
* the path value of "DocumentReference.relatesTo.target".
*/
public static final Include INCLUDE_RELATESTO_TARGET = new Include("DocumentReference.relatesTo.target");
/**
* Search parameter constant for relation
*
* Description:
* Type: token
* Path: DocumentReference.relatesTo.code
*
*/
@SearchParamDefinition(name="relation", path="DocumentReference.relatesTo.code", description="", type="token" )
public static final String SP_RELATION = "relation";
/**
* Fluent Client search parameter constant for relation
*
* Description:
* Type: token
* Path: DocumentReference.relatesTo.code
*
*/
public static final TokenClientParam RELATION = new TokenClientParam(SP_RELATION);
/**
* Search parameter constant for description
*
* Description:
* Type: string
* Path: DocumentReference.description
*
*/
@SearchParamDefinition(name="description", path="DocumentReference.description", description="", type="string" )
public static final String SP_DESCRIPTION = "description";
/**
* Fluent Client search parameter constant for description
*
* Description:
* Type: string
* Path: DocumentReference.description
*
*/
public static final StringClientParam DESCRIPTION = new StringClientParam(SP_DESCRIPTION);
/**
* Search parameter constant for confidentiality
*
* Description:
* Type: token
* Path: DocumentReference.confidentiality
*
*/
@SearchParamDefinition(name="confidentiality", path="DocumentReference.confidentiality", description="", type="token" )
public static final String SP_CONFIDENTIALITY = "confidentiality";
/**
* Fluent Client search parameter constant for confidentiality
*
* Description:
* Type: token
* Path: DocumentReference.confidentiality
*
*/
public static final TokenClientParam CONFIDENTIALITY = new TokenClientParam(SP_CONFIDENTIALITY);
/**
* Search parameter constant for language
*
* Description:
* Type: token
* Path: DocumentReference.primaryLanguage
*
*/
@SearchParamDefinition(name="language", path="DocumentReference.primaryLanguage", description="", type="token" )
public static final String SP_LANGUAGE = "language";
/**
* Fluent Client search parameter constant for language
*
* Description:
* Type: token
* Path: DocumentReference.primaryLanguage
*
*/
public static final TokenClientParam LANGUAGE = new TokenClientParam(SP_LANGUAGE);
/**
* Search parameter constant for format
*
* Description:
* Type: token
* Path: DocumentReference.format
*
*/
@SearchParamDefinition(name="format", path="DocumentReference.format", description="", type="token" )
public static final String SP_FORMAT = "format";
/**
* Fluent Client search parameter constant for format
*
* Description:
* Type: token
* Path: DocumentReference.format
*
*/
public static final TokenClientParam FORMAT = new TokenClientParam(SP_FORMAT);
/**
* Search parameter constant for size
*
* Description:
* Type: number
* Path: DocumentReference.size
*
*/
@SearchParamDefinition(name="size", path="DocumentReference.size", description="", type="number" )
public static final String SP_SIZE = "size";
/**
* Fluent Client search parameter constant for size
*
* Description:
* Type: number
* Path: DocumentReference.size
*
*/
public static final NumberClientParam SIZE = new NumberClientParam(SP_SIZE);
/**
* Search parameter constant for location
*
* Description:
* Type: string
* Path: DocumentReference.location
*
*/
@SearchParamDefinition(name="location", path="DocumentReference.location", description="", type="string" )
public static final String SP_LOCATION = "location";
/**
* Fluent Client search parameter constant for location
*
* Description:
* Type: string
* Path: DocumentReference.location
*
*/
public static final StringClientParam LOCATION = new StringClientParam(SP_LOCATION);
/**
* Search parameter constant for event
*
* Description:
* Type: token
* Path: DocumentReference.context.event
*
*/
@SearchParamDefinition(name="event", path="DocumentReference.context.event", description="", type="token" )
public static final String SP_EVENT = "event";
/**
* Fluent Client search parameter constant for event
*
* Description:
* Type: token
* Path: DocumentReference.context.event
*
*/
public static final TokenClientParam EVENT = new TokenClientParam(SP_EVENT);
/**
* Search parameter constant for period
*
* Description:
* Type: date
* Path: DocumentReference.context.period
*
*/
@SearchParamDefinition(name="period", path="DocumentReference.context.period", description="", type="date" )
public static final String SP_PERIOD = "period";
/**
* Fluent Client search parameter constant for period
*
* Description:
* Type: date
* Path: DocumentReference.context.period
*
*/
public static final DateClientParam PERIOD = new DateClientParam(SP_PERIOD);
/**
* Search parameter constant for facility
*
* Description:
* Type: token
* Path: DocumentReference.context.facilityType
*
*/
@SearchParamDefinition(name="facility", path="DocumentReference.context.facilityType", description="", type="token" )
public static final String SP_FACILITY = "facility";
/**
* Fluent Client search parameter constant for facility
*
* Description:
* Type: token
* Path: DocumentReference.context.facilityType
*
*/
public static final TokenClientParam FACILITY = new TokenClientParam(SP_FACILITY);
/**
* Search parameter constant for relatesto-relation
*
* Description: Combination of relation and relatesTo
* Type: composite
* Path: relatesto & relation
*
*/
@SearchParamDefinition(name="relatesto-relation", path="relatesto & relation", description="Combination of relation and relatesTo", type="composite" , compositeOf={ "relatesto", "relation" } )
public static final String SP_RELATESTO_RELATION = "relatesto-relation";
/**
* Fluent Client search parameter constant for relatesto-relation
*
* Description: Combination of relation and relatesTo
* Type: composite
* Path: relatesto & relation
*
*/
public static final CompositeClientParam RELATESTO_RELATION = new CompositeClientParam(SP_RELATESTO_RELATION);
@Child(name="masterIdentifier", type=IdentifierDt.class, order=0, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Master Version Specific Identifier",
formalDefinition="Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document"
)
private IdentifierDt myMasterIdentifier;
@Child(name="identifier", type=IdentifierDt.class, order=1, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="Other identifiers for the document",
formalDefinition="Other identifiers associated with the document, including version independent, source record and workflow related identifiers"
)
private java.util.List myIdentifier;
@Child(name="subject", order=2, min=1, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.Patient.class, ca.uhn.fhir.model.dstu.resource.Practitioner.class, ca.uhn.fhir.model.dstu.resource.Group.class, ca.uhn.fhir.model.dstu.resource.Device.class })
@Description(
shortDefinition="Who|what is the subject of the document",
formalDefinition="Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)"
)
private ResourceReferenceDt mySubject;
@Child(name="type", type=CodeableConceptDt.class, order=3, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="What kind of document this is (LOINC if possible)",
formalDefinition="Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)"
)
private CodeableConceptDt myType;
@Child(name="class", type=CodeableConceptDt.class, order=4, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Categorization of Document",
formalDefinition="A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type"
)
private CodeableConceptDt myClassElement;
@Child(name="author", order=5, min=1, max=Child.MAX_UNLIMITED, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.Practitioner.class, ca.uhn.fhir.model.dstu.resource.Device.class, ca.uhn.fhir.model.dstu.resource.Patient.class, ca.uhn.fhir.model.dstu.resource.RelatedPerson.class })
@Description(
shortDefinition="Who and/or what authored the document",
formalDefinition="Identifies who is responsible for adding the information to the document"
)
private java.util.List myAuthor;
@Child(name="custodian", order=6, min=0, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.Organization.class })
@Description(
shortDefinition="Org which maintains the document",
formalDefinition="Identifies the organization or group who is responsible for ongoing maintenance of and access to the document"
)
private ResourceReferenceDt myCustodian;
@Child(name="policyManager", type=UriDt.class, order=7, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Manages access policies for the document",
formalDefinition="A reference to a domain or server that manages policies under which the document is accessed and/or made available"
)
private UriDt myPolicyManager;
@Child(name="authenticator", order=8, min=0, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.Practitioner.class, ca.uhn.fhir.model.dstu.resource.Organization.class })
@Description(
shortDefinition="Who/What authenticated the document",
formalDefinition="Which person or organization authenticates that this document is valid"
)
private ResourceReferenceDt myAuthenticator;
@Child(name="created", type=DateTimeDt.class, order=9, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Document creation time",
formalDefinition="When the document was created"
)
private DateTimeDt myCreated;
@Child(name="indexed", type=InstantDt.class, order=10, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="When this document reference created",
formalDefinition="When the document reference was created"
)
private InstantDt myIndexed;
@Child(name="status", type=CodeDt.class, order=11, min=1, max=1, summary=false, modifier=true)
@Description(
shortDefinition="current | superceded | entered in error",
formalDefinition="The status of this document reference"
)
private BoundCodeDt myStatus;
@Child(name="docStatus", type=CodeableConceptDt.class, order=12, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="preliminary | final | appended | amended | entered in error",
formalDefinition="The status of the underlying document"
)
private CodeableConceptDt myDocStatus;
@Child(name="relatesTo", order=13, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=true)
@Description(
shortDefinition="Relationships to other documents",
formalDefinition="Relationships that this document has with other document references that already exist"
)
private java.util.List myRelatesTo;
@Child(name="description", type=StringDt.class, order=14, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Human-readable description (title)",
formalDefinition="Human-readable description of the source document. This is sometimes known as the \"title\""
)
private StringDt myDescription;
@Child(name="confidentiality", type=CodeableConceptDt.class, order=15, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=true)
@Description(
shortDefinition="Sensitivity of source document",
formalDefinition="A code specifying the level of confidentiality of the XDS Document"
)
private java.util.List myConfidentiality;
@Child(name="primaryLanguage", type=CodeDt.class, order=16, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="The marked primary language for the document",
formalDefinition="The primary language in which the source document is written"
)
private CodeDt myPrimaryLanguage;
@Child(name="mimeType", type=CodeDt.class, order=17, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Mime type, + maybe character encoding",
formalDefinition="The mime type of the source document"
)
private CodeDt myMimeType;
@Child(name="format", type=UriDt.class, order=18, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="Format/content rules for the document",
formalDefinition="An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType"
)
private java.util.List myFormat;
@Child(name="size", type=IntegerDt.class, order=19, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Size of the document in bytes",
formalDefinition="The size of the source document this reference refers to in bytes"
)
private IntegerDt mySize;
@Child(name="hash", type=StringDt.class, order=20, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="HexBinary representation of SHA1",
formalDefinition="A hash of the source document to ensure that changes have not occurred"
)
private StringDt myHash;
@Child(name="location", type=UriDt.class, order=21, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Where to access the document",
formalDefinition="A url at which the document can be accessed"
)
private UriDt myLocation;
@Child(name="service", order=22, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="If access is not fully described by location",
formalDefinition="A description of a service call that can be used to retrieve the document"
)
private Service myService;
@Child(name="context", order=23, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Clinical context of document",
formalDefinition="The clinical context in which the document was prepared"
)
private Context myContext;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myMasterIdentifier, myIdentifier, mySubject, myType, myClassElement, myAuthor, myCustodian, myPolicyManager, myAuthenticator, myCreated, myIndexed, myStatus, myDocStatus, myRelatesTo, myDescription, myConfidentiality, myPrimaryLanguage, myMimeType, myFormat, mySize, myHash, myLocation, myService, myContext);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myMasterIdentifier, myIdentifier, mySubject, myType, myClassElement, myAuthor, myCustodian, myPolicyManager, myAuthenticator, myCreated, myIndexed, myStatus, myDocStatus, myRelatesTo, myDescription, myConfidentiality, myPrimaryLanguage, myMimeType, myFormat, mySize, myHash, myLocation, myService, myContext);
}
/**
* Gets the value(s) for masterIdentifier (Master Version Specific Identifier).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
*
*/
public IdentifierDt getMasterIdentifier() {
if (myMasterIdentifier == null) {
myMasterIdentifier = new IdentifierDt();
}
return myMasterIdentifier;
}
/**
* Gets the value(s) for masterIdentifier (Master Version Specific Identifier).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
*
*/
public IdentifierDt getMasterIdentifierElement() {
if (myMasterIdentifier == null) {
myMasterIdentifier = new IdentifierDt();
}
return myMasterIdentifier;
}
/**
* Sets the value(s) for masterIdentifier (Master Version Specific Identifier)
*
*
* Definition:
* Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
*
*/
public DocumentReference setMasterIdentifier(IdentifierDt theValue) {
myMasterIdentifier = theValue;
return this;
}
/**
* Sets the value for masterIdentifier (Master Version Specific Identifier)
*
*
* Definition:
* Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
*
*/
public DocumentReference setMasterIdentifier( IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) {
myMasterIdentifier = new IdentifierDt(theUse, theSystem, theValue, theLabel);
return this;
}
/**
* Sets the value for masterIdentifier (Master Version Specific Identifier)
*
*
* Definition:
* Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document
*
*/
public DocumentReference setMasterIdentifier( String theSystem, String theValue) {
myMasterIdentifier = new IdentifierDt(theSystem, theValue);
return this;
}
/**
* Gets the value(s) for identifier (Other identifiers for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*/
public java.util.List getIdentifier() {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList();
}
return myIdentifier;
}
/**
* Gets the value(s) for identifier (Other identifiers for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*/
public java.util.List getIdentifierElement() {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList();
}
return myIdentifier;
}
/**
* Sets the value(s) for identifier (Other identifiers for the document)
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*/
public DocumentReference setIdentifier(java.util.List theValue) {
myIdentifier = theValue;
return this;
}
/**
* Adds and returns a new value for identifier (Other identifiers for the document)
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*/
public IdentifierDt addIdentifier() {
IdentifierDt newType = new IdentifierDt();
getIdentifier().add(newType);
return newType;
}
/**
* Gets the first repetition for identifier (Other identifiers for the document),
* creating it if it does not already exist.
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*/
public IdentifierDt getIdentifierFirstRep() {
if (getIdentifier().isEmpty()) {
return addIdentifier();
}
return getIdentifier().get(0);
}
/**
* Adds a new value for identifier (Other identifiers for the document)
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*
* @return Returns a reference to this object, to allow for simple chaining.
*/
public DocumentReference addIdentifier( IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel) {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList();
}
myIdentifier.add(new IdentifierDt(theUse, theSystem, theValue, theLabel));
return this;
}
/**
* Adds a new value for identifier (Other identifiers for the document)
*
*
* Definition:
* Other identifiers associated with the document, including version independent, source record and workflow related identifiers
*
*
* @return Returns a reference to this object, to allow for simple chaining.
*/
public DocumentReference addIdentifier( String theSystem, String theValue) {
if (myIdentifier == null) {
myIdentifier = new java.util.ArrayList();
}
myIdentifier.add(new IdentifierDt(theSystem, theValue));
return this;
}
/**
* Gets the value(s) for subject (Who|what is the subject of the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)
*
*/
public ResourceReferenceDt getSubject() {
if (mySubject == null) {
mySubject = new ResourceReferenceDt();
}
return mySubject;
}
/**
* Gets the value(s) for subject (Who|what is the subject of the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)
*
*/
public ResourceReferenceDt getSubjectElement() {
if (mySubject == null) {
mySubject = new ResourceReferenceDt();
}
return mySubject;
}
/**
* Sets the value(s) for subject (Who|what is the subject of the document)
*
*
* Definition:
* Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (I.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure)
*
*/
public DocumentReference setSubject(ResourceReferenceDt theValue) {
mySubject = theValue;
return this;
}
/**
* Gets the value(s) for type (What kind of document this is (LOINC if possible)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)
*
*/
public CodeableConceptDt getType() {
if (myType == null) {
myType = new CodeableConceptDt();
}
return myType;
}
/**
* Gets the value(s) for type (What kind of document this is (LOINC if possible)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)
*
*/
public CodeableConceptDt getTypeElement() {
if (myType == null) {
myType = new CodeableConceptDt();
}
return myType;
}
/**
* Sets the value(s) for type (What kind of document this is (LOINC if possible))
*
*
* Definition:
* Specifies the particular kind of document (e.g. Patient Summary, Discharge Summary, Prescription, etc.)
*
*/
public DocumentReference setType(CodeableConceptDt theValue) {
myType = theValue;
return this;
}
/**
* Gets the value(s) for class (Categorization of Document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type
*
*/
public CodeableConceptDt getClassElement() {
if (myClassElement == null) {
myClassElement = new CodeableConceptDt();
}
return myClassElement;
}
/**
* Gets the value(s) for class (Categorization of Document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type
*
*/
public CodeableConceptDt getClassElementElement() {
if (myClassElement == null) {
myClassElement = new CodeableConceptDt();
}
return myClassElement;
}
/**
* Sets the value(s) for class (Categorization of Document)
*
*
* Definition:
* A categorization for the type of the document. This may be implied by or derived from the code specified in the Document Type
*
*/
public DocumentReference setClassElement(CodeableConceptDt theValue) {
myClassElement = theValue;
return this;
}
/**
* Gets the value(s) for author (Who and/or what authored the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Identifies who is responsible for adding the information to the document
*
*/
public java.util.List getAuthor() {
if (myAuthor == null) {
myAuthor = new java.util.ArrayList();
}
return myAuthor;
}
/**
* Gets the value(s) for author (Who and/or what authored the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Identifies who is responsible for adding the information to the document
*
*/
public java.util.List getAuthorElement() {
if (myAuthor == null) {
myAuthor = new java.util.ArrayList();
}
return myAuthor;
}
/**
* Sets the value(s) for author (Who and/or what authored the document)
*
*
* Definition:
* Identifies who is responsible for adding the information to the document
*
*/
public DocumentReference setAuthor(java.util.List theValue) {
myAuthor = theValue;
return this;
}
/**
* Adds and returns a new value for author (Who and/or what authored the document)
*
*
* Definition:
* Identifies who is responsible for adding the information to the document
*
*/
public ResourceReferenceDt addAuthor() {
ResourceReferenceDt newType = new ResourceReferenceDt();
getAuthor().add(newType);
return newType;
}
/**
* Gets the value(s) for custodian (Org which maintains the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
*
*/
public ResourceReferenceDt getCustodian() {
if (myCustodian == null) {
myCustodian = new ResourceReferenceDt();
}
return myCustodian;
}
/**
* Gets the value(s) for custodian (Org which maintains the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
*
*/
public ResourceReferenceDt getCustodianElement() {
if (myCustodian == null) {
myCustodian = new ResourceReferenceDt();
}
return myCustodian;
}
/**
* Sets the value(s) for custodian (Org which maintains the document)
*
*
* Definition:
* Identifies the organization or group who is responsible for ongoing maintenance of and access to the document
*
*/
public DocumentReference setCustodian(ResourceReferenceDt theValue) {
myCustodian = theValue;
return this;
}
/**
* Gets the value(s) for policyManager (Manages access policies for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A reference to a domain or server that manages policies under which the document is accessed and/or made available
*
*/
public UriDt getPolicyManager() {
if (myPolicyManager == null) {
myPolicyManager = new UriDt();
}
return myPolicyManager;
}
/**
* Gets the value(s) for policyManager (Manages access policies for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A reference to a domain or server that manages policies under which the document is accessed and/or made available
*
*/
public UriDt getPolicyManagerElement() {
if (myPolicyManager == null) {
myPolicyManager = new UriDt();
}
return myPolicyManager;
}
/**
* Sets the value(s) for policyManager (Manages access policies for the document)
*
*
* Definition:
* A reference to a domain or server that manages policies under which the document is accessed and/or made available
*
*/
public DocumentReference setPolicyManager(UriDt theValue) {
myPolicyManager = theValue;
return this;
}
/**
* Sets the value for policyManager (Manages access policies for the document)
*
*
* Definition:
* A reference to a domain or server that manages policies under which the document is accessed and/or made available
*
*/
public DocumentReference setPolicyManager( String theUri) {
myPolicyManager = new UriDt(theUri);
return this;
}
/**
* Gets the value(s) for authenticator (Who/What authenticated the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Which person or organization authenticates that this document is valid
*
*/
public ResourceReferenceDt getAuthenticator() {
if (myAuthenticator == null) {
myAuthenticator = new ResourceReferenceDt();
}
return myAuthenticator;
}
/**
* Gets the value(s) for authenticator (Who/What authenticated the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Which person or organization authenticates that this document is valid
*
*/
public ResourceReferenceDt getAuthenticatorElement() {
if (myAuthenticator == null) {
myAuthenticator = new ResourceReferenceDt();
}
return myAuthenticator;
}
/**
* Sets the value(s) for authenticator (Who/What authenticated the document)
*
*
* Definition:
* Which person or organization authenticates that this document is valid
*
*/
public DocumentReference setAuthenticator(ResourceReferenceDt theValue) {
myAuthenticator = theValue;
return this;
}
/**
* Gets the value(s) for created (Document creation time).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* When the document was created
*
*/
public DateTimeDt getCreated() {
if (myCreated == null) {
myCreated = new DateTimeDt();
}
return myCreated;
}
/**
* Gets the value(s) for created (Document creation time).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* When the document was created
*
*/
public DateTimeDt getCreatedElement() {
if (myCreated == null) {
myCreated = new DateTimeDt();
}
return myCreated;
}
/**
* Sets the value(s) for created (Document creation time)
*
*
* Definition:
* When the document was created
*
*/
public DocumentReference setCreated(DateTimeDt theValue) {
myCreated = theValue;
return this;
}
/**
* Sets the value for created (Document creation time)
*
*
* Definition:
* When the document was created
*
*/
public DocumentReference setCreated( Date theDate, TemporalPrecisionEnum thePrecision) {
myCreated = new DateTimeDt(theDate, thePrecision);
return this;
}
/**
* Sets the value for created (Document creation time)
*
*
* Definition:
* When the document was created
*
*/
public DocumentReference setCreatedWithSecondsPrecision( Date theDate) {
myCreated = new DateTimeDt(theDate);
return this;
}
/**
* Gets the value(s) for indexed (When this document reference created).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* When the document reference was created
*
*/
public InstantDt getIndexed() {
if (myIndexed == null) {
myIndexed = new InstantDt();
}
return myIndexed;
}
/**
* Gets the value(s) for indexed (When this document reference created).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* When the document reference was created
*
*/
public InstantDt getIndexedElement() {
if (myIndexed == null) {
myIndexed = new InstantDt();
}
return myIndexed;
}
/**
* Sets the value(s) for indexed (When this document reference created)
*
*
* Definition:
* When the document reference was created
*
*/
public DocumentReference setIndexed(InstantDt theValue) {
myIndexed = theValue;
return this;
}
/**
* Sets the value for indexed (When this document reference created)
*
*
* Definition:
* When the document reference was created
*
*/
public DocumentReference setIndexedWithMillisPrecision( Date theDate) {
myIndexed = new InstantDt(theDate);
return this;
}
/**
* Sets the value for indexed (When this document reference created)
*
*
* Definition:
* When the document reference was created
*
*/
public DocumentReference setIndexed( Date theDate, TemporalPrecisionEnum thePrecision) {
myIndexed = new InstantDt(theDate, thePrecision);
return this;
}
/**
* Gets the value(s) for status (current | superceded | entered in error).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The status of this document reference
*
*/
public BoundCodeDt getStatus() {
if (myStatus == null) {
myStatus = new BoundCodeDt(DocumentReferenceStatusEnum.VALUESET_BINDER);
}
return myStatus;
}
/**
* Gets the value(s) for status (current | superceded | entered in error).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The status of this document reference
*
*/
public BoundCodeDt getStatusElement() {
if (myStatus == null) {
myStatus = new BoundCodeDt(DocumentReferenceStatusEnum.VALUESET_BINDER);
}
return myStatus;
}
/**
* Sets the value(s) for status (current | superceded | entered in error)
*
*
* Definition:
* The status of this document reference
*
*/
public DocumentReference setStatus(BoundCodeDt theValue) {
myStatus = theValue;
return this;
}
/**
* Sets the value(s) for status (current | superceded | entered in error)
*
*
* Definition:
* The status of this document reference
*
*/
public DocumentReference setStatus(DocumentReferenceStatusEnum theValue) {
getStatus().setValueAsEnum(theValue);
return this;
}
/**
* Gets the value(s) for docStatus (preliminary | final | appended | amended | entered in error).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The status of the underlying document
*
*/
public CodeableConceptDt getDocStatus() {
if (myDocStatus == null) {
myDocStatus = new CodeableConceptDt();
}
return myDocStatus;
}
/**
* Gets the value(s) for docStatus (preliminary | final | appended | amended | entered in error).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The status of the underlying document
*
*/
public CodeableConceptDt getDocStatusElement() {
if (myDocStatus == null) {
myDocStatus = new CodeableConceptDt();
}
return myDocStatus;
}
/**
* Sets the value(s) for docStatus (preliminary | final | appended | amended | entered in error)
*
*
* Definition:
* The status of the underlying document
*
*/
public DocumentReference setDocStatus(CodeableConceptDt theValue) {
myDocStatus = theValue;
return this;
}
/**
* Gets the value(s) for relatesTo (Relationships to other documents).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Relationships that this document has with other document references that already exist
*
*/
public java.util.List getRelatesTo() {
if (myRelatesTo == null) {
myRelatesTo = new java.util.ArrayList();
}
return myRelatesTo;
}
/**
* Gets the value(s) for relatesTo (Relationships to other documents).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Relationships that this document has with other document references that already exist
*
*/
public java.util.List getRelatesToElement() {
if (myRelatesTo == null) {
myRelatesTo = new java.util.ArrayList();
}
return myRelatesTo;
}
/**
* Sets the value(s) for relatesTo (Relationships to other documents)
*
*
* Definition:
* Relationships that this document has with other document references that already exist
*
*/
public DocumentReference setRelatesTo(java.util.List theValue) {
myRelatesTo = theValue;
return this;
}
/**
* Adds and returns a new value for relatesTo (Relationships to other documents)
*
*
* Definition:
* Relationships that this document has with other document references that already exist
*
*/
public RelatesTo addRelatesTo() {
RelatesTo newType = new RelatesTo();
getRelatesTo().add(newType);
return newType;
}
/**
* Gets the first repetition for relatesTo (Relationships to other documents),
* creating it if it does not already exist.
*
*
* Definition:
* Relationships that this document has with other document references that already exist
*
*/
public RelatesTo getRelatesToFirstRep() {
if (getRelatesTo().isEmpty()) {
return addRelatesTo();
}
return getRelatesTo().get(0);
}
/**
* Gets the value(s) for description (Human-readable description (title)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Human-readable description of the source document. This is sometimes known as the \"title\"
*
*/
public StringDt getDescription() {
if (myDescription == null) {
myDescription = new StringDt();
}
return myDescription;
}
/**
* Gets the value(s) for description (Human-readable description (title)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Human-readable description of the source document. This is sometimes known as the \"title\"
*
*/
public StringDt getDescriptionElement() {
if (myDescription == null) {
myDescription = new StringDt();
}
return myDescription;
}
/**
* Sets the value(s) for description (Human-readable description (title))
*
*
* Definition:
* Human-readable description of the source document. This is sometimes known as the \"title\"
*
*/
public DocumentReference setDescription(StringDt theValue) {
myDescription = theValue;
return this;
}
/**
* Sets the value for description (Human-readable description (title))
*
*
* Definition:
* Human-readable description of the source document. This is sometimes known as the \"title\"
*
*/
public DocumentReference setDescription( String theString) {
myDescription = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for confidentiality (Sensitivity of source document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A code specifying the level of confidentiality of the XDS Document
*
*/
public java.util.List getConfidentiality() {
if (myConfidentiality == null) {
myConfidentiality = new java.util.ArrayList();
}
return myConfidentiality;
}
/**
* Gets the value(s) for confidentiality (Sensitivity of source document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A code specifying the level of confidentiality of the XDS Document
*
*/
public java.util.List getConfidentialityElement() {
if (myConfidentiality == null) {
myConfidentiality = new java.util.ArrayList();
}
return myConfidentiality;
}
/**
* Sets the value(s) for confidentiality (Sensitivity of source document)
*
*
* Definition:
* A code specifying the level of confidentiality of the XDS Document
*
*/
public DocumentReference setConfidentiality(java.util.List theValue) {
myConfidentiality = theValue;
return this;
}
/**
* Adds and returns a new value for confidentiality (Sensitivity of source document)
*
*
* Definition:
* A code specifying the level of confidentiality of the XDS Document
*
*/
public CodeableConceptDt addConfidentiality() {
CodeableConceptDt newType = new CodeableConceptDt();
getConfidentiality().add(newType);
return newType;
}
/**
* Gets the first repetition for confidentiality (Sensitivity of source document),
* creating it if it does not already exist.
*
*
* Definition:
* A code specifying the level of confidentiality of the XDS Document
*
*/
public CodeableConceptDt getConfidentialityFirstRep() {
if (getConfidentiality().isEmpty()) {
return addConfidentiality();
}
return getConfidentiality().get(0);
}
/**
* Gets the value(s) for primaryLanguage (The marked primary language for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The primary language in which the source document is written
*
*/
public CodeDt getPrimaryLanguage() {
if (myPrimaryLanguage == null) {
myPrimaryLanguage = new CodeDt();
}
return myPrimaryLanguage;
}
/**
* Gets the value(s) for primaryLanguage (The marked primary language for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The primary language in which the source document is written
*
*/
public CodeDt getPrimaryLanguageElement() {
if (myPrimaryLanguage == null) {
myPrimaryLanguage = new CodeDt();
}
return myPrimaryLanguage;
}
/**
* Sets the value(s) for primaryLanguage (The marked primary language for the document)
*
*
* Definition:
* The primary language in which the source document is written
*
*/
public DocumentReference setPrimaryLanguage(CodeDt theValue) {
myPrimaryLanguage = theValue;
return this;
}
/**
* Sets the value for primaryLanguage (The marked primary language for the document)
*
*
* Definition:
* The primary language in which the source document is written
*
*/
public DocumentReference setPrimaryLanguage( String theCode) {
myPrimaryLanguage = new CodeDt(theCode);
return this;
}
/**
* Gets the value(s) for mimeType (Mime type, + maybe character encoding).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The mime type of the source document
*
*/
public CodeDt getMimeType() {
if (myMimeType == null) {
myMimeType = new CodeDt();
}
return myMimeType;
}
/**
* Gets the value(s) for mimeType (Mime type, + maybe character encoding).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The mime type of the source document
*
*/
public CodeDt getMimeTypeElement() {
if (myMimeType == null) {
myMimeType = new CodeDt();
}
return myMimeType;
}
/**
* Sets the value(s) for mimeType (Mime type, + maybe character encoding)
*
*
* Definition:
* The mime type of the source document
*
*/
public DocumentReference setMimeType(CodeDt theValue) {
myMimeType = theValue;
return this;
}
/**
* Sets the value for mimeType (Mime type, + maybe character encoding)
*
*
* Definition:
* The mime type of the source document
*
*/
public DocumentReference setMimeType( String theCode) {
myMimeType = new CodeDt(theCode);
return this;
}
/**
* Gets the value(s) for format (Format/content rules for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
*
*/
public java.util.List getFormat() {
if (myFormat == null) {
myFormat = new java.util.ArrayList();
}
return myFormat;
}
/**
* Gets the value(s) for format (Format/content rules for the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
*
*/
public java.util.List getFormatElement() {
if (myFormat == null) {
myFormat = new java.util.ArrayList();
}
return myFormat;
}
/**
* Sets the value(s) for format (Format/content rules for the document)
*
*
* Definition:
* An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
*
*/
public DocumentReference setFormat(java.util.List theValue) {
myFormat = theValue;
return this;
}
/**
* Adds and returns a new value for format (Format/content rules for the document)
*
*
* Definition:
* An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
*
*/
public UriDt addFormat() {
UriDt newType = new UriDt();
getFormat().add(newType);
return newType;
}
/**
* Gets the first repetition for format (Format/content rules for the document),
* creating it if it does not already exist.
*
*
* Definition:
* An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
*
*/
public UriDt getFormatFirstRep() {
if (getFormat().isEmpty()) {
return addFormat();
}
return getFormat().get(0);
}
/**
* Adds a new value for format (Format/content rules for the document)
*
*
* Definition:
* An identifier that identifies that the format and content of the document conforms to additional rules beyond the base format indicated in the mimeType
*
*
* @return Returns a reference to this object, to allow for simple chaining.
*/
public DocumentReference addFormat( String theUri) {
if (myFormat == null) {
myFormat = new java.util.ArrayList();
}
myFormat.add(new UriDt(theUri));
return this;
}
/**
* Gets the value(s) for size (Size of the document in bytes).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The size of the source document this reference refers to in bytes
*
*/
public IntegerDt getSize() {
if (mySize == null) {
mySize = new IntegerDt();
}
return mySize;
}
/**
* Gets the value(s) for size (Size of the document in bytes).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The size of the source document this reference refers to in bytes
*
*/
public IntegerDt getSizeElement() {
if (mySize == null) {
mySize = new IntegerDt();
}
return mySize;
}
/**
* Sets the value(s) for size (Size of the document in bytes)
*
*
* Definition:
* The size of the source document this reference refers to in bytes
*
*/
public DocumentReference setSize(IntegerDt theValue) {
mySize = theValue;
return this;
}
/**
* Sets the value for size (Size of the document in bytes)
*
*
* Definition:
* The size of the source document this reference refers to in bytes
*
*/
public DocumentReference setSize( int theInteger) {
mySize = new IntegerDt(theInteger);
return this;
}
/**
* Gets the value(s) for hash (HexBinary representation of SHA1).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A hash of the source document to ensure that changes have not occurred
*
*/
public StringDt getHash() {
if (myHash == null) {
myHash = new StringDt();
}
return myHash;
}
/**
* Gets the value(s) for hash (HexBinary representation of SHA1).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A hash of the source document to ensure that changes have not occurred
*
*/
public StringDt getHashElement() {
if (myHash == null) {
myHash = new StringDt();
}
return myHash;
}
/**
* Sets the value(s) for hash (HexBinary representation of SHA1)
*
*
* Definition:
* A hash of the source document to ensure that changes have not occurred
*
*/
public DocumentReference setHash(StringDt theValue) {
myHash = theValue;
return this;
}
/**
* Sets the value for hash (HexBinary representation of SHA1)
*
*
* Definition:
* A hash of the source document to ensure that changes have not occurred
*
*/
public DocumentReference setHash( String theString) {
myHash = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for location (Where to access the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A url at which the document can be accessed
*
*/
public UriDt getLocation() {
if (myLocation == null) {
myLocation = new UriDt();
}
return myLocation;
}
/**
* Gets the value(s) for location (Where to access the document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A url at which the document can be accessed
*
*/
public UriDt getLocationElement() {
if (myLocation == null) {
myLocation = new UriDt();
}
return myLocation;
}
/**
* Sets the value(s) for location (Where to access the document)
*
*
* Definition:
* A url at which the document can be accessed
*
*/
public DocumentReference setLocation(UriDt theValue) {
myLocation = theValue;
return this;
}
/**
* Sets the value for location (Where to access the document)
*
*
* Definition:
* A url at which the document can be accessed
*
*/
public DocumentReference setLocation( String theUri) {
myLocation = new UriDt(theUri);
return this;
}
/**
* Gets the value(s) for service (If access is not fully described by location).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A description of a service call that can be used to retrieve the document
*
*/
public Service getService() {
if (myService == null) {
myService = new Service();
}
return myService;
}
/**
* Gets the value(s) for service (If access is not fully described by location).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A description of a service call that can be used to retrieve the document
*
*/
public Service getServiceElement() {
if (myService == null) {
myService = new Service();
}
return myService;
}
/**
* Sets the value(s) for service (If access is not fully described by location)
*
*
* Definition:
* A description of a service call that can be used to retrieve the document
*
*/
public DocumentReference setService(Service theValue) {
myService = theValue;
return this;
}
/**
* Gets the value(s) for context (Clinical context of document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The clinical context in which the document was prepared
*
*/
public Context getContext() {
if (myContext == null) {
myContext = new Context();
}
return myContext;
}
/**
* Gets the value(s) for context (Clinical context of document).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The clinical context in which the document was prepared
*
*/
public Context getContextElement() {
if (myContext == null) {
myContext = new Context();
}
return myContext;
}
/**
* Sets the value(s) for context (Clinical context of document)
*
*
* Definition:
* The clinical context in which the document was prepared
*
*/
public DocumentReference setContext(Context theValue) {
myContext = theValue;
return this;
}
/**
* Block class for child element: DocumentReference.relatesTo (Relationships to other documents)
*
*
* Definition:
* Relationships that this document has with other document references that already exist
*
*/
@Block()
public static class RelatesTo
extends BaseIdentifiableElement implements IResourceBlock {
@Child(name="code", type=CodeDt.class, order=0, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="replaces | transforms | signs | appends",
formalDefinition="The type of relationship that this document has with anther document"
)
private BoundCodeDt myCode;
@Child(name="target", order=1, min=1, max=1, summary=false, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.DocumentReference.class })
@Description(
shortDefinition="Target of the relationship",
formalDefinition="The target document of this relationship"
)
private ResourceReferenceDt myTarget;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myCode, myTarget);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myCode, myTarget);
}
/**
* Gets the value(s) for code (replaces | transforms | signs | appends).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The type of relationship that this document has with anther document
*
*/
public BoundCodeDt getCode() {
if (myCode == null) {
myCode = new BoundCodeDt(DocumentRelationshipTypeEnum.VALUESET_BINDER);
}
return myCode;
}
/**
* Gets the value(s) for code (replaces | transforms | signs | appends).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The type of relationship that this document has with anther document
*
*/
public BoundCodeDt getCodeElement() {
if (myCode == null) {
myCode = new BoundCodeDt(DocumentRelationshipTypeEnum.VALUESET_BINDER);
}
return myCode;
}
/**
* Sets the value(s) for code (replaces | transforms | signs | appends)
*
*
* Definition:
* The type of relationship that this document has with anther document
*
*/
public RelatesTo setCode(BoundCodeDt theValue) {
myCode = theValue;
return this;
}
/**
* Sets the value(s) for code (replaces | transforms | signs | appends)
*
*
* Definition:
* The type of relationship that this document has with anther document
*
*/
public RelatesTo setCode(DocumentRelationshipTypeEnum theValue) {
getCode().setValueAsEnum(theValue);
return this;
}
/**
* Gets the value(s) for target (Target of the relationship).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The target document of this relationship
*
*/
public ResourceReferenceDt getTarget() {
if (myTarget == null) {
myTarget = new ResourceReferenceDt();
}
return myTarget;
}
/**
* Gets the value(s) for target (Target of the relationship).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The target document of this relationship
*
*/
public ResourceReferenceDt getTargetElement() {
if (myTarget == null) {
myTarget = new ResourceReferenceDt();
}
return myTarget;
}
/**
* Sets the value(s) for target (Target of the relationship)
*
*
* Definition:
* The target document of this relationship
*
*/
public RelatesTo setTarget(ResourceReferenceDt theValue) {
myTarget = theValue;
return this;
}
}
/**
* Block class for child element: DocumentReference.service (If access is not fully described by location)
*
*
* Definition:
* A description of a service call that can be used to retrieve the document
*
*/
@Block()
public static class Service
extends BaseIdentifiableElement implements IResourceBlock {
@Child(name="type", type=CodeableConceptDt.class, order=0, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Type of service (i.e. XDS.b)",
formalDefinition="The type of the service that can be used to access the documents"
)
private CodeableConceptDt myType;
@Child(name="address", type=StringDt.class, order=1, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Where service is located (usually a URL)",
formalDefinition="Where the service end-point is located"
)
private StringDt myAddress;
@Child(name="parameter", order=2, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="Service call parameters",
formalDefinition="A list of named parameters that is used in the service call"
)
private java.util.List myParameter;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myType, myAddress, myParameter);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myType, myAddress, myParameter);
}
/**
* Gets the value(s) for type (Type of service (i.e. XDS.b)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The type of the service that can be used to access the documents
*
*/
public CodeableConceptDt getType() {
if (myType == null) {
myType = new CodeableConceptDt();
}
return myType;
}
/**
* Gets the value(s) for type (Type of service (i.e. XDS.b)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The type of the service that can be used to access the documents
*
*/
public CodeableConceptDt getTypeElement() {
if (myType == null) {
myType = new CodeableConceptDt();
}
return myType;
}
/**
* Sets the value(s) for type (Type of service (i.e. XDS.b))
*
*
* Definition:
* The type of the service that can be used to access the documents
*
*/
public Service setType(CodeableConceptDt theValue) {
myType = theValue;
return this;
}
/**
* Gets the value(s) for address (Where service is located (usually a URL)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Where the service end-point is located
*
*/
public StringDt getAddress() {
if (myAddress == null) {
myAddress = new StringDt();
}
return myAddress;
}
/**
* Gets the value(s) for address (Where service is located (usually a URL)).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* Where the service end-point is located
*
*/
public StringDt getAddressElement() {
if (myAddress == null) {
myAddress = new StringDt();
}
return myAddress;
}
/**
* Sets the value(s) for address (Where service is located (usually a URL))
*
*
* Definition:
* Where the service end-point is located
*
*/
public Service setAddress(StringDt theValue) {
myAddress = theValue;
return this;
}
/**
* Sets the value for address (Where service is located (usually a URL))
*
*
* Definition:
* Where the service end-point is located
*
*/
public Service setAddress( String theString) {
myAddress = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for parameter (Service call parameters).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A list of named parameters that is used in the service call
*
*/
public java.util.List getParameter() {
if (myParameter == null) {
myParameter = new java.util.ArrayList();
}
return myParameter;
}
/**
* Gets the value(s) for parameter (Service call parameters).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* A list of named parameters that is used in the service call
*
*/
public java.util.List getParameterElement() {
if (myParameter == null) {
myParameter = new java.util.ArrayList();
}
return myParameter;
}
/**
* Sets the value(s) for parameter (Service call parameters)
*
*
* Definition:
* A list of named parameters that is used in the service call
*
*/
public Service setParameter(java.util.List theValue) {
myParameter = theValue;
return this;
}
/**
* Adds and returns a new value for parameter (Service call parameters)
*
*
* Definition:
* A list of named parameters that is used in the service call
*
*/
public ServiceParameter addParameter() {
ServiceParameter newType = new ServiceParameter();
getParameter().add(newType);
return newType;
}
/**
* Gets the first repetition for parameter (Service call parameters),
* creating it if it does not already exist.
*
*
* Definition:
* A list of named parameters that is used in the service call
*
*/
public ServiceParameter getParameterFirstRep() {
if (getParameter().isEmpty()) {
return addParameter();
}
return getParameter().get(0);
}
}
/**
* Block class for child element: DocumentReference.service.parameter (Service call parameters)
*
*
* Definition:
* A list of named parameters that is used in the service call
*
*/
@Block()
public static class ServiceParameter
extends BaseIdentifiableElement implements IResourceBlock {
@Child(name="name", type=StringDt.class, order=0, min=1, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Parameter name in service call",
formalDefinition="The name of a parameter"
)
private StringDt myName;
@Child(name="value", type=StringDt.class, order=1, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Parameter value for the name",
formalDefinition="The value of the named parameter"
)
private StringDt myValue;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myName, myValue);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myName, myValue);
}
/**
* Gets the value(s) for name (Parameter name in service call).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The name of a parameter
*
*/
public StringDt getName() {
if (myName == null) {
myName = new StringDt();
}
return myName;
}
/**
* Gets the value(s) for name (Parameter name in service call).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The name of a parameter
*
*/
public StringDt getNameElement() {
if (myName == null) {
myName = new StringDt();
}
return myName;
}
/**
* Sets the value(s) for name (Parameter name in service call)
*
*
* Definition:
* The name of a parameter
*
*/
public ServiceParameter setName(StringDt theValue) {
myName = theValue;
return this;
}
/**
* Sets the value for name (Parameter name in service call)
*
*
* Definition:
* The name of a parameter
*
*/
public ServiceParameter setName( String theString) {
myName = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for value (Parameter value for the name).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The value of the named parameter
*
*/
public StringDt getValue() {
if (myValue == null) {
myValue = new StringDt();
}
return myValue;
}
/**
* Gets the value(s) for value (Parameter value for the name).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The value of the named parameter
*
*/
public StringDt getValueElement() {
if (myValue == null) {
myValue = new StringDt();
}
return myValue;
}
/**
* Sets the value(s) for value (Parameter value for the name)
*
*
* Definition:
* The value of the named parameter
*
*/
public ServiceParameter setValue(StringDt theValue) {
myValue = theValue;
return this;
}
/**
* Sets the value for value (Parameter value for the name)
*
*
* Definition:
* The value of the named parameter
*
*/
public ServiceParameter setValue( String theString) {
myValue = new StringDt(theString);
return this;
}
}
/**
* Block class for child element: DocumentReference.context (Clinical context of document)
*
*
* Definition:
* The clinical context in which the document was prepared
*
*/
@Block()
public static class Context
extends BaseIdentifiableElement implements IResourceBlock {
@Child(name="event", type=CodeableConceptDt.class, order=0, min=0, max=Child.MAX_UNLIMITED, summary=false, modifier=false)
@Description(
shortDefinition="Main Clinical Acts Documented",
formalDefinition="This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act"
)
private java.util.List myEvent;
@Child(name="period", type=PeriodDt.class, order=1, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Time of service that is being documented",
formalDefinition="The time period over which the service that is described by the document was provided"
)
private PeriodDt myPeriod;
@Child(name="facilityType", type=CodeableConceptDt.class, order=2, min=0, max=1, summary=false, modifier=false)
@Description(
shortDefinition="Kind of facility where patient was seen",
formalDefinition="The kind of facility where the patient was seen"
)
private CodeableConceptDt myFacilityType;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myEvent, myPeriod, myFacilityType);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myEvent, myPeriod, myFacilityType);
}
/**
* Gets the value(s) for event (Main Clinical Acts Documented).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act
*
*/
public java.util.List getEvent() {
if (myEvent == null) {
myEvent = new java.util.ArrayList();
}
return myEvent;
}
/**
* Gets the value(s) for event (Main Clinical Acts Documented).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act
*
*/
public java.util.List getEventElement() {
if (myEvent == null) {
myEvent = new java.util.ArrayList();
}
return myEvent;
}
/**
* Sets the value(s) for event (Main Clinical Acts Documented)
*
*
* Definition:
* This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act
*
*/
public Context setEvent(java.util.List theValue) {
myEvent = theValue;
return this;
}
/**
* Adds and returns a new value for event (Main Clinical Acts Documented)
*
*
* Definition:
* This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act
*
*/
public CodeableConceptDt addEvent() {
CodeableConceptDt newType = new CodeableConceptDt();
getEvent().add(newType);
return newType;
}
/**
* Gets the first repetition for event (Main Clinical Acts Documented),
* creating it if it does not already exist.
*
*
* Definition:
* This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the typeCode, such as a \"History and Physical Report\" in which the procedure being documented is necessarily a \"History and Physical\" act
*
*/
public CodeableConceptDt getEventFirstRep() {
if (getEvent().isEmpty()) {
return addEvent();
}
return getEvent().get(0);
}
/**
* Gets the value(s) for period (Time of service that is being documented).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The time period over which the service that is described by the document was provided
*
*/
public PeriodDt getPeriod() {
if (myPeriod == null) {
myPeriod = new PeriodDt();
}
return myPeriod;
}
/**
* Gets the value(s) for period (Time of service that is being documented).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The time period over which the service that is described by the document was provided
*
*/
public PeriodDt getPeriodElement() {
if (myPeriod == null) {
myPeriod = new PeriodDt();
}
return myPeriod;
}
/**
* Sets the value(s) for period (Time of service that is being documented)
*
*
* Definition:
* The time period over which the service that is described by the document was provided
*
*/
public Context setPeriod(PeriodDt theValue) {
myPeriod = theValue;
return this;
}
/**
* Gets the value(s) for facilityType (Kind of facility where patient was seen).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The kind of facility where the patient was seen
*
*/
public CodeableConceptDt getFacilityType() {
if (myFacilityType == null) {
myFacilityType = new CodeableConceptDt();
}
return myFacilityType;
}
/**
* Gets the value(s) for facilityType (Kind of facility where patient was seen).
* creating it if it does
* not exist. Will not return null
.
*
*
* Definition:
* The kind of facility where the patient was seen
*
*/
public CodeableConceptDt getFacilityTypeElement() {
if (myFacilityType == null) {
myFacilityType = new CodeableConceptDt();
}
return myFacilityType;
}
/**
* Sets the value(s) for facilityType (Kind of facility where patient was seen)
*
*
* Definition:
* The kind of facility where the patient was seen
*
*/
public Context setFacilityType(CodeableConceptDt theValue) {
myFacilityType = theValue;
return this;
}
}
@Override
public String getResourceName() {
return "DocumentReference";
}
public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum() {
return ca.uhn.fhir.context.FhirVersionEnum.DSTU1;
}
}