@medplum/fhirtypes/dist/SubstanceProtein.d.ts

Medplum FHIR Type Definitions

/*
 * This is a generated file
 * Do not edit manually.
 */

import { Attachment } from './Attachment';
import { CodeableConcept } from './CodeableConcept';
import { Extension } from './Extension';
import { Identifier } from './Identifier';
import { Meta } from './Meta';
import { Narrative } from './Narrative';
import { Resource } from './Resource';

/**
 * 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.
 */
export interface SubstanceProtein {

  /**
   * This is a SubstanceProtein resource
   */
  readonly resourceType: 'SubstanceProtein';

  /**
   * The logical id of the resource, as used in the URL for the resource.
   * Once assigned, this value never changes.
   */
  id?: string;

  /**
   * The metadata about the resource. This is content that is maintained by
   * the infrastructure. Changes to the content might not always be
   * associated with version changes to the resource.
   */
  meta?: Meta;

  /**
   * A reference to a set of rules that were followed when the resource was
   * constructed, and which must be understood when processing the content.
   * Often, this is a reference to an implementation guide that defines the
   * special rules along with other profiles etc.
   */
  implicitRules?: string;

  /**
   * The base language in which the resource is written.
   */
  language?: string;

  /**
   * A human-readable narrative that contains a summary of the resource and
   * can be used to represent the content of the resource to a human. The
   * narrative need not encode all the structured data, but is required to
   * contain sufficient detail to make it "clinically safe" for a human to
   * just read the narrative. Resource definitions may define what content
   * should be represented in the narrative to ensure clinical safety.
   */
  text?: Narrative;

  /**
   * These resources do not have an independent existence apart from the
   * resource that contains them - they cannot be identified independently,
   * and nor can they have their own independent transaction scope.
   */
  contained?: Resource[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the resource. To make the use of extensions
   * safe and manageable, there is a strict set of governance  applied to
   * the definition and use of extensions. Though any implementer can
   * define an extension, there is a set of requirements that SHALL be met
   * as part of the definition of the extension.
   */
  extension?: Extension[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the resource and that modifies the
   * understanding of the element that contains it and/or the understanding
   * of the containing element's descendants. Usually modifier elements
   * provide negation or qualification. To make the use of extensions safe
   * and manageable, there is a strict set of governance applied to the
   * definition and use of extensions. Though any implementer is allowed to
   * define an extension, there is a set of requirements that SHALL be met
   * as part of the definition of the extension. Applications processing a
   * resource are required to check for modifier extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * 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.
   */
  sequenceType?: CodeableConcept;

  /**
   * 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.
   */
  numberOfSubunits?: number;

  /**
   * 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.
   */
  disulfideLinkage?: string[];

  /**
   * 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.
   */
  subunit?: SubstanceProteinSubunit[];
}

/**
 * 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.
 */
export interface SubstanceProteinSubunit {

  /**
   * Unique id for the element within a resource (for internal references).
   * This may be any string value that does not contain spaces.
   */
  id?: string;

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element. To make the use of extensions
   * safe and manageable, there is a strict set of governance  applied to
   * the definition and use of extensions. Though any implementer can
   * define an extension, there is a set of requirements that SHALL be met
   * as part of the definition of the extension.
   */
  extension?: Extension[];

  /**
   * May be used to represent additional information that is not part of
   * the basic definition of the element and that modifies the
   * understanding of the element in which it is contained and/or the
   * understanding of the containing element's descendants. Usually
   * modifier elements provide negation or qualification. To make the use
   * of extensions safe and manageable, there is a strict set of governance
   * applied to the definition and use of extensions. Though any
   * implementer can define an extension, there is a set of requirements
   * that SHALL be met as part of the definition of the extension.
   * Applications processing a resource are required to check for modifier
   * extensions.
   *
   * Modifier extensions SHALL NOT change the meaning of any elements on
   * Resource or DomainResource (including cannot change the meaning of
   * modifierExtension itself).
   */
  modifierExtension?: Extension[];

  /**
   * Index of primary sequences of amino acids linked through peptide bonds
   * in order of decreasing length. Sequences of the same length will be
   * ordered by molecular weight. Subunits that have identical sequences
   * will be repeated and have sequential subscripts.
   */
  subunit?: number;

  /**
   * The sequence information shall be provided enumerating the amino acids
   * from N- to C-terminal end using standard single-letter amino acid
   * codes. Uppercase shall be used for L-amino acids and lowercase for
   * D-amino acids. Transcribed SubstanceProteins will always be described
   * using the translated sequence; for synthetic peptide containing amino
   * acids that are not represented with a single letter code an X should
   * be used within the sequence. The modified amino acids will be
   * distinguished by their position in the sequence.
   */
  sequence?: string;

  /**
   * Length of linear sequences of amino acids contained in the subunit.
   */
  length?: number;

  /**
   * The sequence information shall be provided enumerating the amino acids
   * from N- to C-terminal end using standard single-letter amino acid
   * codes. Uppercase shall be used for L-amino acids and lowercase for
   * D-amino acids. Transcribed SubstanceProteins will always be described
   * using the translated sequence; for synthetic peptide containing amino
   * acids that are not represented with a single letter code an X should
   * be used within the sequence. The modified amino acids will be
   * distinguished by their position in the sequence.
   */
  sequenceAttachment?: Attachment;

  /**
   * Unique identifier for molecular fragment modification based on the ISO
   * 11238 Substance ID.
   */
  nTerminalModificationId?: Identifier;

  /**
   * The name of the fragment modified at the N-terminal of the
   * SubstanceProtein shall be specified.
   */
  nTerminalModification?: string;

  /**
   * Unique identifier for molecular fragment modification based on the ISO
   * 11238 Substance ID.
   */
  cTerminalModificationId?: Identifier;

  /**
   * The modification at the C-terminal shall be specified.
   */
  cTerminalModification?: string;
}