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
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() |
1..1 | id | Logical id of this artifact | |||||
![]() ![]() |
1..1 | Identifier | Identifier by which this substance is known | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |||||
![]() ![]() |
1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() |
1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | |||||
![]() ![]() |
1..* | BackboneElement | Names applicable to this substance | |||||
![]() ![]() ![]() |
1..1 | string | The actual name | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() |
1..1 | boolean | If this is the preferred name for this substance | |||||
![]() ![]() ![]() |
1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
| |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Details of the official nature of this name | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority Value Set (extensible) | |||||
Documentation for this format | ||||||||
| 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 |
| Id | Grade | Path(s) | Description | Expression |
This structure is derived from SubstanceDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | uri | Identifies where the resource comes from | |
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
1..1 | Identifier | Identifier by which this substance is known | |
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |
![]() ![]() |
0..0 | A business level version identifier of the substance | ||
![]() ![]() |
1..1 | CodeableConcept | draft|active|retired | |
![]() ![]() |
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 | ||
![]() ![]() |
1..1 | CodeableConcept | If the substance applies to human or veterinary use | |
![]() ![]() |
0..0 | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) | ||
![]() ![]() |
0..0 | Textual description of the substance | ||
![]() ![]() |
0..0 | Textual comment about the substance's catalogue or registry record | ||
![]() ![]() |
0..0 | The entity that creates, makes, produces or fabricates the substance | ||
![]() ![]() |
0..0 | An entity that is the source for the substance. It may be different from the manufacturer | ||
![]() ![]() |
0..0 | Moiety, for structural modifications | ||
![]() ![]() |
0..0 | General specifications for this substance | ||
![]() ![]() |
0..0 | The average mass of a molecule of a compound | ||
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | BackboneElement | A depiction of the structure of the substance | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES (extensions allowed) | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | UNII | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii (extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | CAS | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | EU-SRS | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | GSID | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |
![]() ![]() |
1..* | BackboneElement | Names applicable to this substance | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..1 | CodeableConcept | name status | |
![]() ![]() ![]() |
1..1 | boolean | If this is the preferred name for this substance | |
![]() ![]() ![]() |
1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required) | |
![]() ![]() ![]() |
1..1 | BackboneElement | Details of the official nature of this name | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority Value Set (extensible) | |
![]() ![]() |
0..0 | Material or taxonomic/anatomical source | ||
Documentation for this format | ||||
| 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 |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() |
1..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
1..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
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". | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
1..1 | Identifier | Identifier by which this substance is known | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |||||
![]() ![]() ![]() |
C | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() |
1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | |||||
![]() ![]() |
0..* | Reference(Citation) | Supporting literature | |||||
![]() ![]() |
0..* | BackboneElement | General specifications for this substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | markdown | The description or justification in support of the interpretation of the data 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 | |||||
![]() ![]() |
0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | |||||
![]() ![]() |
0..1 | BackboneElement | Structural information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | |||||
![]() ![]() ![]() |
0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | |||||
![]() ![]() ![]() |
0..1 | string | Specified per moiety according to the Hill system | |||||
![]() ![]() ![]() |
0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Source of information for the structure | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | A depiction of the structure of the substance | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: SubstanceRepresentationType (example): A format of a substance representation. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The structural representation as a text string in a standard 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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES (extensions allowed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | |||||
![]() ![]() |
0..* | BackboneElement | Codes associated with the substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The specific code | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | UNII | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | CAS | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | EU-SRS | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | GSID | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() |
0..1 | dateTime | The date at which the code status was changed | |||||
![]() ![]() ![]() |
0..* | Annotation | Any comment can be provided in this field | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Supporting literature | |||||
![]() ![]() |
1..* | BackboneElement | Names applicable to this substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..1 | string | The actual name | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() |
1..1 | boolean | If this is the preferred name for this substance | |||||
![]() ![]() ![]() |
1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
| |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | |||||
![]() ![]() ![]() |
0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | |||||
![]() ![]() ![]() |
0..* | See name (SubstanceDefinition) | A translation for this name into another human language | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Details of the official nature of this name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority Value Set (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date of official name change | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Supporting literature | |||||
![]() ![]() |
0..* | BackboneElement | A link between this substance and another | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | A pointer to another substance, as a resource or a representational code | ||||||
![]() ![]() ![]() ![]() |
Reference(SubstanceDefinition) | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types. | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | Ratio | For use when the numeric has an uncertain range | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types. | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Supporting literature | |||||
![]() ![]() |
0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | |||||
![]() ![]() |
0..1 | Reference(SubstancePolymer) | Data items specific to polymers | |||||
![]() ![]() |
0..1 | Reference(SubstanceProtein) | Data items specific to proteins | |||||
Documentation for this format | ||||||||
| 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. |
| 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:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() |
1..1 | id | Logical id of this artifact | |||||
![]() ![]() |
1..1 | Identifier | Identifier by which this substance is known | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |||||
![]() ![]() |
1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() |
1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | |||||
![]() ![]() |
1..* | BackboneElement | Names applicable to this substance | |||||
![]() ![]() ![]() |
1..1 | string | The actual name | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() |
1..1 | boolean | If this is the preferred name for this substance | |||||
![]() ![]() ![]() |
1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
| |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Details of the official nature of this name | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority Value Set (extensible) | |||||
Documentation for this format | ||||||||
| 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 |
| Id | Grade | Path(s) | Description | Expression |
Differential View
This structure is derived from SubstanceDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | |
![]() ![]() |
1..1 | id | Logical id of this artifact | |
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | uri | Identifies where the resource comes from | |
![]() ![]() |
0..0 | A set of rules under which this content was created | ||
![]() ![]() |
0..0 | Contained, inline Resources | ||
![]() ![]() |
0..0 | Extension | ||
![]() ![]() |
1..1 | Identifier | Identifier by which this substance is known | |
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |
![]() ![]() |
0..0 | A business level version identifier of the substance | ||
![]() ![]() |
1..1 | CodeableConcept | draft|active|retired | |
![]() ![]() |
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 | ||
![]() ![]() |
1..1 | CodeableConcept | If the substance applies to human or veterinary use | |
![]() ![]() |
0..0 | The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) | ||
![]() ![]() |
0..0 | Textual description of the substance | ||
![]() ![]() |
0..0 | Textual comment about the substance's catalogue or registry record | ||
![]() ![]() |
0..0 | The entity that creates, makes, produces or fabricates the substance | ||
![]() ![]() |
0..0 | An entity that is the source for the substance. It may be different from the manufacturer | ||
![]() ![]() |
0..0 | Moiety, for structural modifications | ||
![]() ![]() |
0..0 | General specifications for this substance | ||
![]() ![]() |
0..0 | The average mass of a molecule of a compound | ||
![]() ![]() |
||||
![]() ![]() ![]() |
1..1 | BackboneElement | A depiction of the structure of the substance | |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES (extensions allowed) | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | UNII | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii (extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | CAS | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | EU-SRS | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed) | |
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | GSID | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |
![]() ![]() |
1..* | BackboneElement | Names applicable to this substance | |
![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() |
0..1 | CodeableConcept | name status | |
![]() ![]() ![]() |
1..1 | boolean | If this is the preferred name for this substance | |
![]() ![]() ![]() |
1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required) | |
![]() ![]() ![]() |
1..1 | BackboneElement | Details of the official nature of this name | |
![]() ![]() ![]() ![]() |
0..0 | Extension | ||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority Value Set (extensible) | |
![]() ![]() |
0..0 | Material or taxonomic/anatomical source | ||
Documentation for this format | ||||
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing | |||||
![]() ![]() |
1..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
1..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
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". | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
1..1 | Identifier | Identifier by which this substance is known | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..1 | uri | The namespace for the identifier value Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |||||
![]() ![]() ![]() |
C | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
0..1 | Period | Time period when id is/was valid for use | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||
![]() ![]() |
1..1 | CodeableConcept | draft|active|retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() |
1..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | |||||
![]() ![]() |
0..* | Reference(Citation) | Supporting literature | |||||
![]() ![]() |
0..* | BackboneElement | General specifications for this substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
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) | |||||
![]() ![]() ![]() |
0..1 | markdown | The description or justification in support of the interpretation of the data 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 | |||||
![]() ![]() |
0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | |||||
![]() ![]() |
0..1 | BackboneElement | Structural information | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | |||||
![]() ![]() ![]() |
0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | |||||
![]() ![]() ![]() |
0..1 | string | Specified per moiety according to the Hill system | |||||
![]() ![]() ![]() |
0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range | |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Source of information for the structure | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | A depiction of the structure of the substance | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: SubstanceRepresentationType (example): A format of a substance representation. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | The structural representation as a text string in a standard 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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Coding | Code defined by a terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | Symbol in syntax defined by the system Required Pattern: SMILES (extensions allowed) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | |||||
![]() ![]() |
0..* | BackboneElement | Codes associated with the substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The specific code | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | UNII | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: https://open.fda.gov/data/unii (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | CAS | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/CAS (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | EU-SRS | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://spor.azure-api.net/sms/api/v2/SubstanceDefinition (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Coding | GSID | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://umcterminologies.org/gsid (extensions allowed) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
C | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() |
0..1 | dateTime | The date at which the code status was changed | |||||
![]() ![]() ![]() |
0..* | Annotation | Any comment can be provided in this field | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Supporting literature | |||||
![]() ![]() |
1..* | BackboneElement | Names applicable to this substance | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
1..1 | string | The actual name | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | name status Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() |
1..1 | boolean | If this is the preferred name for this substance | |||||
![]() ![]() ![]() |
1..* | CodeableConcept | Human language that the name is written in Binding: CommonLanguages (required)
| |||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | |||||
![]() ![]() ![]() |
0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | |||||
![]() ![]() ![]() |
0..* | See name (SubstanceDefinition) | A translation for this name into another human language | |||||
![]() ![]() ![]() |
1..1 | BackboneElement | Details of the official nature of this name | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Which authority uses this official name Binding: Substance Name Authority Value Set (extensible) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date of official name change | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Supporting literature | |||||
![]() ![]() |
0..* | BackboneElement | A link between this substance and another | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | A pointer to another substance, as a resource or a representational code | ||||||
![]() ![]() ![]() ![]() |
Reference(SubstanceDefinition) | |||||||
![]() ![]() ![]() ![]() |
CodeableConcept | |||||||
![]() ![]() ![]() |
1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types. | |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
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 | ||||||
![]() ![]() ![]() ![]() |
Quantity | |||||||
![]() ![]() ![]() ![]() |
Ratio | |||||||
![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() |
0..1 | Ratio | For use when the numeric has an uncertain range | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types. | |||||
![]() ![]() ![]() |
0..* | Reference(DocumentReference) | Supporting literature | |||||
![]() ![]() |
0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | |||||
![]() ![]() |
0..1 | Reference(SubstancePolymer) | Data items specific to polymers | |||||
![]() ![]() |
0..1 | Reference(SubstanceProtein) | Data items specific to proteins | |||||
Documentation for this format | ||||||||
| 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. |
| 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:
Other representations of profile: CSV, Excel, Schematron