Skip to main content


class HS.FHIR.DTL.vR4.Model.Resource.SubstanceProtein extends HS.FHIR.DTL.vR4.Model.Base.DomainResource

A SubstanceProtein is defined as a single unit of a linear amino acid sequence, or a combination of subunits that are either covalently linked or have a defined invariant stoichiometric relationship. This includes all synthetic, recombinant and purified SubstanceProteins of defined sequence, whether the use is therapeutic or prophylactic. This set of elements will be used to describe albumins, coagulation factors, cytokines, growth factors, peptide/SubstanceProtein hormones, enzymes, toxins, toxoids, recombinant vaccines, and immunomodulators.

Property Inventory


Inherited description: ELEMENTQUALIFIED controls the format of exported XML. The ELEMENTQUALIFIED specification should be based on the elementFormDefault attribute of the schema that defines the type. To maintain compatibility, ELEMENTQUALIFIED will default to 1 (true) for literal format export and will default to 0 (false) for encoded or encoded12 format export. These were the values always previously assumed for the elementFormDefault attribute. NOTE: Direct use of XMLExport method does not support the ELEMENTQUALIFIED. The export must be done using %XML.Writer or SOAP support.
parameter XMLNAME = SubstanceProtein;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.
parameter XMLSEQUENCE = 1;
Inherited description: If the XMLSEQUENCE = 1, then the order of the XML elements must match the order of the class properties. This allows us to deal with XML where the same field appears multiple times and is distinguished by the order.
parameter XMLTYPE = SubstanceProtein;
Inherited description: This parameter provides the default XMLTYPE for the class. If it is empty then the class name will be used to construct a default XML type. The default XMLTYPE is used when naming and referencing this type in a schema and the schema context did not provide an XML type name.


property disulfideLinkage as list of %String (MAXLEN = 1000000, XMLNAME = "disulfideLinkage", XMLPROJECTION = "ELEMENT");

The disulphide bond between two cysteine residues either on the same subunit or on two different subunits shall be described. The position of the disulfide bonds in the SubstanceProtein shall be listed in increasing order of subunit number and position within subunit followed by the abbreviation of the amino acids involved. The disulfide linkage positions shall actually contain the amino acid Cysteine at the respective positions.

Property methods: disulfideLinkageBuildValueArray(), disulfideLinkageCollectionToDisplay(), disulfideLinkageCollectionToOdbc(), disulfideLinkageDisplayToCollection(), disulfideLinkageDisplayToLogical(), disulfideLinkageGet(), disulfideLinkageGetObject(), disulfideLinkageGetObjectId(), disulfideLinkageGetSwizzled(), disulfideLinkageIsValid(), disulfideLinkageLogicalToDisplay(), disulfideLinkageLogicalToOdbc(), disulfideLinkageNormalize(), disulfideLinkageOdbcToCollection(), disulfideLinkageSet(), disulfideLinkageSetObject(), disulfideLinkageSetObjectId()
property numberOfSubunits as %Integer (XMLNAME = "numberOfSubunits", XMLPROJECTION = "ATTRIBUTE");

Number of linear sequences of amino acids linked through peptide bonds. The number of subunits constituting the SubstanceProtein shall be described. It is possible that the number of subunits can be variable.

Property methods: numberOfSubunitsDisplayToLogical(), numberOfSubunitsGet(), numberOfSubunitsIsValid(), numberOfSubunitsLogicalToDisplay(), numberOfSubunitsNormalize(), numberOfSubunitsSet(), numberOfSubunitsXSDToLogical()
property sequenceType as HS.FHIR.DTL.vR4.Model.Datatype.CodeableConcept (XMLNAME = "sequenceType", XMLPROJECTION = "ELEMENT");

The SubstanceProtein descriptive elements will only be used when a complete or partial amino acid sequence is available or derivable from a nucleic acid sequence.

any FHIR4 code from any ValueSet may be used.

Property methods: sequenceTypeGet(), sequenceTypeGetSwizzled(), sequenceTypeIsValid(), sequenceTypeNewObject(), sequenceTypeSet()
property subunit as list of HS.FHIR.DTL.vR4.Model.Element.SubstanceProtein.subunit (XMLNAME = "subunit", XMLPROJECTION = "ELEMENT");

This subclause refers to the description of each subunit constituting the SubstanceProtein. A subunit is a linear sequence of amino acids linked through peptide bonds. The Subunit information shall be provided when the finished SubstanceProtein is a complex of multiple sequences; subunits are not used to delineate domains within a single sequence. Subunits are listed in order of decreasing length; sequences of the same length will be ordered by decreasing molecular weight; subunits that have identical sequences will be repeated multiple times.

Property methods: subunitBuildValueArray(), subunitCollectionToDisplay(), subunitCollectionToOdbc(), subunitDisplayToCollection(), subunitGet(), subunitGetObject(), subunitGetObjectId(), subunitGetSwizzled(), subunitIsValid(), subunitOdbcToCollection(), subunitSet(), subunitSetObject(), subunitSetObjectId()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab