UMC IDMP Request and Publish API
0.1.0 - CI Build

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 0.1.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 for publication

Official URL: http://who-umc.org/idmp/StructureDefinition/SubstanceDefinition-pub | Version: 0.1.0
Active as of 2025-11-19 | Computable Name: SubstanceDefinitionPublished

This profile specified how the SubstanceDefinition is published by the WHO-UMC IDMP FHIR Service

Usages:

- Examples for this Profile: SubstanceDefinition/GSID23G92UMX93H45, SubstanceDefinition/GSID85RFP2XGF3X29 and SubstanceDefinition/GSID9XBS2KCF3K1Z1

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
SubstanceDefinition |  | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing
id | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
text |  | 1..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
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..1 | Identifier | Identifier by which this substance is known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/gsid
version | Σ | 0..1 | string | Not used in this profile
status | Σ | 1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
classification | Σ | 0..* | CodeableConcept | Not used in this profile
domain | Σ | 1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
grade | Σ | 0..* | CodeableConcept | Not used in this profile Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies
description | Σ | 0..1 | markdown | Not used in this profile
note | Σ | 0..* | Annotation | Not used in this profile
manufacturer | Σ | 0..* | Reference(Organization) | Not used in this profile
supplier | Σ | 0..* | Reference(Organization) | Not used in this profile
moiety | Σ | 0..* | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
property | Σ | 0..* | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
molecularWeight | Σ | 0..* | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements
name | Σ | 1..* | BackboneElement | Names applicable to this substance
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | The actual name
status | Σ | 0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
preferred | Σ | 1..1 | boolean | If this is the preferred name for this substance
language | Σ | 1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
Additional Bindings | Purpose
CommonLanguages | Starter
official | Σ | 1..1 | BackboneElement | Details of the official nature of this name
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | Σ | 0..1 | BackboneElement | A link between this substance and another
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types.
sourceMaterial | Σ | 0..1 | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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.​grade | Base | example | Substance Grade | 📍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.​relationship.type | Base | example | Substance Relationship Type | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from SubstanceDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
SubstanceDefinition |  | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing
id |  | 1..1 | id | Logical id of this artifact
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation
identifier |  | 1..1 | Identifier | Identifier by which this substance is known
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/gsid
version |  | 0..1 | string | Not used in this profile
status |  | 1..1 | CodeableConcept | draft|active|retired
classification |  | 0..* | CodeableConcept | Not used in this profile
domain |  | 1..1 | CodeableConcept | If the substance applies to human or veterinary use
grade |  | 0..* | CodeableConcept | Not used in this profile
description |  | 0..1 | markdown | Not used in this profile
note |  | 0..* | Annotation | Not used in this profile
manufacturer |  | 0..* | Reference(Organization) | Not used in this profile
supplier |  | 0..* | Reference(Organization) | Not used in this profile
moiety |  | 0..* | BackboneElement | Not used in this profile
property |  | 0..* | BackboneElement | Not used in this profile
molecularWeight |  | 0..* | BackboneElement | Not used in this profile
structure |  |  |  |
representation |  | 1..1 | BackboneElement | A depiction of the structure of the substance
format |  |  |  |
coding |  | 1..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES
code |  |  |  |
code |  |  |  |
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:All Slices |  |  |  | Content/Rules for all slices
system |  | 1..1 | uri | Identity of the terminology system
code |  | 1..1 | code | Symbol in syntax defined by the system
coding:unii |  | 0..* | Coding | UNII
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii
coding:cas |  | 0..* | Coding | CAS
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS
coding:eusrs |  | 0..* | Coding | EU-SRS
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://example.org/eu-srs
name |  | 1..* | BackboneElement | Names applicable to this substance
status |  | 0..1 | CodeableConcept | name status
preferred |  | 1..1 | boolean | If this is the preferred name for this substance
language |  | 1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
official |  | 1..1 | BackboneElement | Details of the official nature of this name
relationship |  | 0..1 | BackboneElement | A link between this substance and another
sourceMaterial |  | 0..1 | BackboneElement | Not used in this profile
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.

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
SubstanceDefinition |  | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 1..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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..1 | Identifier | Identifier by which this substance is known
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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.
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/gsid
value | Σ C | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
version | Σ | 0..1 | string | Not used in this profile
status | Σ | 1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
classification | Σ | 0..* | CodeableConcept | Not used in this profile
domain | Σ | 1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
grade | Σ | 0..* | CodeableConcept | Not used in this profile Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies
description | Σ | 0..1 | markdown | Not used in this profile
informationSource | Σ | 0..* | Reference(Citation) | Supporting literature
note | Σ | 0..* | Annotation | Not used in this profile
manufacturer | Σ | 0..* | Reference(Organization) | Not used in this profile
supplier | Σ | 0..* | Reference(Organization) | Not used in this profile
moiety | Σ | 0..* | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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 Binding: Stereochemistry (example): The optical rotation type of a substance.
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance.
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system)
amount[x] | Σ | 0..1 |  | Quantitative value for this moiety
amountQuantity |  |  | Quantity |
amountString |  |  | string |
measurementType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: SubstanceAmountType (example): The relationship between two substance types.
characterization | Σ | 0..* | BackboneElement | General specifications for this substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
technique | Σ | 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.
form | Σ | 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)
description | Σ | 0..1 | markdown | The description or justification in support of the interpretation of the data file
file | Σ | 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
property | Σ | 0..* | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
value[x] | Σ | 0..1 |  | A value for the property
valueCodeableConcept |  |  | CodeableConcept |
valueQuantity |  |  | Quantity |
valueDate |  |  | date |
valueBoolean |  |  | boolean |
valueAttachment |  |  | Attachment |
referenceInformation | Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance
molecularWeight | Σ | 0..* | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method | Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: WeightMethod (example): The method by which the substance weight was measured.
type | Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: WeightType (example): The type of substance weight measurement.
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements
structure | Σ | 0..1 | BackboneElement | Structural information
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance.
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance.
molecularFormula | Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system
molecularWeight | Σ | 0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range
technique | Σ | 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.
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Source of information for the structure
representation | Σ | 1..1 | BackboneElement | A depiction of the structure of the substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: SubstanceRepresentationType (example): A format of a substance representation.
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format
format | Σ | 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.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file
code | Σ | 0..* | BackboneElement | Codes associated with the substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 0..1 | CodeableConcept | The specific code
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:unii | Σ | 0..* | Coding | UNII
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:cas | Σ | 0..* | Coding | CAS
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:eusrs | Σ | 0..* | Coding | EU-SRS
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://example.org/eu-srs
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed
note | Σ | 0..* | Annotation | Any comment can be provided in this field
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature
name | Σ | 1..* | BackboneElement | Names applicable to this substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | The actual name
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance.
status | Σ | 0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
preferred | Σ | 1..1 | boolean | If this is the preferred name for this substance
language | Σ | 1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
Additional Bindings | Purpose
CommonLanguages | Starter
domain | Σ | 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.
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language
official | Σ | 1..1 | BackboneElement | Details of the official nature of this name
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
date | Σ | 0..1 | dateTime | Date of official name change
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature
relationship | Σ | 0..1 | BackboneElement | A link between this substance and another
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
substanceDefinition[x] | Σ | 0..1 |  | A pointer to another substance, as a resource or a representational code
substanceDefinitionReference |  |  | Reference(SubstanceDefinition) |
substanceDefinitionCodeableConcept |  |  | CodeableConcept |
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types.
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 relationships
amount[x] | Σ | 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
amountQuantity |  |  | Quantity |
amountRatio |  |  | Ratio |
amountString |  |  | string |
ratioHighLimitAmount | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range
comparator | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types.
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 | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: SourceMaterialType (example): A classification that provides the origin of the substance raw material.
genus | Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: SourceMaterialGenus (example): The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.
species | Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: SourceMaterialSpecies (example): A species of origin a substance raw material.
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism.
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: CountryValueSet (required): Jurisdiction codes
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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.​grade | Base | example | Substance Grade | 📍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 | preferred | Substance Name Authority | 📍5.0.0 | FHIR Std.
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
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from SubstanceDefinition

