UMC IDMP Request and Publish API
1.0.0 - CI Build International flag

UMC IDMP Request and Publish API, published by Uppsala Monitoring Centre. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Uppsala-Monitoring-Centre/WHO-UMC-IDMP-Service/ and changes regularly. See the Directory of published versions

Resource Profile: SubstanceDefinition (publish)

Official URL: http://umcterminologies.org/StructureDefinition/SubstanceDefinition-pub Version: 1.0.0
Active as of 2026-11-03 Computable Name: SubstanceDefinitionPublished

This profile defines how the SubstanceDefinition is published by UMC terminologies

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SubstanceDefinition 0..* SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
SubstanceDefinition.id This element is included in summaries. 1..1 id Logical id of this artifact
SubstanceDefinition.identifier This element is included in summaries. 1..1 Identifier Identifier by which this substance is known
SubstanceDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
SubstanceDefinition.identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.status This element is included in summaries. 1..1 CodeableConcept draft|active|retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.domain This element is included in summaries. 1..1 CodeableConcept If the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
SubstanceDefinition.name This element is included in summaries. 1..* BackboneElement Names applicable to this substance
SubstanceDefinition.name.name This element is included in summaries. 1..1 string The actual name
SubstanceDefinition.name.status This element is included in summaries. 0..1 CodeableConcept name status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.name.preferred This element is included in summaries. 1..1 boolean If this is the preferred name for this substance
SubstanceDefinition.name.language This element is included in summaries. 1..* CodeableConcept Human language that the name is written in
Binding: CommonLanguages (required)
Additional BindingsPurpose
CommonLanguages Starter

