R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Biomedical Research and Regulation Work GroupMaturity Level: 0 Draft Compartments: Not linked to any defined compartments

Detailed Descriptions for the elements in the SubstanceSpecification resource.

SubstanceSpecification
Element IdSubstanceSpecification
Definition

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

Control1..1
Summarytrue
SubstanceSpecification.comment
Element IdSubstanceSpecification.comment
Definition

Textual comment.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.stoichiometric
Element IdSubstanceSpecification.stoichiometric
Definition

Chemicals may be stoichiometric or non-stoichiometric.

Control0..1
Typeboolean
Summarytrue
SubstanceSpecification.identifier
Element IdSubstanceSpecification.identifier
Definition

Identifier by which this substance is known.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
SubstanceSpecification.type
Element IdSubstanceSpecification.type
Definition

High level categorization, e.g. polymer or nucleic acid.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.referenceSource
Element IdSubstanceSpecification.referenceSource
Definition

Supporting literature.

Control0..*
Typestring
Summarytrue
SubstanceSpecification.moiety
Element IdSubstanceSpecification.moiety
Definition

Moiety, for structural modifications.

Control0..*
Summarytrue
SubstanceSpecification.moiety.role
Element IdSubstanceSpecification.moiety.role
Definition

Role that the moiety is playing.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.moiety.identifier
Element IdSubstanceSpecification.moiety.identifier
Definition

Identifier by which this moiety substance is known.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Summarytrue
SubstanceSpecification.moiety.name
Element IdSubstanceSpecification.moiety.name
Definition

Textual name for this moiety substance.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.moiety.stereochemistry
Element IdSubstanceSpecification.moiety.stereochemistry
Definition

Stereochemistry type.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.moiety.opticalActivity
Element IdSubstanceSpecification.moiety.opticalActivity
Definition

Optical activity type.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.moiety.molecularFormula
Element IdSubstanceSpecification.moiety.molecularFormula
Definition

Molecular formula.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.moiety.amount
Element IdSubstanceSpecification.moiety.amount
Definition

Quantitative value for this moiety.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.property
Element IdSubstanceSpecification.property
Definition

General specifications for this substance, including how it is related to other substances.

Control0..*
Summarytrue
SubstanceSpecification.property.type
Element IdSubstanceSpecification.property.type
Definition

Description todo.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.property.name
Element IdSubstanceSpecification.property.name
Definition

Description todo.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.property.parameters
Element IdSubstanceSpecification.property.parameters
Definition

A field that should be used to capture parameters that were used in the measurement of a property.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.property.substanceId
Element IdSubstanceSpecification.property.substanceId
Definition

Identifier for a substance upon which a defining property depends.

Control0..1
TypeIdentifier
Summarytrue
SubstanceSpecification.property.substanceName
Element IdSubstanceSpecification.property.substanceName
Definition

Description todo.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.property.amount
Element IdSubstanceSpecification.property.amount
Definition

Quantitative value for this property.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.referenceInformation
Element IdSubstanceSpecification.referenceInformation
Definition

General information detailing this substance.

Control0..1
TypeReference(SubstanceReferenceInformation)
Summarytrue
SubstanceSpecification.structure
Element IdSubstanceSpecification.structure
Definition

Structural information.

Control0..1
Summarytrue
SubstanceSpecification.structure.stereochemistry
Element IdSubstanceSpecification.structure.stereochemistry
Definition

Stereochemistry type.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.opticalActivity
Element IdSubstanceSpecification.structure.opticalActivity
Definition

Optical activity type.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.molecularFormula
Element IdSubstanceSpecification.structure.molecularFormula
Definition

Molecular formula.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.structure.molecularFormulaByMoiety
Element IdSubstanceSpecification.structure.molecularFormulaByMoiety
Definition

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

Control0..1
Typestring
Summarytrue
SubstanceSpecification.structure.isotope
Element IdSubstanceSpecification.structure.isotope
Definition

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.

Control0..*
Summarytrue
SubstanceSpecification.structure.isotope.nuclideId
Element IdSubstanceSpecification.structure.isotope.nuclideId
Definition

Substance identifier for each non-natural or radioisotope.

Control0..1
TypeIdentifier
Summarytrue
SubstanceSpecification.structure.isotope.nuclideName
Element IdSubstanceSpecification.structure.isotope.nuclideName
Definition

Substance name for each non-natural or radioisotope.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.isotope.substitutionType
Element IdSubstanceSpecification.structure.isotope.substitutionType
Definition

The type of isotopic substitution present in a single substance.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.isotope.nuclideHalfLife
Element IdSubstanceSpecification.structure.isotope.nuclideHalfLife
Definition

Half life - for a non-natural nuclide.

Control0..1
TypeQuantity
Summarytrue
SubstanceSpecification.structure.isotope.amount
Element IdSubstanceSpecification.structure.isotope.amount
Definition

