R4 Ballot #1 #2 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: (v3.5.0: R4 Ballot 2). #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 Group Maturity Level : 0   Draft Trial Use Compartments : Not linked to any defined compartments

Detailed Descriptions for the elements in the SubstanceSpecification resource.

SubstanceSpecification
Element Id SubstanceSpecification
Definition

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

Control 1..1
Type DomainResource
Summary true
SubstanceSpecification.comment
Element Id SubstanceSpecification.comment
Definition

Textual comment.

Control 0..1
Type string
Summary true
SubstanceSpecification.stoichiometric
Element Id SubstanceSpecification.stoichiometric
Definition

Chemicals may be stoichiometric or non-stoichiometric.

Control 0..1
Type boolean
Summary true
SubstanceSpecification.identifier
Element Id SubstanceSpecification.identifier
Definition

Identifier by which this substance is known.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..1
Type Identifier
Summary true
SubstanceSpecification.type
Element Id SubstanceSpecification.type
Definition

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

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.referenceSource
Element Id SubstanceSpecification.referenceSource
Definition

Supporting literature.

Control 0..*
Type string
Summary true
SubstanceSpecification.moiety
Element Id SubstanceSpecification.moiety
Definition

Moiety, for structural modifications.

Control 0..*
Summary true
SubstanceSpecification.moiety.role
Element Id SubstanceSpecification.moiety.role
Definition

Role that the moiety is playing.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.moiety.identifier
Element Id SubstanceSpecification.moiety.identifier
Definition

Identifier by which this moiety substance is known.

Note This is a business identifer, not a resource identifier (see discussion )
Control 0..1
Type Identifier
Summary true
SubstanceSpecification.moiety.name
Element Id SubstanceSpecification.moiety.name
Definition

Textual name for this moiety substance.

Control 0..1
Type string
Summary true
SubstanceSpecification.moiety.stereochemistry
Element Id SubstanceSpecification.moiety.stereochemistry
Definition

Stereochemistry type.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.moiety.opticalActivity
Element Id SubstanceSpecification.moiety.opticalActivity
Definition

Optical activity type.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.moiety.molecularFormula
Element Id SubstanceSpecification.moiety.molecularFormula
Definition

Molecular formula.

Control 0..1
Type string
Summary true
SubstanceSpecification.moiety.amount
Element Id SubstanceSpecification.moiety.amount
Definition

Quantitative value for this moiety.

Control 0..1
Type string
Summary true
SubstanceSpecification.property
Element Id SubstanceSpecification.property
Definition

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

Control 0..*
Summary true
SubstanceSpecification.property.type
Element Id SubstanceSpecification.property.type
Definition

Description todo.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.property.name
Element Id SubstanceSpecification.property.name
Definition

Description todo.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.property.parameters
Element Id SubstanceSpecification.property.parameters
Definition

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

Control 0..1
Type string
Summary true
SubstanceSpecification.property.substanceId
Element Id SubstanceSpecification.property.substanceId
Definition

Identifier for a substance upon which a defining property depends.

Control 0..1
Type Identifier
Summary true
SubstanceSpecification.property.substanceName
Element Id SubstanceSpecification.property.substanceName
Definition

Description todo.

Control 0..1
Type string
Summary true
SubstanceSpecification.property.amount
Element Id SubstanceSpecification.property.amount
Definition

Quantitative value for this property.

Control 0..1
Type string
Summary true
SubstanceSpecification.referenceInformation
Element Id SubstanceSpecification.referenceInformation
Definition

General information detailing this substance.

Control 0..1
Type Reference ( SubstanceReferenceInformation )
Summary true
SubstanceSpecification.structure
Element Id SubstanceSpecification.structure
Definition

Structural information.

Control 0..1
Summary true
SubstanceSpecification.structure.stereochemistry
Element Id SubstanceSpecification.structure.stereochemistry
Definition

Stereochemistry type.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.opticalActivity
Element Id SubstanceSpecification.structure.opticalActivity
Definition

Optical activity type.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.molecularFormula
Element Id SubstanceSpecification.structure.molecularFormula
Definition

Molecular formula.

Control 0..1
Type string
Summary true
SubstanceSpecification.structure.molecularFormulaByMoiety
Element Id SubstanceSpecification.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.

Control 0..1
Type string
Summary true
SubstanceSpecification.structure.isotope
Element Id SubstanceSpecification.structure.isotope
Definition

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

Control 0..*
Summary true
SubstanceSpecification.structure.isotope.nuclideId
Element Id SubstanceSpecification.structure.isotope.nuclideId
Definition

Substance identifier for each non-natural or radioisotope.

Control 0..1
Type Identifier
Summary true
SubstanceSpecification.structure.isotope.nuclideName
Element Id SubstanceSpecification.structure.isotope.nuclideName
Definition

Substance name for each non-natural or radioisotope.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.isotope.substitutionType
Element Id SubstanceSpecification.structure.isotope.substitutionType
Definition

The type of isotopic substitution present in a single substance.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.isotope.nuclideHalfLife
Element Id SubstanceSpecification.structure.isotope.nuclideHalfLife
Definition

Half life - for a non-natural nuclide.