SubstanceDefinition.name.official This element is included in summaries. 1..1 BackboneElement Details of the official nature of this name
SubstanceDefinition.name.official.authority This element is included in summaries. 0..1 CodeableConcept Which authority uses this official name
Binding: Substance Name Authority Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubstanceDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
SubstanceDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​domain Base example Medicinal Product Domain 📍5.0.0 FHIR Std.
SubstanceDefinition.​property.type Base example Product Characteristic 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.language Base required Common Languages 📦5.0.0 FHIR Std.
SubstanceDefinition.​name.official.authority Base extensible Substance Name Authority Value Set 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from SubstanceDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SubstanceDefinition 0..* SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
SubstanceDefinition.id 1..1 id Logical id of this artifact
SubstanceDefinition.meta
SubstanceDefinition.meta.source 1..1 uri Identifies where the resource comes from
SubstanceDefinition.implicitRules 0..0 A set of rules under which this content was created
SubstanceDefinition.modifierExtension 0..0 Extension
SubstanceDefinition.identifier 1..1 Identifier Identifier by which this substance is known
SubstanceDefinition.identifier.system 0..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.version 0..0 A business level version identifier of the substance
SubstanceDefinition.status 1..1 CodeableConcept draft|active|retired
SubstanceDefinition.classification 0..0 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
SubstanceDefinition.domain 1..1 CodeableConcept If the substance applies to human or veterinary use
SubstanceDefinition.grade 0..0 The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
SubstanceDefinition.description 0..0 Textual description of the substance
SubstanceDefinition.note 0..0 Textual comment about the substance's catalogue or registry record
SubstanceDefinition.manufacturer 0..0 The entity that creates, makes, produces or fabricates the substance
SubstanceDefinition.supplier 0..0 An entity that is the source for the substance. It may be different from the manufacturer
SubstanceDefinition.moiety 0..0 Moiety, for structural modifications
SubstanceDefinition.property 0..0 General specifications for this substance
SubstanceDefinition.molecularWeight 0..0 The average mass of a molecule of a compound
SubstanceDefinition.structure
SubstanceDefinition.structure.representation 1..1 BackboneElement A depiction of the structure of the substance
SubstanceDefinition.structure.representation.format
SubstanceDefinition.structure.representation.format.coding 1..1 Coding Code defined by a terminology system
SubstanceDefinition.structure.representation.format.coding.system 1..1 uri Identity of the terminology system
SubstanceDefinition.structure.representation.format.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: SMILES (extensions allowed)
SubstanceDefinition.code
SubstanceDefinition.code.code
SubstanceDefinition.code.code.Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
SubstanceDefinition.code.code.Slices for coding.coding:All Slices Content/Rules for all slices
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.system 1..1 uri Identity of the terminology system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.code 1..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:unii 0..* Coding UNII
SubstanceDefinition.code.code.Slices for coding.coding:unii.system 0..1 uri Identity of the terminology system
Required Pattern: https://open.fda.gov/data/unii (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:cas 0..* Coding CAS
SubstanceDefinition.code.code.Slices for coding.coding:cas.system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:eusrs 0..* Coding EU-SRS
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.system 0..1 uri Identity of the terminology system
Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:gsid 0..* Coding GSID
SubstanceDefinition.code.code.Slices for coding.coding:gsid.system 0..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.name 1..* BackboneElement Names applicable to this substance
SubstanceDefinition.name.modifierExtension 0..0 Extension
SubstanceDefinition.name.status 0..1 CodeableConcept name status
SubstanceDefinition.name.preferred 1..1 boolean If this is the preferred name for this substance
SubstanceDefinition.name.language 1..* CodeableConcept Human language that the name is written in
Binding: CommonLanguages (required)
SubstanceDefinition.name.official 1..1 BackboneElement Details of the official nature of this name
SubstanceDefinition.name.official.modifierExtension 0..0 Extension
SubstanceDefinition.name.official.authority 0..1 CodeableConcept Which authority uses this official name
Binding: Substance Name Authority Value Set (extensible)
SubstanceDefinition.sourceMaterial 0..0 Material or taxonomic/anatomical source

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SubstanceDefinition.​name.language Base required Common Languages 📦5.0.0 FHIR Std.
SubstanceDefinition.​name.official.authority Base extensible Substance Name Authority Value Set 📦1.0.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
SubstanceDefinition 0..* SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
SubstanceDefinition.id This element is included in summaries. 1..1 id Logical id of this artifact
SubstanceDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
SubstanceDefinition.meta.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
SubstanceDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
SubstanceDefinition.meta.source This element is included in summaries. 1..1 uri Identifies where the resource comes from
SubstanceDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
SubstanceDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
SubstanceDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
SubstanceDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
SubstanceDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
SubstanceDefinition.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.identifier This element is included in summaries. 1..1 Identifier Identifier by which this substance is known
SubstanceDefinition.identifier.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
SubstanceDefinition.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
SubstanceDefinition.identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.identifier.value This element is included in summaries. C 0..1 string The value that is unique
Example General: 123456
SubstanceDefinition.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
SubstanceDefinition.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
SubstanceDefinition.status This element is included in summaries. 1..1 CodeableConcept draft|active|retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.domain This element is included in summaries. 1..1 CodeableConcept If the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
SubstanceDefinition.informationSource This element is included in summaries. 0..* Reference(Citation) Supporting literature
SubstanceDefinition.characterization This element is included in summaries. 0..* BackboneElement General specifications for this substance
SubstanceDefinition.characterization.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.characterization.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.characterization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.characterization.technique This element is included in summaries. 0..1 CodeableConcept The method used to find the characterization e.g. HPLC
Binding: StructureTechnique (example): The method used to elucidate the characterization of the drug substance.
SubstanceDefinition.characterization.form This element is included in summaries. 0..1 CodeableConcept Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form
Binding: SubstanceForm (example)
SubstanceDefinition.characterization.description This element is included in summaries. 0..1 markdown The description or justification in support of the interpretation of the data file
SubstanceDefinition.characterization.file This element is included in summaries. 0..* Attachment 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
SubstanceDefinition.referenceInformation This element is included in summaries. 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance
SubstanceDefinition.structure This element is included in summaries. 0..1 BackboneElement Structural information
SubstanceDefinition.structure.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.structure.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.structure.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.structure.stereochemistry This element is included in summaries. 0..1 CodeableConcept Stereochemistry type
Binding: Stereochemistry (example): The optical rotation type of a substance.
SubstanceDefinition.structure.opticalActivity This element is included in summaries. 0..1 CodeableConcept Optical activity type
Binding: OpticalActivity (example): The optical rotation type of a substance.
SubstanceDefinition.structure.molecularFormula This element is included in summaries. 0..1 string An expression which states the number and type of atoms present in a molecule of a substance
SubstanceDefinition.structure.molecularFormulaByMoiety This element is included in summaries. 0..1 string Specified per moiety according to the Hill system
SubstanceDefinition.structure.molecularWeight This element is included in summaries. 0..1 See molecularWeight (SubstanceDefinition) The molecular weight or weight range
SubstanceDefinition.structure.technique This element is included in summaries. 0..* CodeableConcept The method used to find the structure e.g. X-ray, NMR
Binding: StructureTechnique (example): The method used to elucidate the structure of the drug substance.
SubstanceDefinition.structure.sourceDocument This element is included in summaries. 0..* Reference(DocumentReference) Source of information for the structure
SubstanceDefinition.structure.representation This element is included in summaries. 1..1 BackboneElement A depiction of the structure of the substance
SubstanceDefinition.structure.representation.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.structure.representation.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.structure.representation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.structure.representation.type This element is included in summaries. 0..1 CodeableConcept The kind of structural representation (e.g. full, partial)
Binding: SubstanceRepresentationType (example): A format of a substance representation.
SubstanceDefinition.structure.representation.representation This element is included in summaries. 0..1 string The structural representation as a text string in a standard format
SubstanceDefinition.structure.representation.format This element is included in summaries. 0..1 CodeableConcept The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)
Binding: SubstanceRepresentationFormat (example): A format of a substance representation.
SubstanceDefinition.structure.representation.format.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.structure.representation.format.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.structure.representation.format.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
SubstanceDefinition.structure.representation.format.coding.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.structure.representation.format.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.structure.representation.format.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
SubstanceDefinition.structure.representation.format.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.structure.representation.format.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Required Pattern: SMILES (extensions allowed)
SubstanceDefinition.structure.representation.format.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.structure.representation.format.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.structure.representation.format.text This element is included in summaries. 0..1 string Plain text representation of the concept
SubstanceDefinition.structure.representation.document This element is included in summaries. 0..1 Reference(DocumentReference) An attachment with the structural representation e.g. a structure graphic or AnIML file
SubstanceDefinition.code This element is included in summaries. 0..* BackboneElement Codes associated with the substance
SubstanceDefinition.code.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.code.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.code.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.code.code This element is included in summaries. 0..1 CodeableConcept The specific code
SubstanceDefinition.code.code.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
SubstanceDefinition.code.code.Slices for coding.coding:All Slices Content/Rules for all slices
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.system This element is included in summaries. 1..1 uri Identity of the terminology system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:unii This element is included in summaries. 0..* Coding UNII
SubstanceDefinition.code.code.Slices for coding.coding:unii.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:unii.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:unii.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://open.fda.gov/data/unii (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:unii.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:unii.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:unii.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:unii.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:cas This element is included in summaries. 0..* Coding CAS
SubstanceDefinition.code.code.Slices for coding.coding:cas.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:cas.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:cas.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:cas.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:cas.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:cas.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:cas.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:eusrs This element is included in summaries. 0..* Coding EU-SRS
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:gsid This element is included in summaries. 0..* Coding GSID
SubstanceDefinition.code.code.Slices for coding.coding:gsid.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:gsid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:gsid.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:gsid.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:gsid.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:gsid.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:gsid.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
SubstanceDefinition.code.status This element is included in summaries. 0..1 CodeableConcept Status of the code assignment, for example 'provisional', 'approved'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.code.statusDate This element is included in summaries. 0..1 dateTime The date at which the code status was changed
SubstanceDefinition.code.note This element is included in summaries. 0..* Annotation Any comment can be provided in this field
SubstanceDefinition.code.source This element is included in summaries. 0..* Reference(DocumentReference) Supporting literature
SubstanceDefinition.name This element is included in summaries. 1..* BackboneElement Names applicable to this substance
SubstanceDefinition.name.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.name.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.name.name This element is included in summaries. 1..1 string The actual name
SubstanceDefinition.name.type This element is included in summaries. 0..1 CodeableConcept Name type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.
SubstanceDefinition.name.status This element is included in summaries. 0..1 CodeableConcept name status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.name.preferred This element is included in summaries. 1..1 boolean If this is the preferred name for this substance
SubstanceDefinition.name.language This element is included in summaries. 1..* CodeableConcept Human language that the name is written in
Binding: CommonLanguages (required)
Additional BindingsPurpose
CommonLanguages Starter

