SubstanceSpecification

ResourceSpecialized · Medication DefinitionTrial useMaturity 0

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

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

1 of 1 parameters tested

Structure

Show inherited elements (38)

Element	Card.	Type	Description
identifierΣ	0..1	Identifier	Identifier by which this substance is known
typeΣ	0..1	CodeableConcept	High level categorization, e.g. polymer or nucleic acid
statusΣ	0..1	CodeableConcept	Status of substance within the catalogue e.g. approved
domainΣ	0..1	CodeableConcept	If the substance applies to only human or veterinary use
descriptionΣ	0..1	string	Textual description of the substance
sourceΣ	0..*	Reference(DocumentReference)	Supporting literature
commentΣ	0..1	string	Textual comment about this record of a substance
moietyΣ	0..*	BackboneElement	Moiety, for structural modifications
roleΣ	0..1	CodeableConcept	Role that the moiety is playing
identifierΣ	0..1	Identifier	Identifier by which this moiety substance is known
nameΣ	0..1	string	Textual name for this moiety substance
stereochemistryΣ	0..1	CodeableConcept	Stereochemistry type
opticalActivityΣ	0..1	CodeableConcept	Optical activity type
molecularFormulaΣ	0..1	string	Molecular formula
amount[x]Σ	0..1	Quantity | string	Quantitative value for this moiety
propertyΣ	0..*	BackboneElement	General specifications for this substance, including how it is related to other substances
categoryΣ	0..1	CodeableConcept	A category for this property, e.g. Physical, Chemical, Enzymatic
codeΣ	0..1	CodeableConcept	Property type e.g. viscosity, pH, isoelectric point
parametersΣ	0..1	string	Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1)
definingSubstance[x]Σ	0..1	Reference(SubstanceSpecification | Substance) | CodeableConcept	A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol)
amount[x]Σ	0..1	Quantity | string	Quantitative value for this property
referenceInformationΣ	0..1	Reference(SubstanceReferenceInformation)	General information detailing this substance
structureΣ	0..1	BackboneElement	Structural information
stereochemistryΣ	0..1	CodeableConcept	Stereochemistry type
opticalActivityΣ	0..1	CodeableConcept	Optical activity type
molecularFormulaΣ	0..1	string	Molecular formula
molecularFormulaByMoietyΣ	0..1	string	Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot
isotopeΣ	0..*	BackboneElement	Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio
identifierΣ	0..1	Identifier	Substance identifier for each non-natural or radioisotope
nameΣ	0..1	CodeableConcept	Substance name for each non-natural or radioisotope
substitutionΣ	0..1	CodeableConcept	The type of isotopic substitution present in a single substance
halfLifeΣ	0..1	Quantity	Half life - for a non-natural nuclide
molecularWeightΣ	0..1	BackboneElement	The molecular weight or weight range (for proteins, polymers or nucleic acids)
methodΣ	0..1	CodeableConcept	The method by which the molecular weight was determined
typeΣ	0..1	CodeableConcept	Type of molecular weight such as exact, average (also known as. number average), weight average
amountΣ	0..1	Quantity	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
molecularWeightΣ	0..1	Same as SubstanceSpecification.structure.isotope.molecularWeight	The molecular weight or weight range (for proteins, polymers or nucleic acids)
sourceΣ	0..*	Reference(DocumentReference)	Supporting literature
representationΣ	0..*	BackboneElement	Molecular structural representation
typeΣ	0..1	CodeableConcept	The type of structure (e.g. Full, Partial, Representative)
representationΣ	0..1	string	The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX
attachmentΣ	0..1	Attachment	An attached file with the structural representation
codeΣ	0..*	BackboneElement	Codes associated with the substance
codeΣ	0..1	CodeableConcept	The specific code
statusΣ	0..1	CodeableConcept	Status of the code assignment
statusDateΣ	0..1	dateTime	The date at which the code status is changed as part of the terminology maintenance
commentΣ	0..1	string	Any comment can be provided in this field, if necessary
sourceΣ	0..*	Reference(DocumentReference)	Supporting literature
nameΣ	0..*	BackboneElement	Names applicable to this substance
nameRequiredΣ	1..1	string	The actual name
typeΣ	0..1	CodeableConcept	Name type
statusΣ	0..1	CodeableConcept	The status of the name
preferredΣ	0..1	boolean	If this is the preferred name for this substance
languageΣ	0..*	CodeableConcept	Language of the name
domainΣ	0..*	CodeableConcept	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
jurisdictionΣ	0..*	CodeableConcept	The jurisdiction where this name applies
synonymΣ	0..*	Same as SubstanceSpecification.name	A synonym of this name
translationΣ	0..*	Same as SubstanceSpecification.name	A translation for this name
officialΣ	0..*	BackboneElement	Details of the official nature of this name
authorityΣ	0..1	CodeableConcept	Which authority uses this official name
statusΣ	0..1	CodeableConcept	The status of the official name
dateΣ	0..1	dateTime	Date of official name change
sourceΣ	0..*	Reference(DocumentReference)	Supporting literature
molecularWeightΣ	0..*	Same as SubstanceSpecification.structure.isotope.molecularWeight	The molecular weight or weight range (for proteins, polymers or nucleic acids)
relationshipΣ	0..*	BackboneElement	A link between this substance and another, with details of the relationship
substance[x]Σ	0..1	Reference(SubstanceSpecification) | CodeableConcept	A pointer to another substance, as a resource or just a representational code
relationshipΣ	0..1	CodeableConcept	For example "salt to parent", "active moiety", "starting material"
isDefiningΣ	0..1	boolean	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
amount[x]Σ	0..1	Quantity | Range | Ratio | string	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
amountRatioLowLimitΣ	0..1	Ratio	For use when the numeric
amountTypeΣ	0..1	CodeableConcept	An operator for the amount, for example "average", "approximately", "less than"
sourceΣ	0..*	Reference(DocumentReference)	Supporting literature
nucleicAcidΣ	0..1	Reference(SubstanceNucleicAcid)	Data items specific to nucleic acids
polymerΣ	0..1	Reference(SubstancePolymer)	Data items specific to polymers
proteinΣ	0..1	Reference(SubstanceProtein)	Data items specific to proteins
sourceMaterialΣ	0..1	Reference(SubstanceSourceMaterial)	Material or taxonomic/anatomical source for the substance

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/SubstanceSpecification?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
code	token	The specific code SubstanceSpecification.code.code

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition