FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

Responsible Owner: Biomedical Research and Regulation icon Work Group NormativeSecurity Category: Anonymous Compartments: No defined compartments

Detailed Descriptions for the elements in the SubstanceDefinition resource.

Element Id SubstanceDefinition
Definition

The detailed description of a substance, typically at a level beyond what is used for prescribing.

Short Display The detailed description of a substance, typically at a level beyond what is used for prescribing
Cardinality 0..*
Type DomainResource
Summary false
Element Id SubstanceDefinition.identifier
Definition

Identifier by which this substance is known.

Short Display Identifier by which this substance is known
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary true
Element Id SubstanceDefinition.version
Definition

A business level edition or revision identifier.

Short Display A business level edition or revision identifier
Note This is a business versionId, not a resource version id (see discussion)
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.status
Definition

Status of substance within the catalogue e.g. active, retired.

Short Display Status of substance within the catalogue e.g. active, retired
Cardinality 0..1
Terminology Binding PublicationStatus (Preferred)
Type CodeableConcept
Is Modifier true (Reason: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid)
Summary true
Element Id SubstanceDefinition.classification
Definition

A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).

Short Display A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
Cardinality 0..*
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.domain
Definition

The applicable usage of the substance, as an example human or veterinary.

Short Display The applicable usage of the substance, as an example human or veterinary
Cardinality 0..1
Terminology Binding Medicinal Product Domain (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.grade
Definition

The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).