SubstanceDefinition.name.domain This element is included in summaries. 0..* CodeableConcept The use context of this name e.g. as an active ingredient or as a food colour additive
Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive.
SubstanceDefinition.name.jurisdiction This element is included in summaries. 0..* CodeableConcept The jurisdiction where this name applies
Binding: JurisdictionValueSet (example): Jurisdiction codes
SubstanceDefinition.name.synonym This element is included in summaries. 0..* See name (SubstanceDefinition) A synonym of this particular name, by which the substance is also known
SubstanceDefinition.name.translation This element is included in summaries. 0..* See name (SubstanceDefinition) A translation for this name into another human language
SubstanceDefinition.name.official This element is included in summaries. 1..1 BackboneElement Details of the official nature of this name
SubstanceDefinition.name.official.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.name.official.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.name.official.authority This element is included in summaries. 0..1 CodeableConcept Which authority uses this official name
Binding: Substance Name Authority Value Set (extensible)
SubstanceDefinition.name.official.status This element is included in summaries. 0..1 CodeableConcept The status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.name.official.date This element is included in summaries. 0..1 dateTime Date of official name change
SubstanceDefinition.name.source This element is included in summaries. 0..* Reference(DocumentReference) Supporting literature
SubstanceDefinition.relationship This element is included in summaries. 0..* BackboneElement A link between this substance and another
SubstanceDefinition.relationship.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.relationship.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.relationship.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.relationship.substanceDefinition[x] This element is included in summaries. 0..1 A pointer to another substance, as a resource or a representational code
SubstanceDefinition.relationship.substanceDefinition[x].substanceDefinitionReference Reference(SubstanceDefinition)
SubstanceDefinition.relationship.substanceDefinition[x].substanceDefinitionCodeableConcept CodeableConcept
SubstanceDefinition.relationship.type This element is included in summaries. 1..1 CodeableConcept For example "salt to parent", "active moiety"
Binding: SubstanceRelationshipType (example): The relationship between two substance types.
SubstanceDefinition.relationship.isDefining This element is included in summaries. 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 relationships
SubstanceDefinition.relationship.amount[x] This element is included in summaries. 0..1 A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other
SubstanceDefinition.relationship.amount[x].amountQuantity Quantity
SubstanceDefinition.relationship.amount[x].amountRatio Ratio
SubstanceDefinition.relationship.amount[x].amountString string
SubstanceDefinition.relationship.ratioHighLimitAmount This element is included in summaries. 0..1 Ratio For use when the numeric has an uncertain range
SubstanceDefinition.relationship.comparator This element is included in summaries. 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than"
Binding: SubstanceAmountType (example): The relationship between two substance types.
SubstanceDefinition.relationship.source This element is included in summaries. 0..* Reference(DocumentReference) Supporting literature
SubstanceDefinition.nucleicAcid This element is included in summaries. 0..1 Reference(SubstanceNucleicAcid) Data items specific to nucleic acids
SubstanceDefinition.polymer This element is included in summaries. 0..1 Reference(SubstancePolymer) Data items specific to polymers
SubstanceDefinition.protein This element is included in summaries. 0..1 Reference(SubstanceProtein) Data items specific to proteins

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubstanceDefinition.​meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
SubstanceDefinition.​meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
SubstanceDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
SubstanceDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
SubstanceDefinition.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
SubstanceDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​domain Base example Medicinal Product Domain 📍5.0.0 FHIR Std.
SubstanceDefinition.​moiety.stereochemistry Base example Stereochemistry 📍5.0.0 FHIR Std.
SubstanceDefinition.​moiety.opticalActivity Base example Optical Activity 📍5.0.0 FHIR Std.
SubstanceDefinition.​moiety.measurementType Base example Substance Amount Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​characterization.technique Base example Structure Technique 📍5.0.0 FHIR Std.
SubstanceDefinition.​characterization.form Base example Substance Form 📍5.0.0 FHIR Std.
SubstanceDefinition.​property.type Base example Product Characteristic 📍5.0.0 FHIR Std.
SubstanceDefinition.​molecularWeight.method Base example Weight Method 📍5.0.0 FHIR Std.
SubstanceDefinition.​molecularWeight.type Base example Weight Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.stereochemistry Base example Stereochemistry 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.opticalActivity Base example Optical Activity 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.technique Base example Structure Technique 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.representation.​type Base example Substance Representation Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.representation.​format Base example Substance Representation Format 📍5.0.0 FHIR Std.
SubstanceDefinition.​code.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.type Base example Substance Name Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.language Base required Common Languages 📦5.0.0 FHIR Std.
SubstanceDefinition.​name.domain Base example Substance Name Domain 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.jurisdiction Base example Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.official.authority Base extensible Substance Name Authority Value Set 📦1.0.0 This IG
SubstanceDefinition.​name.official.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​relationship.type Base example Substance Relationship Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​relationship.comparator Base example Substance Amount Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.type Base example Source Material Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.genus Base example Source Material Genus 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.species Base example Source Material Species 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.part Base example Source Material Part 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.countryOfOrigin Base required Country ValueSet 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from SubstanceDefinition