Summary

Mandatory: 9 elements(7 nested mandatory 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
SubstanceDefinition |  | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing
id | Σ | 1..1 | id | Logical id of this artifact
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
text |  | 1..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
contained |  | 0..* | Resource | Contained, inline Resources
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..1 | Identifier | Identifier by which this substance is known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/gsid
version | Σ | 0..1 | string | Not used in this profile
status | Σ | 1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
classification | Σ | 0..* | CodeableConcept | Not used in this profile
domain | Σ | 1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
grade | Σ | 0..* | CodeableConcept | Not used in this profile Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies
description | Σ | 0..1 | markdown | Not used in this profile
note | Σ | 0..* | Annotation | Not used in this profile
manufacturer | Σ | 0..* | Reference(Organization) | Not used in this profile
supplier | Σ | 0..* | Reference(Organization) | Not used in this profile
moiety | Σ | 0..* | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
property | Σ | 0..* | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
molecularWeight | Σ | 0..* | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements
name | Σ | 1..* | BackboneElement | Names applicable to this substance
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | The actual name
status | Σ | 0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
preferred | Σ | 1..1 | boolean | If this is the preferred name for this substance
language | Σ | 1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
Additional Bindings | Purpose
CommonLanguages | Starter
official | Σ | 1..1 | BackboneElement | Details of the official nature of this name
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
relationship | Σ | 0..1 | BackboneElement | A link between this substance and another
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types.
sourceMaterial | Σ | 0..1 | BackboneElement | Not used in this profile
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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.​grade | Base | example | Substance Grade | 📍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.​relationship.type | Base | example | Substance Relationship Type | 📍5.0.0 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from SubstanceDefinition

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
SubstanceDefinition |  | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing
id |  | 1..1 | id | Logical id of this artifact
text |  | 1..1 | Narrative | Text summary of the resource, for human interpretation
identifier |  | 1..1 | Identifier | Identifier by which this substance is known
system |  | 0..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/gsid
version |  | 0..1 | string | Not used in this profile
status |  | 1..1 | CodeableConcept | draft|active|retired
classification |  | 0..* | CodeableConcept | Not used in this profile
domain |  | 1..1 | CodeableConcept | If the substance applies to human or veterinary use
grade |  | 0..* | CodeableConcept | Not used in this profile
description |  | 0..1 | markdown | Not used in this profile
note |  | 0..* | Annotation | Not used in this profile
manufacturer |  | 0..* | Reference(Organization) | Not used in this profile
supplier |  | 0..* | Reference(Organization) | Not used in this profile
moiety |  | 0..* | BackboneElement | Not used in this profile
property |  | 0..* | BackboneElement | Not used in this profile
molecularWeight |  | 0..* | BackboneElement | Not used in this profile
structure |  |  |  |
representation |  | 1..1 | BackboneElement | A depiction of the structure of the substance
format |  |  |  |
coding |  | 1..1 | Coding | Code defined by a terminology system
system |  | 1..1 | uri | Identity of the terminology system
code |  | 1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES
code |  |  |  |
code |  |  |  |
Slices for coding |  | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:All Slices |  |  |  | Content/Rules for all slices
system |  | 1..1 | uri | Identity of the terminology system
code |  | 1..1 | code | Symbol in syntax defined by the system
coding:unii |  | 0..* | Coding | UNII
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii
coding:cas |  | 0..* | Coding | CAS
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS
coding:eusrs |  | 0..* | Coding | EU-SRS
system |  | 1..1 | uri | Identity of the terminology system Required Pattern: http://example.org/eu-srs
name |  | 1..* | BackboneElement | Names applicable to this substance
status |  | 0..1 | CodeableConcept | name status
preferred |  | 1..1 | boolean | If this is the preferred name for this substance
language |  | 1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
official |  | 1..1 | BackboneElement | Details of the official nature of this name
relationship |  | 0..1 | BackboneElement | A link between this substance and another
sourceMaterial |  | 0..1 | BackboneElement | Not used in this profile
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.

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
SubstanceDefinition |  | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing
id | Σ | 1..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
Additional Bindings | Purpose
CommonLanguages | Starter
text |  | 1..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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored
identifier | Σ | 1..1 | Identifier | Identifier by which this substance is known
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 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.
system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://who-umc.org/idmp/gsid
value | Σ C | 0..1 | string | The value that is unique Example General: 123456
period | Σ | 0..1 | Period | Time period when id is/was valid for use
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text)
version | Σ | 0..1 | string | Not used in this profile
status | Σ | 1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
classification | Σ | 0..* | CodeableConcept | Not used in this profile
domain | Σ | 1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).
grade | Σ | 0..* | CodeableConcept | Not used in this profile Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies
description | Σ | 0..1 | markdown | Not used in this profile
informationSource | Σ | 0..* | Reference(Citation) | Supporting literature
note | Σ | 0..* | Annotation | Not used in this profile
manufacturer | Σ | 0..* | Reference(Organization) | Not used in this profile
supplier | Σ | 0..* | Reference(Organization) | Not used in this profile
moiety | Σ | 0..* | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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 Binding: Stereochemistry (example): The optical rotation type of a substance.
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance.
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system)
amount[x] | Σ | 0..1 |  | Quantitative value for this moiety
amountQuantity |  |  | Quantity |
amountString |  |  | string |
measurementType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: SubstanceAmountType (example): The relationship between two substance types.
characterization | Σ | 0..* | BackboneElement | General specifications for this substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
technique | Σ | 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.
form | Σ | 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)
description | Σ | 0..1 | markdown | The description or justification in support of the interpretation of the data file
file | Σ | 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
property | Σ | 0..* | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.
value[x] | Σ | 0..1 |  | A value for the property
valueCodeableConcept |  |  | CodeableConcept |
valueQuantity |  |  | Quantity |
valueDate |  |  | date |
valueBoolean |  |  | boolean |
valueAttachment |  |  | Attachment |
referenceInformation | Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance
molecularWeight | Σ | 0..* | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
method | Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: WeightMethod (example): The method by which the substance weight was measured.
type | Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: WeightType (example): The type of substance weight measurement.
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements
structure | Σ | 0..1 | BackboneElement | Structural information
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance.
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance.
molecularFormula | Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system
molecularWeight | Σ | 0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range
technique | Σ | 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.
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Source of information for the structure
representation | Σ | 1..1 | BackboneElement | A depiction of the structure of the substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: SubstanceRepresentationType (example): A format of a substance representation.
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format
format | Σ | 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.
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | Σ | 1..1 | Coding | Code defined by a terminology system
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file
code | Σ | 0..* | BackboneElement | Codes associated with the substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
code | Σ | 0..1 | CodeableConcept | The specific code
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
Slices for coding | Σ | 1..* | Coding | Code defined by a terminology system Slice: Unordered, Closed by value:system
coding:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:unii | Σ | 0..* | Coding | UNII
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:cas | Σ | 0..* | Coding | CAS
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
coding:eusrs | Σ | 0..* | Coding | EU-SRS
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://example.org/eu-srs
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ C | 1..1 | code | Symbol in syntax defined by the system
display | Σ C | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed
note | Σ | 0..* | Annotation | Any comment can be provided in this field
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature
name | Σ | 1..* | BackboneElement | Names applicable to this substance
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | Σ | 1..1 | string | The actual name
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance.
status | Σ | 0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
preferred | Σ | 1..1 | boolean | If this is the preferred name for this substance
language | Σ | 1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
Additional Bindings | Purpose
CommonLanguages | Starter
domain | Σ | 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.
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language
official | Σ | 1..1 | BackboneElement | Details of the official nature of this name
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact.
date | Σ | 0..1 | dateTime | Date of official name change
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature
relationship | Σ | 0..1 | BackboneElement | A link between this substance and another
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
substanceDefinition[x] | Σ | 0..1 |  | A pointer to another substance, as a resource or a representational code
substanceDefinitionReference |  |  | Reference(SubstanceDefinition) |
substanceDefinitionCodeableConcept |  |  | CodeableConcept |
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types.
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 relationships
amount[x] | Σ | 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
amountQuantity |  |  | Quantity |
amountRatio |  |  | Ratio |
amountString |  |  | string |
ratioHighLimitAmount | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range
comparator | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types.
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 | BackboneElement | Not used in this profile
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: SourceMaterialType (example): A classification that provides the origin of the substance raw material.
genus | Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: SourceMaterialGenus (example): The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.
species | Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: SourceMaterialSpecies (example): A species of origin a substance raw material.
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism.
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: CountryValueSet (required): Jurisdiction codes
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
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.​grade | Base | example | Substance Grade | 📍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 | preferred | Substance Name Authority | 📍5.0.0 | FHIR Std.
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
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from SubstanceDefinition

Summary

Mandatory: 9 elements(7 nested mandatory 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