ca.uhn.fhir.model.dstu.composite.CodingDt 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 CodingDt Datatype
* (A reference to a code defined by a terminology system)
*
*
* Definition:
* A reference to a code defined by a terminology system
*
*
*
* Requirements:
* References to codes are very common in healthcare models
*
*/
@DatatypeDef(name="CodingDt")
public class CodingDt
extends BaseCodingDt implements ICompositeDatatype
{
/**
* Constructor
*/
public CodingDt() {
// nothing
}
/**
* Creates a new Coding with the given system and code
*/
public CodingDt(String theSystem, String theCode) {
setSystem(theSystem);
setCode(theCode);
}
/**
* Copy constructor: Creates a new Coding with the system and code copied out of the given coding
*/
public CodingDt(BaseCodingDt theCoding) {
this(theCoding.getSystemElement().getValueAsString(), theCoding.getCodeElement().getValue());
}
@Child(name="system", type=UriDt.class, order=0, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="Identity of the terminology system",
formalDefinition="The identification of the code system that defines the meaning of the symbol in the code."
)
private UriDt mySystem;
@Child(name="version", type=StringDt.class, order=1, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="Version of the system - if relevant",
formalDefinition="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged"
)
private StringDt myVersion;
@Child(name="code", type=CodeDt.class, order=2, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="Symbol in syntax defined by the system",
formalDefinition="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)"
)
private CodeDt myCode;
@Child(name="display", type=StringDt.class, order=3, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="Representation defined by the system",
formalDefinition="A representation of the meaning of the code in the system, following the rules of the system."
)
private StringDt myDisplay;
@Child(name="primary", type=BooleanDt.class, order=4, min=0, max=1, summary=true, modifier=false)
@Description(
shortDefinition="If this code was chosen directly by the user",
formalDefinition="Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)"
)
private BooleanDt myPrimary;
@Child(name="valueSet", order=5, min=0, max=1, summary=true, modifier=false, type={
ca.uhn.fhir.model.dstu.resource.ValueSet.class })
@Description(
shortDefinition="Set this coding was chosen from",
formalDefinition="The set of possible coded values this coding was chosen from or constrained by"
)
private ResourceReferenceDt myValueSet;
@Override
public boolean isEmpty() {
return super.isBaseEmpty() && ca.uhn.fhir.util.ElementUtil.isEmpty( mySystem, myVersion, myCode, myDisplay, myPrimary, myValueSet);
}
@Override
public List getAllPopulatedChildElementsOfType(Class theType) {
return ca.uhn.fhir.util.ElementUtil.allPopulatedChildElements(theType, mySystem, myVersion, myCode, myDisplay, myPrimary, myValueSet);
}
/**
* Gets the value(s) for system (Identity of the terminology system).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The identification of the code system that defines the meaning of the symbol in the code.
*
*/
public UriDt getSystem() {
if (mySystem == null) {
mySystem = new UriDt();
}
return mySystem;
}
/**
* Gets the value(s) for system (Identity of the terminology system).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The identification of the code system that defines the meaning of the symbol in the code.
*
*/
public UriDt getSystemElement() {
if (mySystem == null) {
mySystem = new UriDt();
}
return mySystem;
}
/**
* Sets the value(s) for system (Identity of the terminology system)
*
*
* Definition:
* The identification of the code system that defines the meaning of the symbol in the code.
*
*/
public CodingDt setSystem(UriDt theValue) {
mySystem = theValue;
return this;
}
/**
* Sets the value for system (Identity of the terminology system)
*
*
* Definition:
* The identification of the code system that defines the meaning of the symbol in the code.
*
*/
public CodingDt setSystem( String theUri) {
mySystem = new UriDt(theUri);
return this;
}
/**
* Gets the value(s) for version (Version of the system - if relevant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
*
*/
public StringDt getVersion() {
if (myVersion == null) {
myVersion = new StringDt();
}
return myVersion;
}
/**
* Gets the value(s) for version (Version of the system - if relevant).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
*
*/
public StringDt getVersionElement() {
if (myVersion == null) {
myVersion = new StringDt();
}
return myVersion;
}
/**
* Sets the value(s) for version (Version of the system - if relevant)
*
*
* Definition:
* The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
*
*/
public CodingDt setVersion(StringDt theValue) {
myVersion = theValue;
return this;
}
/**
* Sets the value for version (Version of the system - if relevant)
*
*
* Definition:
* The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and When the meaning is not guaranteed to be consistent, the version SHOULD be exchanged
*
*/
public CodingDt setVersion( String theString) {
myVersion = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for code (Symbol in syntax defined by the system).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
*
*/
public CodeDt getCode() {
if (myCode == null) {
myCode = new CodeDt();
}
return myCode;
}
/**
* Gets the value(s) for code (Symbol in syntax defined by the system).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
*
*/
public CodeDt getCodeElement() {
if (myCode == null) {
myCode = new CodeDt();
}
return myCode;
}
/**
* Sets the value(s) for code (Symbol in syntax defined by the system)
*
*
* Definition:
* A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
*
*/
public CodingDt setCode(CodeDt theValue) {
myCode = theValue;
return this;
}
/**
* Sets the value for code (Symbol in syntax defined by the system)
*
*
* Definition:
* A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)
*
*/
public CodingDt setCode( String theCode) {
myCode = new CodeDt(theCode);
return this;
}
/**
* Gets the value(s) for display (Representation defined by the system).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A representation of the meaning of the code in the system, following the rules of the system.
*
*/
public StringDt getDisplay() {
if (myDisplay == null) {
myDisplay = new StringDt();
}
return myDisplay;
}
/**
* Gets the value(s) for display (Representation defined by the system).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* A representation of the meaning of the code in the system, following the rules of the system.
*
*/
public StringDt getDisplayElement() {
if (myDisplay == null) {
myDisplay = new StringDt();
}
return myDisplay;
}
/**
* Sets the value(s) for display (Representation defined by the system)
*
*
* Definition:
* A representation of the meaning of the code in the system, following the rules of the system.
*
*/
public CodingDt setDisplay(StringDt theValue) {
myDisplay = theValue;
return this;
}
/**
* Sets the value for display (Representation defined by the system)
*
*
* Definition:
* A representation of the meaning of the code in the system, following the rules of the system.
*
*/
public CodingDt setDisplay( String theString) {
myDisplay = new StringDt(theString);
return this;
}
/**
* Gets the value(s) for primary (If this code was chosen directly by the user).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
*
*/
public BooleanDt getPrimary() {
if (myPrimary == null) {
myPrimary = new BooleanDt();
}
return myPrimary;
}
/**
* Gets the value(s) for primary (If this code was chosen directly by the user).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
*
*/
public BooleanDt getPrimaryElement() {
if (myPrimary == null) {
myPrimary = new BooleanDt();
}
return myPrimary;
}
/**
* Sets the value(s) for primary (If this code was chosen directly by the user)
*
*
* Definition:
* Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
*
*/
public CodingDt setPrimary(BooleanDt theValue) {
myPrimary = theValue;
return this;
}
/**
* Sets the value for primary (If this code was chosen directly by the user)
*
*
* Definition:
* Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays)
*
*/
public CodingDt setPrimary( boolean theBoolean) {
myPrimary = new BooleanDt(theBoolean);
return this;
}
/**
* Gets the value(s) for valueSet (Set this coding was chosen from).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The set of possible coded values this coding was chosen from or constrained by
*
*/
public ResourceReferenceDt getValueSet() {
if (myValueSet == null) {
myValueSet = new ResourceReferenceDt();
}
return myValueSet;
}
/**
* Gets the value(s) for valueSet (Set this coding was chosen from).
* creating it if it does
* not exist. Will not return null.
*
*
* Definition:
* The set of possible coded values this coding was chosen from or constrained by
*
*/
public ResourceReferenceDt getValueSetElement() {
if (myValueSet == null) {
myValueSet = new ResourceReferenceDt();
}
return myValueSet;
}
/**
* Sets the value(s) for valueSet (Set this coding was chosen from)
*
*
* Definition:
* The set of possible coded values this coding was chosen from or constrained by
*
*/
public CodingDt setValueSet(ResourceReferenceDt theValue) {
myValueSet = theValue;
return this;
}
}