Summary

Mandatory: 8 elements(8 nested mandatory elements)
Prohibited: 16 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of SubstanceDefinition.code.code.coding (Closed)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SubstanceDefinition 0..* SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
SubstanceDefinition.id This element is included in summaries. 1..1 id Logical id of this artifact
SubstanceDefinition.identifier This element is included in summaries. 1..1 Identifier Identifier by which this substance is known
SubstanceDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
SubstanceDefinition.identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.status This element is included in summaries. 1..1 CodeableConcept draft|active|retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.domain This element is included in summaries. 1..1 CodeableConcept If the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
SubstanceDefinition.name This element is included in summaries. 1..* BackboneElement Names applicable to this substance
SubstanceDefinition.name.name This element is included in summaries. 1..1 string The actual name
SubstanceDefinition.name.status This element is included in summaries. 0..1 CodeableConcept name status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.name.preferred This element is included in summaries. 1..1 boolean If this is the preferred name for this substance
SubstanceDefinition.name.language This element is included in summaries. 1..* CodeableConcept Human language that the name is written in
Binding: CommonLanguages (required)
Additional BindingsPurpose
CommonLanguages Starter

SubstanceDefinition.name.official This element is included in summaries. 1..1 BackboneElement Details of the official nature of this name
SubstanceDefinition.name.official.authority This element is included in summaries. 0..1 CodeableConcept Which authority uses this official name
Binding: Substance Name Authority Value Set (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubstanceDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
SubstanceDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​domain Base example Medicinal Product Domain 📍5.0.0 FHIR Std.
SubstanceDefinition.​property.type Base example Product Characteristic 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.language Base required Common Languages 📦5.0.0 FHIR Std.
SubstanceDefinition.​name.official.authority Base extensible Substance Name Authority Value Set 📦1.0.0 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from SubstanceDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SubstanceDefinition 0..* SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
SubstanceDefinition.id 1..1 id Logical id of this artifact
SubstanceDefinition.meta
SubstanceDefinition.meta.source 1..1 uri Identifies where the resource comes from
SubstanceDefinition.implicitRules 0..0 A set of rules under which this content was created
SubstanceDefinition.contained 0..0 Contained, inline Resources
SubstanceDefinition.modifierExtension 0..0 Extension
SubstanceDefinition.identifier 1..1 Identifier Identifier by which this substance is known
SubstanceDefinition.identifier.system 0..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.version 0..0 A business level version identifier of the substance
SubstanceDefinition.status 1..1 CodeableConcept draft|active|retired
SubstanceDefinition.classification 0..0 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
SubstanceDefinition.domain 1..1 CodeableConcept If the substance applies to human or veterinary use
SubstanceDefinition.grade 0..0 The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
SubstanceDefinition.description 0..0 Textual description of the substance
SubstanceDefinition.note 0..0 Textual comment about the substance's catalogue or registry record
SubstanceDefinition.manufacturer 0..0 The entity that creates, makes, produces or fabricates the substance
SubstanceDefinition.supplier 0..0 An entity that is the source for the substance. It may be different from the manufacturer
SubstanceDefinition.moiety 0..0 Moiety, for structural modifications
SubstanceDefinition.property 0..0 General specifications for this substance
SubstanceDefinition.molecularWeight 0..0 The average mass of a molecule of a compound
SubstanceDefinition.structure
SubstanceDefinition.structure.representation 1..1 BackboneElement A depiction of the structure of the substance
SubstanceDefinition.structure.representation.format
SubstanceDefinition.structure.representation.format.coding 1..1 Coding Code defined by a terminology system
SubstanceDefinition.structure.representation.format.coding.system 1..1 uri Identity of the terminology system
SubstanceDefinition.structure.representation.format.coding.code 1..1 code Symbol in syntax defined by the system
Required Pattern: SMILES (extensions allowed)
SubstanceDefinition.code
SubstanceDefinition.code.code
SubstanceDefinition.code.code.Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
SubstanceDefinition.code.code.Slices for coding.coding:All Slices Content/Rules for all slices
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.system 1..1 uri Identity of the terminology system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.code 1..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:unii 0..* Coding UNII
SubstanceDefinition.code.code.Slices for coding.coding:unii.system 0..1 uri Identity of the terminology system
Required Pattern: https://open.fda.gov/data/unii (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:cas 0..* Coding CAS
SubstanceDefinition.code.code.Slices for coding.coding:cas.system 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:eusrs 0..* Coding EU-SRS
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.system 0..1 uri Identity of the terminology system
Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:gsid 0..* Coding GSID
SubstanceDefinition.code.code.Slices for coding.coding:gsid.system 0..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.name 1..* BackboneElement Names applicable to this substance
SubstanceDefinition.name.modifierExtension 0..0 Extension
SubstanceDefinition.name.status 0..1 CodeableConcept name status
SubstanceDefinition.name.preferred 1..1 boolean If this is the preferred name for this substance
SubstanceDefinition.name.language 1..* CodeableConcept Human language that the name is written in
Binding: CommonLanguages (required)
SubstanceDefinition.name.official 1..1 BackboneElement Details of the official nature of this name
SubstanceDefinition.name.official.modifierExtension 0..0 Extension
SubstanceDefinition.name.official.authority 0..1 CodeableConcept Which authority uses this official name
Binding: Substance Name Authority Value Set (extensible)
SubstanceDefinition.sourceMaterial 0..0 Material or taxonomic/anatomical source

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
SubstanceDefinition.​name.language Base required Common Languages 📦5.0.0 FHIR Std.
SubstanceDefinition.​name.official.authority Base extensible Substance Name Authority Value Set 📦1.0.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
SubstanceDefinition 0..* SubstanceDefinition The detailed description of a substance, typically at a level beyond what is used for prescribing
SubstanceDefinition.id This element is included in summaries. 1..1 id Logical id of this artifact
SubstanceDefinition.meta This element is included in summaries. 0..1 Meta Metadata about the resource
SubstanceDefinition.meta.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.meta.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.meta.versionId This element is included in summaries. 0..1 id Version specific identifier
SubstanceDefinition.meta.lastUpdated This element is included in summaries. 0..1 instant When the resource version last changed
SubstanceDefinition.meta.source This element is included in summaries. 1..1 uri Identifies where the resource comes from
SubstanceDefinition.meta.profile This element is included in summaries. 0..* canonical(StructureDefinition) Profiles this resource claims to conform to
SubstanceDefinition.meta.security This element is included in summaries. 0..* Coding Security Labels applied to this resource
Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
SubstanceDefinition.meta.tag This element is included in summaries. 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
SubstanceDefinition.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
SubstanceDefinition.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
SubstanceDefinition.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.identifier This element is included in summaries. 1..1 Identifier Identifier by which this substance is known
SubstanceDefinition.identifier.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.identifier.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.identifier.use This element is a modifier element. This element is included in summaries. 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
SubstanceDefinition.identifier.type This element is included in summaries. 0..1 CodeableConcept Description of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
SubstanceDefinition.identifier.system This element is included in summaries. 0..1 uri The namespace for the identifier value
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.identifier.value This element is included in summaries. C 0..1 string The value that is unique
Example General: 123456
SubstanceDefinition.identifier.period This element is included in summaries. 0..1 Period Time period when id is/was valid for use
SubstanceDefinition.identifier.assigner This element is included in summaries. 0..1 Reference(Organization) Organization that issued id (may be just text)
SubstanceDefinition.status This element is included in summaries. 1..1 CodeableConcept draft|active|retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.domain This element is included in summaries. 1..1 CodeableConcept If the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
SubstanceDefinition.informationSource This element is included in summaries. 0..* Reference(Citation) Supporting literature
SubstanceDefinition.characterization This element is included in summaries. 0..* BackboneElement General specifications for this substance
SubstanceDefinition.characterization.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.characterization.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.characterization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.characterization.technique This element is included in summaries. 0..1 CodeableConcept The method used to find the characterization e.g. HPLC
Binding: StructureTechnique (example): The method used to elucidate the characterization of the drug substance.
SubstanceDefinition.characterization.form This element is included in summaries. 0..1 CodeableConcept Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form
Binding: SubstanceForm (example)
SubstanceDefinition.characterization.description This element is included in summaries. 0..1 markdown The description or justification in support of the interpretation of the data file
SubstanceDefinition.characterization.file This element is included in summaries. 0..* Attachment 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
SubstanceDefinition.referenceInformation This element is included in summaries. 0..1 Reference(SubstanceReferenceInformation) General information detailing this substance
SubstanceDefinition.structure This element is included in summaries. 0..1 BackboneElement Structural information
SubstanceDefinition.structure.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.structure.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.structure.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.structure.stereochemistry This element is included in summaries. 0..1 CodeableConcept Stereochemistry type
Binding: Stereochemistry (example): The optical rotation type of a substance.
SubstanceDefinition.structure.opticalActivity This element is included in summaries. 0..1 CodeableConcept Optical activity type
Binding: OpticalActivity (example): The optical rotation type of a substance.
SubstanceDefinition.structure.molecularFormula This element is included in summaries. 0..1 string An expression which states the number and type of atoms present in a molecule of a substance
SubstanceDefinition.structure.molecularFormulaByMoiety This element is included in summaries. 0..1 string Specified per moiety according to the Hill system
SubstanceDefinition.structure.molecularWeight This element is included in summaries. 0..1 See molecularWeight (SubstanceDefinition) The molecular weight or weight range
SubstanceDefinition.structure.technique This element is included in summaries. 0..* CodeableConcept The method used to find the structure e.g. X-ray, NMR
Binding: StructureTechnique (example): The method used to elucidate the structure of the drug substance.
SubstanceDefinition.structure.sourceDocument This element is included in summaries. 0..* Reference(DocumentReference) Source of information for the structure
SubstanceDefinition.structure.representation This element is included in summaries. 1..1 BackboneElement A depiction of the structure of the substance
SubstanceDefinition.structure.representation.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.structure.representation.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.structure.representation.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.structure.representation.type This element is included in summaries. 0..1 CodeableConcept The kind of structural representation (e.g. full, partial)
Binding: SubstanceRepresentationType (example): A format of a substance representation.
SubstanceDefinition.structure.representation.representation This element is included in summaries. 0..1 string The structural representation as a text string in a standard format
SubstanceDefinition.structure.representation.format This element is included in summaries. 0..1 CodeableConcept The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)
Binding: SubstanceRepresentationFormat (example): A format of a substance representation.
SubstanceDefinition.structure.representation.format.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.structure.representation.format.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.structure.representation.format.coding This element is included in summaries. 1..1 Coding Code defined by a terminology system
SubstanceDefinition.structure.representation.format.coding.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.structure.representation.format.coding.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.structure.representation.format.coding.system This element is included in summaries. 1..1 uri Identity of the terminology system
SubstanceDefinition.structure.representation.format.coding.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.structure.representation.format.coding.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
Required Pattern: SMILES (extensions allowed)
SubstanceDefinition.structure.representation.format.coding.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.structure.representation.format.coding.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.structure.representation.format.text This element is included in summaries. 0..1 string Plain text representation of the concept
SubstanceDefinition.structure.representation.document This element is included in summaries. 0..1 Reference(DocumentReference) An attachment with the structural representation e.g. a structure graphic or AnIML file
SubstanceDefinition.code This element is included in summaries. 0..* BackboneElement Codes associated with the substance
SubstanceDefinition.code.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.code.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.code.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.code.code This element is included in summaries. 0..1 CodeableConcept The specific code
SubstanceDefinition.code.code.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding This element is included in summaries. 1..* Coding Code defined by a terminology system
Slice: Unordered, Closed by value:system

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
SubstanceDefinition.code.code.Slices for coding.coding:All Slices Content/Rules for all slices
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.system This element is included in summaries. 1..1 uri Identity of the terminology system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.code This element is included in summaries. C 1..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:All Slices.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:unii This element is included in summaries. 0..* Coding UNII
SubstanceDefinition.code.code.Slices for coding.coding:unii.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:unii.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:unii.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: https://open.fda.gov/data/unii (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:unii.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:unii.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:unii.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:unii.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:cas This element is included in summaries. 0..* Coding CAS
SubstanceDefinition.code.code.Slices for coding.coding:cas.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:cas.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:cas.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:cas.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:cas.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:cas.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:cas.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:eusrs This element is included in summaries. 0..* Coding EU-SRS
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:eusrs.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.Slices for coding.coding:gsid This element is included in summaries. 0..* Coding GSID
SubstanceDefinition.code.code.Slices for coding.coding:gsid.id 0..1 id Unique id for inter-element referencing
SubstanceDefinition.code.code.Slices for coding.coding:gsid.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
SubstanceDefinition.code.code.Slices for coding.coding:gsid.system This element is included in summaries. 0..1 uri Identity of the terminology system
Required Pattern: http://umcterminologies.org/gsid (extensions allowed)
SubstanceDefinition.code.code.Slices for coding.coding:gsid.version This element is included in summaries. 0..1 string Version of the system - if relevant
SubstanceDefinition.code.code.Slices for coding.coding:gsid.code This element is included in summaries. C 0..1 code Symbol in syntax defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:gsid.display This element is included in summaries. C 0..1 string Representation defined by the system
SubstanceDefinition.code.code.Slices for coding.coding:gsid.userSelected This element is included in summaries. 0..1 boolean If this coding was chosen directly by the user
SubstanceDefinition.code.code.text This element is included in summaries. 0..1 string Plain text representation of the concept
SubstanceDefinition.code.status This element is included in summaries. 0..1 CodeableConcept Status of the code assignment, for example 'provisional', 'approved'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.code.statusDate This element is included in summaries. 0..1 dateTime The date at which the code status was changed
SubstanceDefinition.code.note This element is included in summaries. 0..* Annotation Any comment can be provided in this field
SubstanceDefinition.code.source This element is included in summaries. 0..* Reference(DocumentReference) Supporting literature
SubstanceDefinition.name This element is included in summaries. 1..* BackboneElement Names applicable to this substance
SubstanceDefinition.name.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.name.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.name.name This element is included in summaries. 1..1 string The actual name
SubstanceDefinition.name.type This element is included in summaries. 0..1 CodeableConcept Name type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.
SubstanceDefinition.name.status This element is included in summaries. 0..1 CodeableConcept name status
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.name.preferred This element is included in summaries. 1..1 boolean If this is the preferred name for this substance
SubstanceDefinition.name.language This element is included in summaries. 1..* CodeableConcept Human language that the name is written in
Binding: CommonLanguages (required)
Additional BindingsPurpose
CommonLanguages Starter