Control 0..1
Type Quantity
Summary true
SubstanceSpecification.structure.isotope.amount
Element Id SubstanceSpecification.structure.isotope.amount
Definition

Quantitative values for this isotope.

Control 0..1
Type string
Summary true
SubstanceSpecification.structure.isotope.molecularWeight
Element Id SubstanceSpecification.structure.isotope.molecularWeight
Definition

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

Control 0..1
Summary true
SubstanceSpecification.structure.isotope.molecularWeight.method
Element Id SubstanceSpecification.structure.isotope.molecularWeight.method
Definition

The method by which the molecular weight was determined.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.isotope.molecularWeight.type
Element Id SubstanceSpecification.structure.isotope.molecularWeight.type
Definition

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

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.isotope.molecularWeight.amount
Element Id SubstanceSpecification.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.

Control 0..1
Type string
Summary true
SubstanceSpecification.structure.molecularWeight
Element Id SubstanceSpecification.structure.molecularWeight
Definition

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

Control 0..1
Type See SubstanceSpecification.structure.isotope.molecularWeight
Summary true
SubstanceSpecification.structure.referenceSource
Element Id SubstanceSpecification.structure.referenceSource
Definition

Supporting literature.

Control 0..*
Type Reference ( DocumentReference )
Summary true
SubstanceSpecification.structure.structuralRepresentation
Element Id SubstanceSpecification.structure.structuralRepresentation
Definition

Molectular structural representation.

Control 0..*
Summary true
SubstanceSpecification.structure.structuralRepresentation.type
Element Id SubstanceSpecification.structure.structuralRepresentation.type
Definition

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

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.structure.structuralRepresentation.representation
Element Id SubstanceSpecification.structure.structuralRepresentation.representation
Definition

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

Control 0..1
Type string
Summary true
SubstanceSpecification.structure.structuralRepresentation.attachment
Element Id SubstanceSpecification.structure.structuralRepresentation.attachment
Definition

An attached file with the structural representation.

Control 0..1
Type Attachment
Summary true
SubstanceSpecification.substanceCode
Element Id SubstanceSpecification.substanceCode
Definition

Codes associated with the substance.

Control 0..*
Summary true
SubstanceSpecification.substanceCode.code
Element Id SubstanceSpecification.substanceCode.code
Definition

The specific code.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.substanceCode.status
Element Id SubstanceSpecification.substanceCode.status
Definition

Status of the code assignment.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.substanceCode.statusDate
Element Id SubstanceSpecification.substanceCode.statusDate
Definition

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

Control 0..1
Type dateTime
Summary true
SubstanceSpecification.substanceCode.comment
Element Id SubstanceSpecification.substanceCode.comment
Definition

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

Control 0..1
Type string
Summary true
SubstanceSpecification.substanceCode.referenceSource
Element Id SubstanceSpecification.substanceCode.referenceSource
Definition

Supporting literature.

Control 0..*
Type string
Summary true
SubstanceSpecification.substanceName
Element Id SubstanceSpecification.substanceName
Definition

Names applicable to this substence.

Control 0..*
Summary true
SubstanceSpecification.substanceName.name
Element Id SubstanceSpecification.substanceName.name
Definition

The actual name.

Control 0..1
Type string
Summary true
SubstanceSpecification.substanceName.type
Element Id SubstanceSpecification.substanceName.type
Definition

Name type.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.substanceName.language
Element Id SubstanceSpecification.substanceName.language
Definition

Language of the name.

Control 0..*
Type CodeableConcept
Summary true
SubstanceSpecification.substanceName.domain
Element Id SubstanceSpecification.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.

Control 0..*
Type CodeableConcept
Summary true
SubstanceSpecification.substanceName.jurisdiction
Element Id SubstanceSpecification.substanceName.jurisdiction
Definition

The jurisdiction where this name applies.

Control 0..*
Type CodeableConcept
Summary true
SubstanceSpecification.substanceName.officialName
Element Id SubstanceSpecification.substanceName.officialName
Definition

Details of the official nature of this name.

Control 0..*
Summary true
SubstanceSpecification.substanceName.officialName.authority
Element Id SubstanceSpecification.substanceName.officialName.authority
Definition

Which authority uses this official name.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.substanceName.officialName.status
Element Id SubstanceSpecification.substanceName.officialName.status
Definition

The status of the official name.

Control 0..1
Type CodeableConcept
Summary true
SubstanceSpecification.substanceName.officialName.date
Element Id SubstanceSpecification.substanceName.officialName.date
Definition

Date of official name change.

Control 0..1
Type dateTime
Summary true
SubstanceSpecification.substanceName.referenceSource
Element Id SubstanceSpecification.substanceName.referenceSource
Definition

Supporting literature.

Control 0..*
Type string
Summary true
SubstanceSpecification.molecularWeight
Element Id SubstanceSpecification.molecularWeight
Definition

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

Control 0..*
Type See SubstanceSpecification.structure.isotope.molecularWeight
Summary true
SubstanceSpecification.polymer
Element Id SubstanceSpecification.polymer
Definition

Data items specific to polymers.

Control 0..1
Type Reference ( SubstancePolymer )
Summary true