Short Display The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
Cardinality 0..*
Terminology Binding Substance Grade (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.description
Definition

Textual description of the substance.

Short Display Textual description of the substance
Cardinality 0..1
Type markdown
Summary true
Element Id SubstanceDefinition.note
Definition

Textual comment about the substance's catalogue or registry record.

Short Display Textual comment about the substance's catalogue or registry record
Cardinality 0..*
Type Annotation
Summary true
Element Id SubstanceDefinition.manufacturer
Definition

The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.

Short Display The entity that creates, makes, produces or fabricates the substance
Cardinality 0..*
Type Reference(Organization)
Summary true
Element Id SubstanceDefinition.supplier
Definition

An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.

Short Display An entity that is the source for the substance. It may be different from the manufacturer
Cardinality 0..*
Type Reference(Organization)
Summary true
Element Id SubstanceDefinition.moiety
Definition

Moiety, for structural modifications.

Short Display Moiety, for structural modifications
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.moiety.role
Definition

Role that the moiety is playing.

Short Display Role that the moiety is playing
Cardinality 0..1
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.moiety.identifier
Definition

Identifier by which this moiety substance is known.

Short Display Identifier by which this moiety substance is known
Note This is a business identifier, not a resource identifier (see discussion)
Cardinality 0..*
Type Identifier
Summary true
Element Id SubstanceDefinition.moiety.name
Definition

Textual name for this moiety substance.

Short Display Textual name for this moiety substance
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.moiety.stereochemistry
Definition

Stereochemistry type.

Short Display Stereochemistry type
Cardinality 0..1
Terminology Binding Stereochemistry (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.moiety.opticalActivity
Definition

Optical activity type.

Short Display Optical activity type
Cardinality 0..1
Terminology Binding Optical Activity (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.moiety.molecularFormula
Definition

Molecular formula for this moiety of this substance, typically using the Hill system.

Short Display Molecular formula for this moiety (e.g. with the Hill system)
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.moiety.amount[x]
Definition

Quantitative value for this moiety.

Short Display Quantitative value for this moiety
Cardinality 0..1
Type Quantity|string
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id SubstanceDefinition.moiety.measurementType
Definition

The measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio.

Short Display The measurement type of the quantitative value
Cardinality 0..1
Terminology Binding Substance Amount Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.characterization
Definition

General specifications for this substance.

Short Display General specifications for this substance
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.characterization.technique
Definition

The method used to elucidate the characterization of the drug substance. Example: HPLC.

Short Display The method used to find the characterization e.g. HPLC
Cardinality 0..1
Terminology Binding Structure Technique (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.characterization.form
Definition

Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form.

Short Display Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form
Cardinality 0..1
Terminology Binding Substance Form (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.characterization.description
Definition

The description or justification in support of the interpretation of the data file.

Short Display The description or justification in support of the interpretation of the data file
Cardinality 0..1
Type markdown
Summary true
Element Id SubstanceDefinition.characterization.file
Definition

The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis.

Short Display The data produced by the analytical instrument or a pictorial representation of that data. Examples: a JCAMP, JDX, or ADX file, or a chromatogram or spectrum analysis
Cardinality 0..*
Type Attachment
Summary true
Element Id SubstanceDefinition.property
Definition

General specifications for this substance.

Short Display General specifications for this substance
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.property.type
Definition

A code expressing the type of property.

Short Display A code expressing the type of property
Cardinality 1..1
Terminology Binding Product Characteristic (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.property.value[x]
Definition

A value for the property.

Short Display A value for the property
Cardinality 0..1
Type CodeableConcept|Quantity|Range|date|boolean|Attachment
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id SubstanceDefinition.molecularWeight
Definition

The average mass of a molecule of a compound compared to 1/12 the mass of carbon 12 and calculated as the sum of the atomic weights of the constituent atoms.

Short Display The average mass of a molecule of a compound
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.molecularWeight.method
Definition

The method by which the molecular weight was determined.

Short Display The method by which the weight was determined
Cardinality 0..1
Terminology Binding Weight Method (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.molecularWeight.type
Definition

Type of molecular weight such as exact, average (also known as. number average), weight average.

Short Display Type of molecular weight e.g. exact, average, weight average
Cardinality 0..1
Terminology Binding Weight Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.molecularWeight.amount
Definition

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

Short Display Used to capture quantitative values for a variety of elements
Cardinality 1..1
Type Quantity
Summary true
Element Id SubstanceDefinition.structure
Definition

Structural information.

Short Display Structural information
Cardinality 0..1
Summary true
Element Id SubstanceDefinition.structure.stereochemistry
Definition

Stereochemistry type.

Short Display Stereochemistry type
Cardinality 0..1
Terminology Binding Stereochemistry (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.structure.opticalActivity
Definition

Optical activity type.

Short Display Optical activity type
Cardinality 0..1
Terminology Binding Optical Activity (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.structure.molecularFormula
Definition

An expression which states the number and type of atoms present in a molecule of a substance.

Short Display An expression which states the number and type of atoms present in a molecule of a substance
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.structure.molecularFormulaByMoiety
Definition

Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.

Short Display Specified per moiety according to the Hill system
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.structure.molecularWeight
Definition

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Short Display The molecular weight or weight range
Cardinality 0..1
Type See SubstanceDefinition.molecularWeight
Summary true
Element Id SubstanceDefinition.structure.technique
Definition

The method used to elucidate the structure of the drug substance. Examples: X-ray, NMR, Peptide mapping, Ligand binding assay.

Short Display The method used to find the structure e.g. X-ray, NMR
Cardinality 0..*
Terminology Binding Structure Technique (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.structure.sourceDocument
Definition

The source of information about the structure.

Short Display Source of information for the structure
Cardinality 0..*
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.structure.representation
Definition

A depiction of the structure of the substance.

Short Display A depiction of the structure of the substance
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.structure.representation.type
Definition

The kind of structural representation (e.g. full, partial).

Short Display The kind of structural representation (e.g. full, partial)
Cardinality 0..1
Terminology Binding Substance Representation Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.structure.representation.representation
Definition

The structural representation as a text string in a standard format.

Short Display The structural representation as a text string in a standard format
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.structure.representation.format
Definition

The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.

Short Display The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)
Cardinality 0..1
Terminology Binding Substance Representation Format (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.structure.representation.document
Definition

An attached file with the structural representation e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.

Short Display An attachment with the structural representation e.g. a structure graphic or AnIML file
Cardinality 0..1
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.code
Definition

Codes associated with the substance.

Short Display Codes associated with the substance
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.code.code
Definition

The specific code.

Short Display The specific code
Cardinality 0..1
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.code.status
Definition

Status of the code assignment, for example 'provisional', 'approved'.

Short Display Status of the code assignment, for example 'provisional', 'approved'
Cardinality 0..1
Terminology Binding PublicationStatus (Preferred)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.code.statusDate
Definition

The date at which the code status was changed as part of the terminology maintenance.

Short Display The date at which the code status was changed
Cardinality 0..1
Type dateTime
Summary true
Element Id SubstanceDefinition.code.note
Definition

Any comment can be provided in this field, if necessary.

Short Display Any comment can be provided in this field
Cardinality 0..*
Type Annotation
Summary true
Element Id SubstanceDefinition.code.source
Definition

Supporting literature.

Short Display Supporting literature
Cardinality 0..*
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.name
Definition

Names applicable to this substance.

Short Display Names applicable to this substance
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.name.name
Definition

The actual name.

Short Display The actual name
Cardinality 1..1
Type string
Summary true
Element Id SubstanceDefinition.name.type
Definition

Name type, for example 'systematic', 'scientific, 'brand'.

Short Display Name type e.g. 'systematic', 'scientific, 'brand'
Cardinality 0..1
Terminology Binding Substance Name Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.status
Definition

The status of the name, for example 'current', 'proposed'.

Short Display The status of the name e.g. 'current', 'proposed'
Cardinality 0..1
Terminology Binding PublicationStatus (Preferred)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.preferred
Definition

If this is the preferred name for this substance.

Short Display If this is the preferred name for this substance
Cardinality 0..1
Type boolean
Meaning if Missing If this value is not present, there is no statement being made about whether this is the preferred name or not. No inference can be made
Summary true
Element Id SubstanceDefinition.name.language
Definition

Human language that the name is written in.

Short Display Human language that the name is written in
Cardinality 0..*
Terminology Binding All Languages (Required)
Additional BindingsPurpose
Common Languages Starter
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.domain
Definition

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

Short Display The use context of this name e.g. as an active ingredient or as a food colour additive
Cardinality 0..*
Terminology Binding Substance Name Domain (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.jurisdiction
Definition

The jurisdiction where this name applies.

Short Display The jurisdiction where this name applies
Cardinality 0..*
Terminology Binding Jurisdiction ValueSet icon (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.synonym
Definition

A synonym of this particular name, by which the substance is also known.

Short Display A synonym of this particular name, by which the substance is also known
Cardinality 0..*
Type See SubstanceDefinition.name
Summary true
Element Id SubstanceDefinition.name.translation
Definition

A translation for this name into another human language.

Short Display A translation for this name into another human language
Cardinality 0..*
Type See SubstanceDefinition.name
Summary true
Element Id SubstanceDefinition.name.official
Definition

Details of the official nature of this name.

Short Display Details of the official nature of this name
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.name.official.authority
Definition

Which authority uses this official name.

Short Display Which authority uses this official name
Cardinality 0..1
Terminology Binding Substance Name Authority (Preferred)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.official.status
Definition

The status of the official name, for example 'draft', 'active', 'retired'.

Short Display The status of the official name, for example 'draft', 'active'
Cardinality 0..1
Terminology Binding PublicationStatus (Preferred)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.name.official.date
Definition

Date of the official name change.

Short Display Date of official name change
Cardinality 0..1
Type dateTime
Summary true
Element Id SubstanceDefinition.name.source
Definition

Supporting literature.

Short Display Supporting literature
Cardinality 0..*
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.relationship
Definition

A link between this substance and another, with details of the relationship.

Short Display A link between this substance and another
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.relationship.substanceDefinition[x]
Definition

A pointer to another substance, as a resource or just a representational code.

Short Display A pointer to another substance, as a resource or a representational code
Cardinality 0..1
Type Reference(SubstanceDefinition)|CodeableConcept
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id SubstanceDefinition.relationship.type
Definition

For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".

Short Display For example "salt to parent", "active moiety"
Cardinality 1..1
Terminology Binding Substance Relationship Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.relationship.isDefining
Definition

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

Short Display For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships
Cardinality 0..1
Type boolean
Meaning if Missing If this value is not present, there is no statement being made about whether this is a defining relationship or not. No inference can be made
Summary true
Element Id SubstanceDefinition.relationship.amount[x]
Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Short Display A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other
Cardinality 0..1
Type Quantity|Ratio|string|Range
[x] Note See Choice of Datatypes for further information about how to use [x]
Summary true
Element Id SubstanceDefinition.relationship.ratioHighLimitAmount
Definition

For use when the numeric has an uncertain range.

Short Display For use when the numeric has an uncertain range
Cardinality 0..1
Type Ratio
Summary true
Element Id SubstanceDefinition.relationship.comparator
Definition

An operator for the amount, for example "average", "approximately", "less than".

Short Display An operator for the amount, for example "average", "approximately", "less than"
Cardinality 0..1
Terminology Binding Substance Amount Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.relationship.measurementType
Definition

The kind of measurement that the amount represents, e.g. an inhibitory concentration (IC50), dissociation constant (Kd), inhibition constant (Ki), or a ratio expressed by mole or by weight.

Short Display The kind of measurement the amount represents (e.g. IC50, Kd, Ki, mole ratio)
Cardinality 0..1
Terminology Binding Substance Measurement Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.relationship.interaction
Definition

For target relationships, the kind of interaction between the substance and its target.

Short Display For target relationships, the kind of interaction (e.g. binding, inhibition, agonism)
Cardinality 0..1
Terminology Binding Substance Interaction Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.relationship.organism
Definition

For anti-infective target relationships, the specific organism the substance is targeted against (e.g. E. coli, S. aureus). For broad-spectrum agents, organismType may be specified instead.

Short Display For anti-infective target relationships, the specific organism targeted
Cardinality 0..1
Terminology Binding Substance Target Organism (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.relationship.organismType
Definition

For anti-infective target relationships, the high-level type of organism the substance is targeted against (e.g. bacterial, viral, fungal). May be used independently of organism, particularly for broad-spectrum agents.

Short Display For anti-infective target relationships, the high-level type of organism targeted
Cardinality 0..1
Terminology Binding Substance Target Organism Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.relationship.source
Definition

Supporting literature.

Short Display Supporting literature
Cardinality 0..*
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.sourceMaterial
Definition

Material or taxonomic/anatomical source for the substance.

Short Display Material or taxonomic/anatomical source
Cardinality 0..1
Summary true
Element Id SubstanceDefinition.sourceMaterial.type
Definition

A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type.

Short Display Classification of the origin of the raw material. e.g. cat hair is an Animal source type
Cardinality 0..1
Terminology Binding Source Material Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.sourceMaterial.genus
Definition

The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.

Short Display The genus of an organism e.g. the Latin epithet of the plant/animal scientific name
Cardinality 0..1
Terminology Binding Source Material Genus (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.sourceMaterial.species
Definition

The species of an organism, typically referring to the Latin epithet of the species of the plant/animal.

Short Display The species of an organism e.g. the Latin epithet of the species of the plant/animal
Cardinality 0..1
Terminology Binding Source Material Species (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.sourceMaterial.part
Definition

An anatomical origin of the source material within an organism.

Short Display An anatomical origin of the source material within an organism
Cardinality 0..1
Terminology Binding Source Material Part (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.sourceMaterial.countryOfOrigin
Definition

The country or countries where the material is harvested.

Short Display The country or countries where the material is harvested
Cardinality 0..*
Terminology Binding Country ValueSet (Required)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid
Definition

Data items specific to nucleic acids.

Short Display Data items specific to nucleic acids
Cardinality 0..1
Summary false
Element Id SubstanceDefinition.nucleicAcid.sequenceType
Definition

The type of the sequence (e.g. DNA, RNA).

Short Display The type of the sequence (e.g. DNA, RNA)
Cardinality 0..1
Terminology Binding Substance Sequence Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid.numberOfSubunits
Definition

The number of subunits — strands of nucleic acid that are tightly associated typically through Watson-Crick base pairing.

Short Display The number of subunits — strands of nucleic acid that are tightly associated typically through Watson-Crick base pairing
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.nucleicAcid.areaOfHybridisation
Definition

The area of hybridisation, for double-stranded RNA or DNA. Expressed as the subunit number followed by the residue number, in increasing order.

Short Display The area of hybridisation, for double-stranded RNA or DNA. Expressed as the subunit number followed by the residue number, in increasing order
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.nucleicAcid.oligoNucleotideType
Definition

The class of oligonucleotide, where relevant (e.g. antisense, siRNA, aptamer).

Short Display Type or class of the oligonucleotide
Cardinality 0..1
Terminology Binding Oligonucleotide Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit
Definition

A subunit constituting the nucleic acid. Subunits are listed in decreasing length order; ties are ordered by molecular weight; identical sequences are repeated.

Short Display A subunit constituting the nucleic acid
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.subunit
Definition

Index of the subunit. Subunits are numbered in decreasing length order, with ties broken by molecular weight.

Short Display Index of the subunit in decreasing length order
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.sequence
Definition

The nucleotide sequence in 5’→3’ notation using standard single-letter codes. Sugar and linkage type may be expressed alongside, via .sugar and .linkage.

Short Display The nucleotide sequence in 5’→3’ notation using standard single-letter codes
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.length
Definition

The length of the sequence.

Short Display The length of the sequence
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.sequenceAttachment
Definition

The sequence provided as an attached file (e.g. when too long for inline capture).

Short Display The sequence as an attached file
Cardinality 0..1
Type Attachment
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.fivePrime
Definition

The nucleotide present at the 5’ terminus. Since the sequence is represented 5’→3’, this is the first nucleotide in the sequence.

Short Display The nucleotide present at the 5’ terminus. Since the sequence is represented 5’→3’, this is the first nucleotide in the sequence
Cardinality 0..1
Terminology Binding Nucleotide Terminus (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.threePrime
Definition

The nucleotide present at the 3’ terminus. Since the sequence is represented 5’→3’, this is the last nucleotide in the sequence.

Short Display The nucleotide present at the 3’ terminus. Since the sequence is represented 5’→3’, this is the last nucleotide in the sequence
Cardinality 0..1
Terminology Binding Nucleotide Terminus (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.linkage
Definition

The linkages between sugar residues in the nucleotide sequence.

Short Display The linkages between sugar residues in the nucleotide sequence
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.linkage.connectivity
Definition

The chemistry of the linkage. For naturally occurring nucleic acids the linkage is usually a phosphate group; synthetic oligonucleotides may use phosphorothioate or other modified linkages. Linkage connectivity defaults to 3’-5’; 3’-3’ or 5’-5’ should be stated explicitly.

Short Display The chemistry of the linkage
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.linkage.substance
Definition

The substance representing the linkage, expressed as a code or a reference to its SubstanceDefinition. Each linkage is registered as a fragment. Reference.identifier may be used to carry an external ID (e.g. ISO 11238 Substance ID) when no resolvable URL is available.

Short Display The linkage substance, as a code or a reference to its SubstanceDefinition
Cardinality 0..1
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.linkage.residueSite
Definition

The residue positions at which this linkage applies, listed in 5’→3’ direction consistent with the base sequence.

Short Display The residue positions at which this linkage applies, in 5’→3’ direction
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.sugar
Definition

A sugar component of the nucleotide sequence, identifying the sugar substance and the residue positions to which it applies.

Short Display A sugar component of the nucleotide sequence
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.sugar.substance
Definition

The substance representing the sugar (or sugar-like component) of the nucleotide, expressed as a code or a reference to its SubstanceDefinition. Reference.identifier may be used to carry an external ID (e.g. ISO 11238 Substance ID) when no resolvable URL is available.

Short Display The sugar substance, as a code or a reference to its SubstanceDefinition
Cardinality 0..1
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.nucleicAcid.subunit.sugar.residueSite
Definition

The residue positions at which this sugar applies, listed in 5’→3’ direction consistent with the base sequence.

Short Display The residue positions at which this sugar applies, in 5’→3’ direction
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.nucleicAcid.gene
Definition

The gene that codes for this substance (typically applies to proteins and nucleic acids). Captures the gene's identity and the source organism or lineage of the gene sequence (e.g. humanised mouse, chimeric mouse-human).

Short Display The gene that codes for this substance
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.nucleicAcid.gene.sequenceOrigin
Definition

The species or lineage from which the gene sequence originated (e.g. human, humanised mouse, chimeric mouse-human, bacterial). For recombinant biologics, this is distinct from the production source organism.

Short Display The species or lineage from which the gene sequence originated
Cardinality 0..1
Terminology Binding Gene Sequence Origin (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid.gene.gene
Definition

The gene itself, expressed as a code or as a reference to the SubstanceDefinition describing the gene as a nucleic acid. Reference.identifier may be used to carry an external ID (e.g. NCBI Gene, HGNC symbol) when no resolvable URL is available.

Short Display The gene itself, as a code or a reference to a SubstanceDefinition
Cardinality 0..1
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.nucleicAcid.gene.source
Definition

Supporting literature for the gene information.

Short Display Supporting literature for the gene information
Cardinality 0..*
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.nucleicAcid.geneElement
Definition

Information about the functional elements (promoter, enhancer, coding sequence, terminator, etc.) that make up a nucleic acid construct used in gene therapy. Each element captures its role and identity.

Short Display Gene elements that comprise a nucleic acid construct (used for gene therapy)
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.nucleicAcid.geneElement.type
Definition

The functional role of the element within the construct, for example promoter, enhancer, silencer, terminator, or coding sequence.

Short Display The functional role of the element (e.g. promoter, enhancer, coding sequence)
Cardinality 0..1
Terminology Binding Gene Element Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.nucleicAcid.geneElement.element
Definition

The element itself, expressed as a code or as a reference to a SubstanceDefinition describing the element as a nucleic acid substance. Reference.identifier may be used to carry an external ID (e.g. addgene plasmid ID, NCBI accession) when no resolvable URL is available.

Short Display The element itself, as a code or a reference to a SubstanceDefinition
Cardinality 0..1
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.nucleicAcid.geneElement.source
Definition

Supporting literature for the gene element information.

Short Display Supporting literature for the gene element information
Cardinality 0..*
Type Reference(DocumentReference)
Summary true
Element Id SubstanceDefinition.polymer
Definition

Data items specific to polymers.

Short Display Data items specific to polymers
Cardinality 0..1
Summary false
Element Id SubstanceDefinition.polymer.class
Definition

Overall type of the polymer.

Short Display Overall type of the polymer
Cardinality 0..1
Terminology Binding Polymer Class (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.geometry
Definition

Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic.

Short Display Polymer geometry, e.g. linear, branched, cross-linked, network or dendritic
Cardinality 0..1
Terminology Binding Polymer Geometry (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.copolymerConnectivity
Definition

Describes the copolymer sequence type (polymer connectivity).

Short Display Describes the copolymer sequence type (polymer connectivity)
Cardinality 0..*
Terminology Binding Copolymer Connectivity (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.modification
Definition

A modification applied to the polymer, e.g. a chemical reaction that alters the structure post-polymerisation.

Short Display A modification applied to the polymer
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.polymer.monomerSet
Definition

A set of monomers used to build the polymer, with their proportions and relationships.

Short Display A set of monomers used to build the polymer
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.polymer.monomerSet.ratioType
Definition

Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio.

Short Display Captures the type of ratio to the entire polymer, e.g. Monomer/Polymer ratio, SRU/Polymer Ratio
Cardinality 0..1
Terminology Binding Polymer Monomer Ratio Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.monomerSet.startingMaterial
Definition

The starting materials - monomer(s) used in the synthesis of the polymer.

Short Display The starting materials - monomer(s) used in the synthesis of the polymer
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.polymer.monomerSet.startingMaterial.code
Definition

The substance acting as starting material. This may be specified as a code or as a reference to another SubstanceDefinition.

Short Display The substance acting as starting material, as a code or a reference to a SubstanceDefinition
Cardinality 0..1
Terminology Binding Substance Code (Example)
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.polymer.monomerSet.startingMaterial.category
Definition

Substance high level category, e.g. chemical substance.

Short Display Substance high level category, e.g. chemical substance
Cardinality 0..1
Terminology Binding Polymer Starting Material Category (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.monomerSet.startingMaterial.isDefining
Definition

Whether this starting material is part of what defines the polymer's unique identity.

Short Display Whether this starting material is part of what defines the polymer's unique identity
Cardinality 0..1
Type boolean
Summary true
Element Id SubstanceDefinition.polymer.monomerSet.startingMaterial.amount
Definition

A percentage.

Short Display A percentage
Cardinality 0..1
Type Quantity
Summary true
Element Id SubstanceDefinition.polymer.repeat
Definition

Specifies and quantifies the repeated units and their configuration.

Short Display Specifies and quantifies the repeated units and their configuration
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.polymer.repeat.averageMolecularFormula
Definition

A representation of an (average) molecular formula from a polymer.

Short Display A representation of an (average) molecular formula from a polymer
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnitAmountType
Definition

How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average).

Short Display How the quantitative amount of Structural Repeat Units is captured (e.g. Exact, Numeric, Average)
Cardinality 0..1
Terminology Binding Polymer Monomer Ratio Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit
Definition

An SRU - Structural Repeat Unit.

Short Display An SRU - Structural Repeat Unit
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.unit
Definition

Identification of the structural repeat unit (SRU).

Short Display Identification of the structural repeat unit (SRU)
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.orientation
Definition

The orientation of the polymerisation, e.g. head-tail, head-head, random.

Short Display The orientation of the polymerisation, e.g. head-tail, head-head, random
Cardinality 0..1
Terminology Binding Polymerisation Orientation (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.amount
Definition

Number of repeats of this unit.

Short Display Number of repeats of this unit
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.degreeOfPolymerisation
Definition

Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described.

Short Display Applies to homopolymer and block co-polymers where the degree of polymerisation within a block can be described
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.degreeOfPolymerisation.type
Definition

The type of degree of polymerisation, e.g. SRU/Polymer ratio.

Short Display The type of degree of polymerisation, e.g. SRU/Polymer ratio
Cardinality 0..1
Terminology Binding Degree of Polymerisation Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.degreeOfPolymerisation.average
Definition

An average amount of polymerisation.

Short Display An average amount of polymerisation
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.degreeOfPolymerisation.low
Definition

A low expected limit of the amount.

Short Display A low expected limit of the amount
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.degreeOfPolymerisation.high
Definition

A high expected limit of the amount.

Short Display A high expected limit of the amount
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.polymer.repeat.repeatUnit.structuralRepresentation
Definition

A graphical structure for this SRU.

Short Display A graphical structure for this SRU
Cardinality 0..*
Type See SubstanceDefinition.structure.representation
Summary true
Element Id SubstanceDefinition.protein
Definition

Data items specific to proteins.

Short Display Data items specific to proteins
Cardinality 0..1
Summary false
Element Id SubstanceDefinition.protein.sequenceType
Definition

Whether the sequence provided is complete or partial.

Short Display Whether the sequence is complete or partial
Cardinality 0..1
Terminology Binding Substance Sequence Type (Example)
Type CodeableConcept
Summary true
Element Id SubstanceDefinition.protein.numberOfSubunits
Definition

Number of subunits — linear sequences of amino acids linked through peptide bonds.

Short Display Number of subunits — linear sequences of amino acids linked through peptide bonds
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.protein.disulfideLinkage
Definition

Disulphide bond(s) between cysteine residues on the same subunit or across two different subunits. Positions are listed in increasing order of subunit number and intra-subunit position, followed by the amino-acid abbreviations. The positions should contain Cysteine residues.

Short Display Disulphide bond(s) between cysteine residues on the same subunit or across two different subunits. Positions are listed in increasing order of subunit number and intra-subunit position, followed by the amino-acid abbreviations. The positions should contain Cysteine residues
Cardinality 0..*
Type string
Summary true
Element Id SubstanceDefinition.protein.subunit
Definition

Each subunit constituting the protein. A subunit is a linear sequence of amino acids linked through peptide bonds. Used when the finished protein is a complex of multiple sequences (not for domains within a single sequence). Subunits are listed in order of decreasing length; ties resolved by decreasing molecular weight; identical sequences are repeated.

Short Display Each subunit constituting the protein. A subunit is a linear sequence of amino acids linked through peptide bonds. Used when the finished protein is a complex of multiple sequences (not for domains within a single sequence). Subunits are listed in order of decreasing length; ties resolved by decreasing molecular weight; identical sequences are repeated
Cardinality 0..*
Summary true
Element Id SubstanceDefinition.protein.subunit.subunit
Definition

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.

Short Display 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
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.protein.subunit.sequence
Definition

The amino-acid sequence, listed N- to C-terminal using standard single-letter amino-acid codes. Uppercase denotes L-amino acids, lowercase denotes D-amino acids. Transcribed proteins are described using the translated sequence; for synthetic peptides containing amino acids without a single-letter code, X is used. Modified amino acids are identified by their position in the sequence.

Short Display The amino-acid sequence, listed N- to C-terminal using standard single-letter amino-acid codes. Uppercase denotes L-amino acids, lowercase denotes D-amino acids. Transcribed proteins are described using the translated sequence; for synthetic peptides containing amino acids without a single-letter code, X is used. Modified amino acids are identified by their position in the sequence
Cardinality 0..1
Type string
Summary true
Element Id SubstanceDefinition.protein.subunit.length
Definition

Length of linear sequences of amino acids contained in the subunit.

Short Display Length of linear sequences of amino acids contained in the subunit
Cardinality 0..1
Type integer
Summary true
Element Id SubstanceDefinition.protein.subunit.sequenceAttachment
Definition

The amino-acid sequence provided as an attached file (e.g. when too long for inline capture, or only available in non-text form such as an image).

Short Display The amino-acid sequence as an attached file
Cardinality 0..1
Type Attachment
Summary true
Element Id SubstanceDefinition.protein.subunit.nTerminalModification
Definition

The molecular fragment modification at the N-terminal of the protein, expressed as a code or a reference to its SubstanceDefinition. Reference.identifier may be used to carry an external ID (e.g. ISO 11238 Substance ID) when no resolvable URL is available.

Short Display The modification fragment at the N-terminal of the protein
Cardinality 0..1
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.protein.subunit.cTerminalModification
Definition

The molecular fragment modification at the C-terminal of the protein, expressed as a code or a reference to its SubstanceDefinition. Reference.identifier may be used to carry an external ID (e.g. ISO 11238 Substance ID) when no resolvable URL is available.

Short Display The modification fragment at the C-terminal of the protein
Cardinality 0..1
Type CodeableReference(SubstanceDefinition)
Summary true
Element Id SubstanceDefinition.protein.gene
Definition

The gene that codes for this protein substance (typically the source gene). Captures the gene's identity and the source organism or lineage of the gene sequence (e.g. humanised mouse, chimeric mouse-human). Same structure as nucleicAcid.gene.

Short Display The gene that codes for this substance
Cardinality 0..*
Type See SubstanceDefinition.nucleicAcid.gene
Summary true