Quantitative values for this isotope.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.structure.isotope.molecularWeight
Element IdSubstanceSpecification.structure.isotope.molecularWeight
Definition

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

Control0..1
Summarytrue
SubstanceSpecification.structure.isotope.molecularWeight.method
Element IdSubstanceSpecification.structure.isotope.molecularWeight.method
Definition

The method by which the molecular weight was determined.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.isotope.molecularWeight.type
Element IdSubstanceSpecification.structure.isotope.molecularWeight.type
Definition

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

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.isotope.molecularWeight.amount
Element IdSubstanceSpecification.structure.isotope.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.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.structure.molecularWeight
Element IdSubstanceSpecification.structure.molecularWeight
Definition

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

Control0..1
TypeSee SubstanceSpecification.structure.isotope.molecularWeight
Summarytrue
SubstanceSpecification.structure.referenceSource
Element IdSubstanceSpecification.structure.referenceSource
Definition

Supporting literature.

Control0..*
TypeReference(DocumentReference)
Summarytrue
SubstanceSpecification.structure.structuralRepresentation
Element IdSubstanceSpecification.structure.structuralRepresentation
Definition

Molectular structural representation.

Control0..*
Summarytrue
SubstanceSpecification.structure.structuralRepresentation.type
Element IdSubstanceSpecification.structure.structuralRepresentation.type
Definition

The type of structure (e.g. Full, Partial, Representative).

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.structure.structuralRepresentation.representation
Element IdSubstanceSpecification.structure.structuralRepresentation.representation
Definition

The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.structure.structuralRepresentation.attachment
Element IdSubstanceSpecification.structure.structuralRepresentation.attachment
Definition

An attached file with the structural representation.

Control0..1
TypeAttachment
Summarytrue
SubstanceSpecification.substanceCode
Element IdSubstanceSpecification.substanceCode
Definition

Codes associated with the substance.

Control0..*
Summarytrue
SubstanceSpecification.substanceCode.code
Element IdSubstanceSpecification.substanceCode.code
Definition

The specific code.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceCode.status
Element IdSubstanceSpecification.substanceCode.status
Definition

Status of the code assignment.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceCode.statusDate
Element IdSubstanceSpecification.substanceCode.statusDate
Definition

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

Control0..1
TypedateTime
Summarytrue
SubstanceSpecification.substanceCode.comment
Element IdSubstanceSpecification.substanceCode.comment
Definition

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

Control0..1
Typestring
Summarytrue
SubstanceSpecification.substanceCode.referenceSource
Element IdSubstanceSpecification.substanceCode.referenceSource
Definition

Supporting literature.

Control0..*
Typestring
Summarytrue
SubstanceSpecification.substanceName
Element IdSubstanceSpecification.substanceName
Definition

Names applicable to this substence.

Control0..*
Summarytrue
SubstanceSpecification.substanceName.name
Element IdSubstanceSpecification.substanceName.name
Definition

The actual name.

Control0..1
Typestring
Summarytrue
SubstanceSpecification.substanceName.type
Element IdSubstanceSpecification.substanceName.type
Definition

Name type.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceName.language
Element IdSubstanceSpecification.substanceName.language
Definition

Language of the name.

Control0..*
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceName.domain
Element IdSubstanceSpecification.substanceName.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.

Control0..*
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceName.jurisdiction
Element IdSubstanceSpecification.substanceName.jurisdiction
Definition

The jurisdiction where this name applies.

Control0..*
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceName.officialName
Element IdSubstanceSpecification.substanceName.officialName
Definition

Details of the official nature of this name.

Control0..*
Summarytrue
SubstanceSpecification.substanceName.officialName.authority
Element IdSubstanceSpecification.substanceName.officialName.authority
Definition

Which authority uses this official name.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceName.officialName.status
Element IdSubstanceSpecification.substanceName.officialName.status
Definition

The status of the official name.

Control0..1
TypeCodeableConcept
Summarytrue
SubstanceSpecification.substanceName.officialName.date
Element IdSubstanceSpecification.substanceName.officialName.date
Definition

Date of official name change.

Control0..1
TypedateTime
Summarytrue
SubstanceSpecification.substanceName.referenceSource
Element IdSubstanceSpecification.substanceName.referenceSource
Definition

Supporting literature.

Control0..*
Typestring
Summarytrue
SubstanceSpecification.molecularWeight
Element IdSubstanceSpecification.molecularWeight
Definition

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

Control0..*
TypeSee SubstanceSpecification.structure.isotope.molecularWeight
Summarytrue
SubstanceSpecification.polymer
Element IdSubstanceSpecification.polymer
Definition

Data items specific to polymers.

Control0..1
TypeReference(SubstancePolymer)
Summarytrue