SubstanceDefinition.name.domain This element is included in summaries. 0..* CodeableConcept The use context of this name e.g. as an active ingredient or as a food colour additive
Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive.
SubstanceDefinition.name.jurisdiction This element is included in summaries. 0..* CodeableConcept The jurisdiction where this name applies
Binding: JurisdictionValueSet (example): Jurisdiction codes
SubstanceDefinition.name.synonym This element is included in summaries. 0..* See name (SubstanceDefinition) A synonym of this particular name, by which the substance is also known
SubstanceDefinition.name.translation This element is included in summaries. 0..* See name (SubstanceDefinition) A translation for this name into another human language
SubstanceDefinition.name.official This element is included in summaries. 1..1 BackboneElement Details of the official nature of this name
SubstanceDefinition.name.official.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.name.official.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.name.official.authority This element is included in summaries. 0..1 CodeableConcept Which authority uses this official name
Binding: Substance Name Authority Value Set (extensible)
SubstanceDefinition.name.official.status This element is included in summaries. 0..1 CodeableConcept The status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
SubstanceDefinition.name.official.date This element is included in summaries. 0..1 dateTime Date of official name change
SubstanceDefinition.name.source This element is included in summaries. 0..* Reference(DocumentReference) Supporting literature
SubstanceDefinition.relationship This element is included in summaries. 0..* BackboneElement A link between this substance and another
SubstanceDefinition.relationship.id 0..1 string Unique id for inter-element referencing
SubstanceDefinition.relationship.extension 0..* Extension Additional content defined by implementations
SubstanceDefinition.relationship.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
SubstanceDefinition.relationship.substanceDefinition[x] This element is included in summaries. 0..1 A pointer to another substance, as a resource or a representational code
SubstanceDefinition.relationship.substanceDefinition[x].substanceDefinitionReference Reference(SubstanceDefinition)
SubstanceDefinition.relationship.substanceDefinition[x].substanceDefinitionCodeableConcept CodeableConcept
SubstanceDefinition.relationship.type This element is included in summaries. 1..1 CodeableConcept For example "salt to parent", "active moiety"
Binding: SubstanceRelationshipType (example): The relationship between two substance types.
SubstanceDefinition.relationship.isDefining This element is included in summaries. 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 relationships
SubstanceDefinition.relationship.amount[x] This element is included in summaries. 0..1 A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other
SubstanceDefinition.relationship.amount[x].amountQuantity Quantity
SubstanceDefinition.relationship.amount[x].amountRatio Ratio
SubstanceDefinition.relationship.amount[x].amountString string
SubstanceDefinition.relationship.ratioHighLimitAmount This element is included in summaries. 0..1 Ratio For use when the numeric has an uncertain range
SubstanceDefinition.relationship.comparator This element is included in summaries. 0..1 CodeableConcept An operator for the amount, for example "average", "approximately", "less than"
Binding: SubstanceAmountType (example): The relationship between two substance types.
SubstanceDefinition.relationship.source This element is included in summaries. 0..* Reference(DocumentReference) Supporting literature
SubstanceDefinition.nucleicAcid This element is included in summaries. 0..1 Reference(SubstanceNucleicAcid) Data items specific to nucleic acids
SubstanceDefinition.polymer This element is included in summaries. 0..1 Reference(SubstancePolymer) Data items specific to polymers
SubstanceDefinition.protein This element is included in summaries. 0..1 Reference(SubstanceProtein) Data items specific to proteins

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubstanceDefinition.​meta.security Base extensible All Security Labels 📍5.0.0 FHIR Std.
SubstanceDefinition.​meta.tag Base example Common Tags 📍5.0.0 FHIR Std.
SubstanceDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
SubstanceDefinition.​identifier.use Base required IdentifierUse 📍5.0.0 FHIR Std.
SubstanceDefinition.​identifier.type Base extensible Identifier Type Codes 📍5.0.0 FHIR Std.
SubstanceDefinition.​status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​domain Base example Medicinal Product Domain 📍5.0.0 FHIR Std.
SubstanceDefinition.​moiety.stereochemistry Base example Stereochemistry 📍5.0.0 FHIR Std.
SubstanceDefinition.​moiety.opticalActivity Base example Optical Activity 📍5.0.0 FHIR Std.
SubstanceDefinition.​moiety.measurementType Base example Substance Amount Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​characterization.technique Base example Structure Technique 📍5.0.0 FHIR Std.
SubstanceDefinition.​characterization.form Base example Substance Form 📍5.0.0 FHIR Std.
SubstanceDefinition.​property.type Base example Product Characteristic 📍5.0.0 FHIR Std.
SubstanceDefinition.​molecularWeight.method Base example Weight Method 📍5.0.0 FHIR Std.
SubstanceDefinition.​molecularWeight.type Base example Weight Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.stereochemistry Base example Stereochemistry 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.opticalActivity Base example Optical Activity 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.technique Base example Structure Technique 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.representation.​type Base example Substance Representation Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​structure.representation.​format Base example Substance Representation Format 📍5.0.0 FHIR Std.
SubstanceDefinition.​code.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.type Base example Substance Name Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.language Base required Common Languages 📦5.0.0 FHIR Std.
SubstanceDefinition.​name.domain Base example Substance Name Domain 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.jurisdiction Base example Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SubstanceDefinition.​name.official.authority Base extensible Substance Name Authority Value Set 📦1.0.0 This IG
SubstanceDefinition.​name.official.status Base preferred PublicationStatus 📍5.0.0 FHIR Std.
SubstanceDefinition.​relationship.type Base example Substance Relationship Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​relationship.comparator Base example Substance Amount Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.type Base example Source Material Type 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.genus Base example Source Material Genus 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.species Base example Source Material Species 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.part Base example Source Material Part 📍5.0.0 FHIR Std.
SubstanceDefinition.​sourceMaterial.countryOfOrigin Base required Country ValueSet 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from SubstanceDefinition

Summary

Mandatory: 8 elements(8 nested mandatory elements)
Prohibited: 16 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of SubstanceDefinition.code.code.coding (Closed)

 

Other representations of profile: CSV, Excel, Schematron