Package org.hl7.fhir.r4.model

Class SubstanceNucleicAcid

java.lang.Object

org.hl7.fhir.r4.model.Base

org.hl7.fhir.r4.model.BaseResource

org.hl7.fhir.r4.model.Resource

org.hl7.fhir.r4.model.DomainResource

org.hl7.fhir.r4.model.SubstanceNucleicAcid

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class SubstanceNucleicAcid
extends DomainResource

Nucleic acids are defined by three distinct elements: the base, sugar and linkage. Individual substance/moiety IDs will be created for each of these elements. The nucleotide sequence will be always entered in the 5’-3’ direction.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent
static class	SubstanceNucleicAcid.SubstanceNucleicAcidSubunitLinkageComponent
static class	SubstanceNucleicAcid.SubstanceNucleicAcidSubunitSugarComponent

Field Summary

Fields

Modifier and Type	Field	Description
protected StringType	areaOfHybridisation	The area of hybridisation shall be described if applicable for double stranded RNA or DNA.
protected IntegerType	numberOfSubunits	The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described.
protected CodeableConcept	oligoNucleotideType	(TBC).
protected CodeableConcept	sequenceType	The type of the sequence shall be specified based on a controlled vocabulary.
protected List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent>	subunit	Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.

Fields inherited from class org.hl7.fhir.r4.model.DomainResource

contained, extension, modifierExtension, text

Fields inherited from class org.hl7.fhir.r4.model.Resource

id, implicitRules, language, meta

Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
SubstanceNucleicAcid()	Constructor

Method Summary

