ca.uhn.fhir.model.dstu.composite.IdentifierDt Maven / Gradle / Ivy
package ca.uhn.fhir.model.dstu.composite;
import java.math.BigDecimal;
import org.apache.commons.lang3.StringUtils;
import java.util.*;
import ca.uhn.fhir.model.api.*;
import ca.uhn.fhir.model.primitive.*;
import ca.uhn.fhir.model.api.annotation.*;
import ca.uhn.fhir.model.base.composite.*;
import ca.uhn.fhir.model.dstu.valueset.AddressUseEnum;
import ca.uhn.fhir.model.dstu.composite.CodingDt;
import ca.uhn.fhir.model.dstu.valueset.ContactSystemEnum;
import ca.uhn.fhir.model.dstu.valueset.ContactUseEnum;
import ca.uhn.fhir.model.dstu.valueset.EventTimingEnum;
import ca.uhn.fhir.model.dstu.valueset.IdentifierUseEnum;
import ca.uhn.fhir.model.dstu.valueset.NameUseEnum;
import ca.uhn.fhir.model.dstu.resource.Organization;
import ca.uhn.fhir.model.dstu.composite.PeriodDt;
import ca.uhn.fhir.model.dstu.valueset.QuantityCompararatorEnum;
import ca.uhn.fhir.model.dstu.composite.QuantityDt;
import ca.uhn.fhir.model.api.TemporalPrecisionEnum;
import ca.uhn.fhir.model.dstu.valueset.UnitsOfTimeEnum;
import ca.uhn.fhir.model.dstu.resource.ValueSet;
import ca.uhn.fhir.model.dstu.composite.ResourceReferenceDt;
import ca.uhn.fhir.model.primitive.Base64BinaryDt;
import ca.uhn.fhir.model.primitive.BooleanDt;
import ca.uhn.fhir.model.primitive.BoundCodeDt;
import ca.uhn.fhir.model.primitive.CodeDt;
import ca.uhn.fhir.model.primitive.DateTimeDt;
import ca.uhn.fhir.model.primitive.DecimalDt;
import ca.uhn.fhir.model.primitive.IntegerDt;
import ca.uhn.fhir.model.primitive.StringDt;
import ca.uhn.fhir.model.primitive.UriDt;
/**
* HAPI/FHIR IdentifierDt Datatype
* (An identifier intended for computation)
*
*
* Definition:
* A technical identifier - identifies some entity uniquely and unambiguously
*
*
*
* Requirements:
* Need to be able to identify things with confidence and be sure that the identification is not subject to misinterpretation
*
*/
@DatatypeDef(name="IdentifierDt")
public class IdentifierDt
extends BaseIdentifierDt implements ICompositeDatatype
{
/**
* Constructor
*/
public IdentifierDt() {
// nothing
}
/**
* Creates a new identifier with the given system and value
*/
@SimpleSetter
public IdentifierDt(@SimpleSetter.Parameter(name="theSystem") String theSystem, @SimpleSetter.Parameter(name="theValue") String theValue) {
setSystem(theSystem);
setValue(theValue);
}
/**
* Creates a new identifier with the given system and value
*/
@SimpleSetter
public IdentifierDt(@SimpleSetter.Parameter(name="theUse") IdentifierUseEnum theUse, @SimpleSetter.Parameter(name="theSystem") String theSystem, @SimpleSetter.Parameter(name="theValue") String theValue, @SimpleSetter.Parameter(name="theLabel") String theLabel) {
setUse(theUse);
setSystem(theSystem);
setValue(theValue);
setLabel(theLabel);
}
@Override
public String toString() {
return "IdentifierDt[" + getValue() + "]";
}
@Child(name="use", type=CodeDt.class, order=0, min=0, max=1, summary=true, modifier=true)
@Description(
shortDefinition="usual | official | temp | secondary (If known)",
formalDefinition="The purpose of this identifier"
)
private BoundCodeDt myUse;
@Child(name="label", type=StringDt.class, order=1, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="Description of identifier",
formalDefinition="A text string for the identifier that can be displayed to a human so they can recognize the identifier"
)
private StringDt myLabel;
@Child(name="system", type=UriDt.class, order=2, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="The namespace for the identifier",
formalDefinition="Establishes the namespace in which set of possible id values is unique."
)
private UriDt mySystem;
@Child(name="value", type=StringDt.class, order=3, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="The value that is unique",
formalDefinition="The portion of the identifier typically displayed to the user and which is unique within the context of the system."
)
private StringDt myValue;
@Child(name="period", type=PeriodDt.class, order=4, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="Time period when id is/was valid for use",
formalDefinition="Time period during which identifier is/was valid for use"
)
private PeriodDt myPeriod;
@Child(name="assigner", order=5, min=0, max=1, summary=true, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.Organization.class })
@Description(
shortDefinition="Organization that issued id (may be just text)",
formalDefinition="Organization that issued/manages the identifier"
)
private ResourceReferenceDt myAssigner;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( myUse, myLabel, mySystem, myValue, myPeriod, myAssigner);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, myUse, myLabel, mySystem, myValue, myPeriod, myAssigner);
}
/**
* Gets the value(s) for use (usual | official | temp | secondary (If known)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The purpose of this identifier
*
*/
public BoundCodeDt getUse() {
if (myUse == null) {
myUse = new BoundCodeDt(IdentifierUseEnum.VALUESET_BINDER);
}
return myUse;
}
/**
* Gets the value(s) for use (usual | official | temp | secondary (If known)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The purpose of this identifier
*
*/
public BoundCodeDt getUseElement() {
if (myUse == null) {
myUse = new BoundCodeDt(IdentifierUseEnum.VALUESET_BINDER);
}
return myUse;
}
/**
* Sets the value(s) for use (usual | official | temp | secondary (If known))
*
*
* Definition:
* The purpose of this identifier
*
*/
public IdentifierDt setUse(BoundCodeDt theValue) {
myUse = theValue;
return this;
}
/**
* Sets the value(s) for use (usual | official | temp | secondary (If known))
*
*
* Definition:
* The purpose of this identifier
*
*/
public IdentifierDt setUse(IdentifierUseEnum theValue) {
getUse().setValueAsEnum(theValue);
return this;
}
/**
* Gets the value(s) for label (Description of identifier).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A text string for the identifier that can be displayed to a human so they can recognize the identifier
*
*/
public StringDt getLabel() {
if (myLabel == null) {
myLabel = new StringDt();
}
return myLabel;
}
/**
* Gets the value(s) for label (Description of identifier).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A text string for the identifier that can be displayed to a human so they can recognize the identifier
*
*/
public StringDt getLabelElement() {
if (myLabel == null) {
myLabel = new StringDt();
}
return myLabel;
}
/**
* Sets the value(s) for label (Description of identifier)
*
*
* Definition:
* A text string for the identifier that can be displayed to a human so they can recognize the identifier
*
*/
public IdentifierDt setLabel(StringDt theValue) {
myLabel = theValue;
return this;
}
/**
* Sets the value for label (Description of identifier)
*
*
* Definition:
* A text string for the identifier that can be displayed to a human so they can recognize the identifier
*
*/
public IdentifierDt setLabel( String theString) {
myLabel = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for system (The namespace for the identifier).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Establishes the namespace in which set of possible id values is unique.
*
*/
public UriDt getSystem() {
if (mySystem == null) {
mySystem = new UriDt();
}
return mySystem;
}
/**
* Gets the value(s) for system (The namespace for the identifier).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Establishes the namespace in which set of possible id values is unique.
*
*/
public UriDt getSystemElement() {
if (mySystem == null) {
mySystem = new UriDt();
}
return mySystem;
}
/**
* Sets the value(s) for system (The namespace for the identifier)
*
*
* Definition:
* Establishes the namespace in which set of possible id values is unique.
*
*/
public IdentifierDt setSystem(UriDt theValue) {
mySystem = theValue;
return this;
}
/**
* Sets the value for system (The namespace for the identifier)
*
*
* Definition:
* Establishes the namespace in which set of possible id values is unique.
*
*/
public IdentifierDt setSystem( String theUri) {
mySystem = new UriDt(theUri);
return this;
}
/**
* Gets the value(s) for value (The value that is unique).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The portion of the identifier typically displayed to the user and which is unique within the context of the system.
*
*/
public StringDt getValue() {
if (myValue == null) {
myValue = new StringDt();
}
return myValue;
}
/**
* Gets the value(s) for value (The value that is unique).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The portion of the identifier typically displayed to the user and which is unique within the context of the system.
*
*/
public StringDt getValueElement() {
if (myValue == null) {
myValue = new StringDt();
}
return myValue;
}
/**
* Sets the value(s) for value (The value that is unique)
*
*
* Definition:
* The portion of the identifier typically displayed to the user and which is unique within the context of the system.
*
*/
public IdentifierDt setValue(StringDt theValue) {
myValue = theValue;
return this;
}
/**
* Sets the value for value (The value that is unique)
*
*
* Definition:
* The portion of the identifier typically displayed to the user and which is unique within the context of the system.
*
*/
public IdentifierDt setValue( String theString) {
myValue = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for period (Time period when id is/was valid for use).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Time period during which identifier is/was valid for use
*
*/
public PeriodDt getPeriod() {
if (myPeriod == null) {
myPeriod = new PeriodDt();
}
return myPeriod;
}
/**
* Gets the value(s) for period (Time period when id is/was valid for use).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Time period during which identifier is/was valid for use
*
*/
public PeriodDt getPeriodElement() {
if (myPeriod == null) {
myPeriod = new PeriodDt();
}
return myPeriod;
}
/**
* Sets the value(s) for period (Time period when id is/was valid for use)
*
*
* Definition:
* Time period during which identifier is/was valid for use
*
*/
public IdentifierDt setPeriod(PeriodDt theValue) {
myPeriod = theValue;
return this;
}
/**
* Gets the value(s) for assigner (Organization that issued id (may be just text)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Organization that issued/manages the identifier
*
*/
public ResourceReferenceDt getAssigner() {
if (myAssigner == null) {
myAssigner = new ResourceReferenceDt();
}
return myAssigner;
}
/**
* Gets the value(s) for assigner (Organization that issued id (may be just text)).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Organization that issued/manages the identifier
*
*/
public ResourceReferenceDt getAssignerElement() {
if (myAssigner == null) {
myAssigner = new ResourceReferenceDt();
}
return myAssigner;
}
/**
* Sets the value(s) for assigner (Organization that issued id (may be just text))
*
*
* Definition:
* Organization that issued/manages the identifier
*
*/
public IdentifierDt setAssigner(ResourceReferenceDt theValue) {
myAssigner = theValue;
return this;
}
}