Modifier and Type	Method	Description
Base	addChild(String name)
SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent	addSubunit()
SubstanceNucleicAcid	addSubunit(SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent t)
SubstanceNucleicAcid	copy()
void	copyValues(SubstanceNucleicAcid dst)
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
String	getAreaOfHybridisation()
StringType	getAreaOfHybridisationElement()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
int	getNumberOfSubunits()
IntegerType	getNumberOfSubunitsElement()
CodeableConcept	getOligoNucleotideType()
Base[]	getProperty(int hash, String name, boolean checkValid)
ResourceType	getResourceType()
CodeableConcept	getSequenceType()
List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent>	getSubunit()
SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent	getSubunitFirstRep()
String[]	getTypesForProperty(int hash, String name)
boolean	hasAreaOfHybridisation()
boolean	hasAreaOfHybridisationElement()
boolean	hasNumberOfSubunits()
boolean	hasNumberOfSubunitsElement()
boolean	hasOligoNucleotideType()
boolean	hasSequenceType()
boolean	hasSubunit()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
SubstanceNucleicAcid	setAreaOfHybridisation(String value)
SubstanceNucleicAcid	setAreaOfHybridisationElement(StringType value)
SubstanceNucleicAcid	setNumberOfSubunits(int value)
SubstanceNucleicAcid	setNumberOfSubunitsElement(IntegerType value)
SubstanceNucleicAcid	setOligoNucleotideType(CodeableConcept value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
SubstanceNucleicAcid	setSequenceType(CodeableConcept value)
SubstanceNucleicAcid	setSubunit(List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent> theSubunit)
protected SubstanceNucleicAcid	typedCopy()

Methods inherited from class org.hl7.fhir.r4.model.DomainResource

addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText

Methods inherited from class org.hl7.fhir.r4.model.Resource

copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta

Methods inherited from class org.hl7.fhir.r4.model.BaseResource

getStructureFhirVersionEnum, isResource, setId

Methods inherited from class org.hl7.fhir.r4.model.Base

castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource

getId, getIdElement, getLanguageElement, getUserData, setId, setUserData

Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getMeta, getStructureFhirVersionEnum, setId

Field Detail

sequenceType

protected CodeableConcept sequenceType

The type of the sequence shall be specified based on a controlled vocabulary.

numberOfSubunits

protected IntegerType numberOfSubunits

The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.

areaOfHybridisation

protected StringType areaOfHybridisation

The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.

oligoNucleotideType

protected CodeableConcept oligoNucleotideType

(TBC).

subunit

protected List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent> subunit

Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.

Constructor Detail

SubstanceNucleicAcid

public SubstanceNucleicAcid()

Constructor

Method Detail

getSequenceType

public CodeableConcept getSequenceType()

Returns:

sequenceType (The type of the sequence shall be specified based on a controlled vocabulary.)

hasSequenceType

public boolean hasSequenceType()

setSequenceType

public SubstanceNucleicAcid setSequenceType(CodeableConcept value)

Parameters:

value - sequenceType (The type of the sequence shall be specified based on a controlled vocabulary.)

getNumberOfSubunitsElement

public IntegerType getNumberOfSubunitsElement()

Returns:

numberOfSubunits (The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSubunits" gives direct access to the value

hasNumberOfSubunitsElement

public boolean hasNumberOfSubunitsElement()

hasNumberOfSubunits

public boolean hasNumberOfSubunits()

setNumberOfSubunitsElement

public SubstanceNucleicAcid setNumberOfSubunitsElement(IntegerType value)

Parameters:

value - numberOfSubunits (The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.). This is the underlying object with id, value and extensions. The accessor "getNumberOfSubunits" gives direct access to the value

getNumberOfSubunits

public int getNumberOfSubunits()

Returns:

The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.

setNumberOfSubunits

public SubstanceNucleicAcid setNumberOfSubunits(int value)

Parameters:

value - The number of linear sequences of nucleotides linked through phosphodiester bonds shall be described. Subunits would be strands of nucleic acids that are tightly associated typically through Watson-Crick base pairing. NOTE: If not specified in the reference source, the assumption is that there is 1 subunit.

getAreaOfHybridisationElement

public StringType getAreaOfHybridisationElement()

Returns:

areaOfHybridisation (The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.). This is the underlying object with id, value and extensions. The accessor "getAreaOfHybridisation" gives direct access to the value

hasAreaOfHybridisationElement

public boolean hasAreaOfHybridisationElement()

hasAreaOfHybridisation

public boolean hasAreaOfHybridisation()

setAreaOfHybridisationElement

public SubstanceNucleicAcid setAreaOfHybridisationElement(StringType value)

Parameters:

value - areaOfHybridisation (The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.). This is the underlying object with id, value and extensions. The accessor "getAreaOfHybridisation" gives direct access to the value

getAreaOfHybridisation

public String getAreaOfHybridisation()

Returns:

The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.

setAreaOfHybridisation

public SubstanceNucleicAcid setAreaOfHybridisation(String value)

Parameters:

value - The area of hybridisation shall be described if applicable for double stranded RNA or DNA. The number associated with the subunit followed by the number associated to the residue shall be specified in increasing order. The underscore “” shall be used as separator as follows: “Subunitnumber Residue”.

getOligoNucleotideType

public CodeableConcept getOligoNucleotideType()

Returns:

oligoNucleotideType ((TBC).)

hasOligoNucleotideType

public boolean hasOligoNucleotideType()

setOligoNucleotideType

public SubstanceNucleicAcid setOligoNucleotideType(CodeableConcept value)

Parameters:

value - oligoNucleotideType ((TBC).)

getSubunit

public List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent> getSubunit()

Returns:

subunit (Subunits are listed in order of decreasing length; sequences of the same length will be ordered by molecular weight; subunits that have identical sequences will be repeated multiple times.)

setSubunit

public SubstanceNucleicAcid setSubunit(List<SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent> theSubunit)

Returns:

Returns a reference to this for easy method chaining

hasSubunit

public boolean hasSubunit()

addSubunit

public SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent addSubunit()

addSubunit

public SubstanceNucleicAcid addSubunit(SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent t)

getSubunitFirstRep

public SubstanceNucleicAcid.SubstanceNucleicAcidSubunitComponent getSubunitFirstRep()

Returns:

The first repetition of repeating field subunit, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getProperty

public Base[] getProperty(int hash,
                          String name,
                          boolean checkValid)
                   throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(int hash,
                        String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Specified by:

fhirType in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

fhirType in class DomainResource

copy

public SubstanceNucleicAcid copy()

Specified by:

copy in class DomainResource

copyValues

public void copyValues(SubstanceNucleicAcid dst)

typedCopy

protected SubstanceNucleicAcid typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource