Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC)
0.1.20 - Build CI United States of America flag

Pharmaceutical Quality Submissions to Food & Drug Administration (PQ/CMC), published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.20 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/FHIR-us-pq-cmc/ and changes regularly. See the Directory of published versions

Resource Profile: Routine Drug Substance

Official URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-routine-drug-substance Version: 0.1.20
Draft as of 2024-03-04 Computable Name: RoutineSubstanceDefinition

Provides sufficient information to identify a drug substance. Profile on Drug Substance profile.

Usage:

Formal Views of Profile Content

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

This structure is derived from SubstanceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition C0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
cmc-name-isbt: Name.type ISBT 128 required for blood products.
... identifier S0..1Identifieroptional user designated identifier
... classification S1..*CodeableConceptSubstance Type
Binding: EVMPD Substance Classification (required)
... grade 1..1CodeableConceptQuality Standard
.... coding 0..*CodingCode defined by a terminology system
Binding: Quality Standard Terminology (required)
... supplier S0..1Reference(Supplier Organization)An entity that is the source for the substance. It may be different from the manufacturer
... code S1..*BackboneElementCodes associated with the substance
.... code S1..1CodeableConceptThe specific code
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:unii 0..1CodingUNII
....... system 1..1uriIdentity of the terminology system
Required Pattern: https://gsrs.ncats.nih.gov
...... coding:uniProt 0..1CodingUniProt ID
....... system 1..1uriIdentity of the terminology system
Required Pattern: https://www.uniprot.org
... Slices for name SC1..*BackboneElementSubstance Name
Slice: Unordered, Closed by value:type.coding
cmc-name-preferred: Name.preferred: at most one = true
.... name:All Slices Content/Rules for all slices
..... preferred S0..1booleanTrue when the name type is Substance Name
.... name:sub S0..1BackboneElementNames applicable to this substance
..... name S1..1stringGeneric Name
..... type S1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
...... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C97054
....... display1..1stringRepresentation defined by the system
Fixed Value: Generic Name
..... preferred S0..1booleanIf this is the preferred name for this substance
.... name:gsrs S0..1BackboneElementNames applicable to this substance
..... name S1..1stringGSRS Preferred Term
..... type S1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
...... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C203355
....... display1..1stringRepresentation defined by the system
Fixed Value: GSRS Preferred Term
..... preferred S0..1booleanIf this is the preferred name for this substance
.... name:isbt S0..1BackboneElementNames applicable to this substance
..... name S1..1stringISBT-128 DIN
..... type S1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
...... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C95517
....... display1..1stringRepresentation defined by the system
Fixed Value: ISBT-128 DIN
..... preferred S0..1booleanIf this is the preferred name for this substance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SubstanceDefinition.classificationrequiredEVMPDSubstanceClassification
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/evmpd-substance-classification
from this IG
SubstanceDefinition.grade.codingrequiredPqcmcQualityBenchmarkTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-quality-benchmark-terminology
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmc-name-isbterrorSubstanceDefinitionName.type ISBT 128 required for blood products.
: classification.where(coding.where(code = '8' and system = 'https://www.ema.europa.eu').exists()).exists() implies name.type.coding.exists(code = '226' and system = 'http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy')
cmc-name-preferrederrorSubstanceDefinition.nameName.preferred: at most one = true
: select(preferred = true).count() < 2
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition C0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
cmc-name-isbt: Name.type ISBT 128 required for blood products.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... classification SΣ1..*CodeableConceptSubstance Type
Binding: EVMPD Substance Classification (required)
... grade Σ1..1CodeableConceptQuality Standard
Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies


.... coding Σ0..*CodingCode defined by a terminology system
Binding: Quality Standard Terminology (required)
... manufacturer SΣ1..1Reference(Manufacturing and/or Test Site Organization)The entity that creates, makes, produces or fabricates the substance
... supplier SΣ0..1Reference(Supplier Organization)An entity that is the source for the substance. It may be different from the manufacturer
... code SΣ1..*BackboneElementCodes associated with the substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptThe specific code
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:unii Σ0..1CodingUNII
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://gsrs.ncats.nih.gov
...... coding:uniProt Σ0..1CodingUniProt ID
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.uniprot.org
... Slices for name SΣC1..*BackboneElementSubstance Name
Slice: Unordered, Closed by value:type.coding
cmc-name-preferred: Name.preferred: at most one = true
.... name:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringThe actual name
..... preferred SΣ0..1booleanTrue when the name type is Substance Name
.... name:sub SΣ0..1BackboneElementNames applicable to this substance
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGeneric Name
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C97054
....... display1..1stringRepresentation defined by the system
Fixed Value: Generic Name
..... preferred SΣ0..1booleanIf this is the preferred name for this substance
.... name:gsrs SΣ0..1BackboneElementNames applicable to this substance
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGSRS Preferred Term
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C203355
....... display1..1stringRepresentation defined by the system
Fixed Value: GSRS Preferred Term
..... preferred SΣ0..1booleanIf this is the preferred name for this substance
.... name:isbt SΣ0..1BackboneElementNames applicable to this substance
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringISBT-128 DIN
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C95517
....... display1..1stringRepresentation defined by the system
Fixed Value: ISBT-128 DIN
..... preferred SΣ0..1booleanIf this is the preferred name for this substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubstanceDefinition.classificationrequiredEVMPDSubstanceClassification
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/evmpd-substance-classification
from this IG
SubstanceDefinition.gradeexampleSubstanceGrade
http://hl7.org/fhir/ValueSet/substance-grade
from the FHIR Standard
SubstanceDefinition.grade.codingrequiredPqcmcQualityBenchmarkTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-quality-benchmark-terminology
from this IG
SubstanceDefinition.name:sub.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:gsrs.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:isbt.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmc-name-isbterrorSubstanceDefinitionName.type ISBT 128 required for blood products.
: classification.where(coding.where(code = '8' and system = 'https://www.ema.europa.eu').exists()).exists() implies name.type.coding.exists(code = '226' and system = 'http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy')
cmc-name-preferrederrorSubstanceDefinition.nameName.preferred: at most one = true
: select(preferred = true).count() < 2
dom-2errorSubstanceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceDefinitionIf 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-4errorSubstanceDefinitionIf 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-5errorSubstanceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition C0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
cmc-name-isbt: Name.type ISBT 128 required for blood products.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1Identifieroptional user designated identifier
... version Σ0..1stringA business level version identifier of the substance
... status Σ0..1CodeableConceptStatus of substance within the catalogue e.g. active, retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... classification SΣ1..*CodeableConceptSubstance Type
Binding: EVMPD Substance Classification (required)
... domain Σ0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).

... grade Σ1..1CodeableConceptQuality Standard
Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies


.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Quality Standard Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1markdownTextual description of the substance
... informationSource Σ0..*Reference(Citation)Supporting literature
... note Σ0..*AnnotationTextual comment about the substance's catalogue or registry record
... manufacturer SΣ1..1Reference(Manufacturing and/or Test Site Organization)The entity that creates, makes, produces or fabricates the substance
... supplier SΣ0..1Reference(Supplier Organization)An entity that is the source for the substance. It may be different from the manufacturer
... moiety Σ0..*BackboneElementMoiety, for structural modifications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ0..1CodeableConceptRole that the moiety is playing
.... identifier Σ0..1IdentifierIdentifier by which this moiety substance is known
.... name Σ0..1stringTextual name for this moiety substance
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
Binding: Stereochemistry (example): The optical rotation type of a substance.

.... opticalActivity Σ0..1CodeableConceptOptical activity type
Binding: OpticalActivity (example): The optical rotation type of a substance.

.... molecularFormula Σ0..1stringMolecular formula for this moiety (e.g. with the Hill system)
.... amount[x] Σ0..1Quantitative value for this moiety
..... amountQuantityQuantity
..... amountStringstring
.... measurementType Σ0..1CodeableConceptThe measurement type of the quantitative value
Binding: SubstanceAmountType (example): The relationship between two substance types.

... characterization Σ0..*BackboneElementGeneral specifications for this substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... technique Σ0..1CodeableConceptThe 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..1CodeableConceptDescribes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form
Binding: SubstanceForm (example)
.... description Σ0..1markdownThe description or justification in support of the interpretation of the data file
.... file Σ0..*AttachmentThe 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..*BackboneElementGeneral specifications for this substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptA 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..1A value for the property
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueDatedate
..... valueBooleanboolean
..... valueAttachmentAttachment
... referenceInformation Σ0..1Reference(SubstanceReferenceInformation)General information detailing this substance
... molecularWeight Σ0..*BackboneElementThe average mass of a molecule of a compound
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... method Σ0..1CodeableConceptThe method by which the weight was determined
Binding: WeightMethod (example): The method by which the substance weight was measured.

.... type Σ0..1CodeableConceptType of molecular weight e.g. exact, average, weight average
Binding: WeightType (example): The type of substance weight measurement.

.... amount Σ1..1QuantityUsed to capture quantitative values for a variety of elements
... structure Σ0..1BackboneElementStructural information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
Binding: Stereochemistry (example): The optical rotation type of a substance.

.... opticalActivity Σ0..1CodeableConceptOptical activity type
Binding: OpticalActivity (example): The optical rotation type of a substance.

.... molecularFormula Σ0..1stringAn expression which states the number and type of atoms present in a molecule of a substance
.... molecularFormulaByMoiety Σ0..1stringSpecified per moiety according to the Hill system
.... molecularWeight Σ0..1See molecularWeight (SubstanceDefinition)The molecular weight or weight range
.... technique Σ0..*CodeableConceptThe 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 Σ0..*BackboneElementA depiction of the structure of the substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..1CodeableConceptThe kind of structural representation (e.g. full, partial)
Binding: SubstanceRepresentationType (example): A format of a substance representation.

..... representation Σ0..1stringThe structural representation as a text string in a standard format
..... format Σ0..1CodeableConceptThe format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)
Binding: SubstanceRepresentationFormat (example): A format of a substance representation.

..... document Σ0..1Reference(DocumentReference)An attachment with the structural representation e.g. a structure graphic or AnIML file
... code SΣ1..*BackboneElementCodes associated with the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptThe specific code
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:unii Σ0..1CodingUNII
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://gsrs.ncats.nih.gov
....... version Σ0..1stringVersion of the system - if relevant
....... code ΣC0..1codeSymbol in syntax defined by the system
....... display ΣC0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:uniProt Σ0..1CodingUniProt ID
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.uniprot.org
....... version Σ0..1stringVersion of the system - if relevant
....... code ΣC0..1codeSymbol in syntax defined by the system
....... display ΣC0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... status Σ0..1CodeableConceptStatus of the code assignment, for example 'provisional', 'approved'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

.... statusDate Σ0..1dateTimeThe date at which the code status was changed
.... note Σ0..*AnnotationAny comment can be provided in this field
.... source Σ0..*Reference(DocumentReference)Supporting literature
... Slices for name SΣC1..*BackboneElementSubstance Name
Slice: Unordered, Closed by value:type.coding
cmc-name-preferred: Name.preferred: at most one = true
.... name:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringThe actual name
..... type Σ0..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanTrue when the name type is Substance Name
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
.... name:sub SΣ0..1BackboneElementNames applicable to this substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGeneric Name
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C97054
....... display1..1stringRepresentation defined by the system
Fixed Value: Generic Name
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanIf this is the preferred name for this substance
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
.... name:gsrs SΣ0..1BackboneElementNames applicable to this substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGSRS Preferred Term
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C203355
....... display1..1stringRepresentation defined by the system
Fixed Value: GSRS Preferred Term
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanIf this is the preferred name for this substance
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
.... name:isbt SΣ0..1BackboneElementNames applicable to this substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringISBT-128 DIN
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C95517
....... display1..1stringRepresentation defined by the system
Fixed Value: ISBT-128 DIN
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanIf this is the preferred name for this substance
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
... relationship Σ0..*BackboneElementA link between this substance and another
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substanceDefinition[x] Σ0..1A pointer to another substance, as a resource or a representational code
..... substanceDefinitionReferenceReference(SubstanceDefinition)
..... substanceDefinitionCodeableConceptCodeableConcept
.... type Σ1..1CodeableConceptFor example "salt to parent", "active moiety"
Binding: SubstanceRelationshipType (example): The relationship between two substance types.

.... isDefining Σ0..1booleanFor 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..1A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other
..... amountQuantityQuantity
..... amountRatioRatio
..... amountStringstring
.... ratioHighLimitAmount Σ0..1RatioFor use when the numeric has an uncertain range
.... comparator Σ0..1CodeableConceptAn 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..1Reference(SubstanceNucleicAcid)Data items specific to nucleic acids
... polymer Σ0..1Reference(SubstancePolymer)Data items specific to polymers
... protein Σ0..1Reference(SubstanceProtein)Data items specific to proteins
... sourceMaterial Σ0..1BackboneElementMaterial or taxonomic/anatomical source
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptClassification 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..1CodeableConceptThe 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..1CodeableConceptThe 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..1CodeableConceptAn anatomical origin of the source material within an organism
Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism.

.... countryOfOrigin Σ0..*CodeableConceptThe country or countries where the material is harvested
Binding: CountryValueSet (required): Jurisdiction codes



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubstanceDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.classificationrequiredEVMPDSubstanceClassification
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/evmpd-substance-classification
from this IG
SubstanceDefinition.domainexampleMedicinalProductDomain
http://hl7.org/fhir/ValueSet/medicinal-product-domain
from the FHIR Standard
SubstanceDefinition.gradeexampleSubstanceGrade
http://hl7.org/fhir/ValueSet/substance-grade
from the FHIR Standard
SubstanceDefinition.grade.codingrequiredPqcmcQualityBenchmarkTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-quality-benchmark-terminology
from this IG
SubstanceDefinition.moiety.stereochemistryexampleStereochemistry
http://hl7.org/fhir/ValueSet/substance-stereochemistry
from the FHIR Standard
SubstanceDefinition.moiety.opticalActivityexampleOpticalActivity
http://hl7.org/fhir/ValueSet/substance-optical-activity
from the FHIR Standard
SubstanceDefinition.moiety.measurementTypeexampleSubstanceAmountType
http://hl7.org/fhir/ValueSet/substance-amount-type
from the FHIR Standard
SubstanceDefinition.characterization.techniqueexampleStructureTechnique
http://hl7.org/fhir/ValueSet/substance-structure-technique
from the FHIR Standard
SubstanceDefinition.characterization.formexampleSubstanceForm
http://hl7.org/fhir/ValueSet/substance-form
from the FHIR Standard
SubstanceDefinition.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
SubstanceDefinition.molecularWeight.methodexampleWeightMethod
http://hl7.org/fhir/ValueSet/substance-weight-method
from the FHIR Standard
SubstanceDefinition.molecularWeight.typeexampleWeightType
http://hl7.org/fhir/ValueSet/substance-weight-type
from the FHIR Standard
SubstanceDefinition.structure.stereochemistryexampleStereochemistry
http://hl7.org/fhir/ValueSet/substance-stereochemistry
from the FHIR Standard
SubstanceDefinition.structure.opticalActivityexampleOpticalActivity
http://hl7.org/fhir/ValueSet/substance-optical-activity
from the FHIR Standard
SubstanceDefinition.structure.techniqueexampleStructureTechnique
http://hl7.org/fhir/ValueSet/substance-structure-technique
from the FHIR Standard
SubstanceDefinition.structure.representation.typeexampleSubstanceRepresentationType
http://hl7.org/fhir/ValueSet/substance-representation-type
from the FHIR Standard
SubstanceDefinition.structure.representation.formatexampleSubstanceRepresentationFormat
http://hl7.org/fhir/ValueSet/substance-representation-format
from the FHIR Standard
SubstanceDefinition.code.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:sub.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:sub.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:sub.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name:sub.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name:sub.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name:sub.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name:sub.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:gsrs.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:gsrs.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:gsrs.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name:gsrs.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name:gsrs.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name:gsrs.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name:gsrs.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:isbt.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:isbt.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:isbt.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name:isbt.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name:isbt.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name:isbt.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name:isbt.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.relationship.typeexampleSubstanceRelationshipType
http://hl7.org/fhir/ValueSet/substance-relationship-type
from the FHIR Standard
SubstanceDefinition.relationship.comparatorexampleSubstanceAmountType
http://hl7.org/fhir/ValueSet/substance-amount-type
from the FHIR Standard
SubstanceDefinition.sourceMaterial.typeexampleSourceMaterialType
http://hl7.org/fhir/ValueSet/substance-source-material-type
from the FHIR Standard
SubstanceDefinition.sourceMaterial.genusexampleSourceMaterialGenus
http://hl7.org/fhir/ValueSet/substance-source-material-genus
from the FHIR Standard
SubstanceDefinition.sourceMaterial.speciesexampleSourceMaterialSpecies
http://hl7.org/fhir/ValueSet/substance-source-material-species
from the FHIR Standard
SubstanceDefinition.sourceMaterial.partexampleSourceMaterialPart
http://hl7.org/fhir/ValueSet/substance-source-material-part
from the FHIR Standard
SubstanceDefinition.sourceMaterial.countryOfOriginrequiredCountryValueSet
http://hl7.org/fhir/ValueSet/country|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmc-name-isbterrorSubstanceDefinitionName.type ISBT 128 required for blood products.
: classification.where(coding.where(code = '8' and system = 'https://www.ema.europa.eu').exists()).exists() implies name.type.coding.exists(code = '226' and system = 'http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy')
cmc-name-preferrederrorSubstanceDefinition.nameName.preferred: at most one = true
: select(preferred = true).count() < 2
dom-2errorSubstanceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceDefinitionIf 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-4errorSubstanceDefinitionIf 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-5errorSubstanceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SubstanceDefinition

Summary

Mandatory: 6 elements (8 nested mandatory elements)
Must-Support: 23 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element SubstanceDefinition.code.code.coding is sliced based on the value of value:system
  • The element SubstanceDefinition.name is sliced based on the value of value:type.coding (Closed)

Differential View

This structure is derived from SubstanceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition C0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
cmc-name-isbt: Name.type ISBT 128 required for blood products.
... identifier S0..1Identifieroptional user designated identifier
... classification S1..*CodeableConceptSubstance Type
Binding: EVMPD Substance Classification (required)
... grade 1..1CodeableConceptQuality Standard
.... coding 0..*CodingCode defined by a terminology system
Binding: Quality Standard Terminology (required)
... supplier S0..1Reference(Supplier Organization)An entity that is the source for the substance. It may be different from the manufacturer
... code S1..*BackboneElementCodes associated with the substance
.... code S1..1CodeableConceptThe specific code
..... Slices for coding 0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:unii 0..1CodingUNII
....... system 1..1uriIdentity of the terminology system
Required Pattern: https://gsrs.ncats.nih.gov
...... coding:uniProt 0..1CodingUniProt ID
....... system 1..1uriIdentity of the terminology system
Required Pattern: https://www.uniprot.org
... Slices for name SC1..*BackboneElementSubstance Name
Slice: Unordered, Closed by value:type.coding
cmc-name-preferred: Name.preferred: at most one = true
.... name:All Slices Content/Rules for all slices
..... preferred S0..1booleanTrue when the name type is Substance Name
.... name:sub S0..1BackboneElementNames applicable to this substance
..... name S1..1stringGeneric Name
..... type S1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
...... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C97054
....... display1..1stringRepresentation defined by the system
Fixed Value: Generic Name
..... preferred S0..1booleanIf this is the preferred name for this substance
.... name:gsrs S0..1BackboneElementNames applicable to this substance
..... name S1..1stringGSRS Preferred Term
..... type S1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
...... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C203355
....... display1..1stringRepresentation defined by the system
Fixed Value: GSRS Preferred Term
..... preferred S0..1booleanIf this is the preferred name for this substance
.... name:isbt S0..1BackboneElementNames applicable to this substance
..... name S1..1stringISBT-128 DIN
..... type S1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
...... coding S1..1CodingCode defined by a terminology system
Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C95517
....... display1..1stringRepresentation defined by the system
Fixed Value: ISBT-128 DIN
..... preferred S0..1booleanIf this is the preferred name for this substance

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SubstanceDefinition.classificationrequiredEVMPDSubstanceClassification
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/evmpd-substance-classification
from this IG
SubstanceDefinition.grade.codingrequiredPqcmcQualityBenchmarkTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-quality-benchmark-terminology
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cmc-name-isbterrorSubstanceDefinitionName.type ISBT 128 required for blood products.
: classification.where(coding.where(code = '8' and system = 'https://www.ema.europa.eu').exists()).exists() implies name.type.coding.exists(code = '226' and system = 'http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy')
cmc-name-preferrederrorSubstanceDefinition.nameName.preferred: at most one = true
: select(preferred = true).count() < 2

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition C0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
cmc-name-isbt: Name.type ISBT 128 required for blood products.
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... classification SΣ1..*CodeableConceptSubstance Type
Binding: EVMPD Substance Classification (required)
... grade Σ1..1CodeableConceptQuality Standard
Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies


.... coding Σ0..*CodingCode defined by a terminology system
Binding: Quality Standard Terminology (required)
... manufacturer SΣ1..1Reference(Manufacturing and/or Test Site Organization)The entity that creates, makes, produces or fabricates the substance
... supplier SΣ0..1Reference(Supplier Organization)An entity that is the source for the substance. It may be different from the manufacturer
... code SΣ1..*BackboneElementCodes associated with the substance
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptThe specific code
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:unii Σ0..1CodingUNII
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://gsrs.ncats.nih.gov
...... coding:uniProt Σ0..1CodingUniProt ID
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.uniprot.org
... Slices for name SΣC1..*BackboneElementSubstance Name
Slice: Unordered, Closed by value:type.coding
cmc-name-preferred: Name.preferred: at most one = true
.... name:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringThe actual name
..... preferred SΣ0..1booleanTrue when the name type is Substance Name
.... name:sub SΣ0..1BackboneElementNames applicable to this substance
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGeneric Name
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C97054
....... display1..1stringRepresentation defined by the system
Fixed Value: Generic Name
..... preferred SΣ0..1booleanIf this is the preferred name for this substance
.... name:gsrs SΣ0..1BackboneElementNames applicable to this substance
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGSRS Preferred Term
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C203355
....... display1..1stringRepresentation defined by the system
Fixed Value: GSRS Preferred Term
..... preferred SΣ0..1booleanIf this is the preferred name for this substance
.... name:isbt SΣ0..1BackboneElementNames applicable to this substance
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringISBT-128 DIN
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C95517
....... display1..1stringRepresentation defined by the system
Fixed Value: ISBT-128 DIN
..... preferred SΣ0..1booleanIf this is the preferred name for this substance

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubstanceDefinition.classificationrequiredEVMPDSubstanceClassification
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/evmpd-substance-classification
from this IG
SubstanceDefinition.gradeexampleSubstanceGrade
http://hl7.org/fhir/ValueSet/substance-grade
from the FHIR Standard
SubstanceDefinition.grade.codingrequiredPqcmcQualityBenchmarkTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-quality-benchmark-terminology
from this IG
SubstanceDefinition.name:sub.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:gsrs.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:isbt.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmc-name-isbterrorSubstanceDefinitionName.type ISBT 128 required for blood products.
: classification.where(coding.where(code = '8' and system = 'https://www.ema.europa.eu').exists()).exists() implies name.type.coding.exists(code = '226' and system = 'http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy')
cmc-name-preferrederrorSubstanceDefinition.nameName.preferred: at most one = true
: select(preferred = true).count() < 2
dom-2errorSubstanceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceDefinitionIf 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-4errorSubstanceDefinitionIf 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-5errorSubstanceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition C0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
cmc-name-isbt: Name.type ISBT 128 required for blood products.
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... identifier SΣ0..1Identifieroptional user designated identifier
... version Σ0..1stringA business level version identifier of the substance
... status Σ0..1CodeableConceptStatus of substance within the catalogue e.g. active, retired
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... classification SΣ1..*CodeableConceptSubstance Type
Binding: EVMPD Substance Classification (required)
... domain Σ0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary).

... grade Σ1..1CodeableConceptQuality Standard
Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies


.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ0..*CodingCode defined by a terminology system
Binding: Quality Standard Terminology (required)
.... text Σ0..1stringPlain text representation of the concept
... description Σ0..1markdownTextual description of the substance
... informationSource Σ0..*Reference(Citation)Supporting literature
... note Σ0..*AnnotationTextual comment about the substance's catalogue or registry record
... manufacturer SΣ1..1Reference(Manufacturing and/or Test Site Organization)The entity that creates, makes, produces or fabricates the substance
... supplier SΣ0..1Reference(Supplier Organization)An entity that is the source for the substance. It may be different from the manufacturer
... moiety Σ0..*BackboneElementMoiety, for structural modifications
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... role Σ0..1CodeableConceptRole that the moiety is playing
.... identifier Σ0..1IdentifierIdentifier by which this moiety substance is known
.... name Σ0..1stringTextual name for this moiety substance
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
Binding: Stereochemistry (example): The optical rotation type of a substance.

.... opticalActivity Σ0..1CodeableConceptOptical activity type
Binding: OpticalActivity (example): The optical rotation type of a substance.

.... molecularFormula Σ0..1stringMolecular formula for this moiety (e.g. with the Hill system)
.... amount[x] Σ0..1Quantitative value for this moiety
..... amountQuantityQuantity
..... amountStringstring
.... measurementType Σ0..1CodeableConceptThe measurement type of the quantitative value
Binding: SubstanceAmountType (example): The relationship between two substance types.

... characterization Σ0..*BackboneElementGeneral specifications for this substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... technique Σ0..1CodeableConceptThe 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..1CodeableConceptDescribes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form
Binding: SubstanceForm (example)
.... description Σ0..1markdownThe description or justification in support of the interpretation of the data file
.... file Σ0..*AttachmentThe 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..*BackboneElementGeneral specifications for this substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1CodeableConceptA 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..1A value for the property
..... valueCodeableConceptCodeableConcept
..... valueQuantityQuantity
..... valueDatedate
..... valueBooleanboolean
..... valueAttachmentAttachment
... referenceInformation Σ0..1Reference(SubstanceReferenceInformation)General information detailing this substance
... molecularWeight Σ0..*BackboneElementThe average mass of a molecule of a compound
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... method Σ0..1CodeableConceptThe method by which the weight was determined
Binding: WeightMethod (example): The method by which the substance weight was measured.

.... type Σ0..1CodeableConceptType of molecular weight e.g. exact, average, weight average
Binding: WeightType (example): The type of substance weight measurement.

.... amount Σ1..1QuantityUsed to capture quantitative values for a variety of elements
... structure Σ0..1BackboneElementStructural information
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... stereochemistry Σ0..1CodeableConceptStereochemistry type
Binding: Stereochemistry (example): The optical rotation type of a substance.

.... opticalActivity Σ0..1CodeableConceptOptical activity type
Binding: OpticalActivity (example): The optical rotation type of a substance.

.... molecularFormula Σ0..1stringAn expression which states the number and type of atoms present in a molecule of a substance
.... molecularFormulaByMoiety Σ0..1stringSpecified per moiety according to the Hill system
.... molecularWeight Σ0..1See molecularWeight (SubstanceDefinition)The molecular weight or weight range
.... technique Σ0..*CodeableConceptThe 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 Σ0..*BackboneElementA depiction of the structure of the substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ0..1CodeableConceptThe kind of structural representation (e.g. full, partial)
Binding: SubstanceRepresentationType (example): A format of a substance representation.

..... representation Σ0..1stringThe structural representation as a text string in a standard format
..... format Σ0..1CodeableConceptThe format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)
Binding: SubstanceRepresentationFormat (example): A format of a substance representation.

..... document Σ0..1Reference(DocumentReference)An attachment with the structural representation e.g. a structure graphic or AnIML file
... code SΣ1..*BackboneElementCodes associated with the substance
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code SΣ1..1CodeableConceptThe specific code
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... Slices for coding Σ0..*CodingCode defined by a terminology system
Slice: Unordered, Open by value:system
...... coding:unii Σ0..1CodingUNII
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://gsrs.ncats.nih.gov
....... version Σ0..1stringVersion of the system - if relevant
....... code ΣC0..1codeSymbol in syntax defined by the system
....... display ΣC0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... coding:uniProt Σ0..1CodingUniProt ID
....... id 0..1idUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... system Σ1..1uriIdentity of the terminology system
Required Pattern: https://www.uniprot.org
....... version Σ0..1stringVersion of the system - if relevant
....... code ΣC0..1codeSymbol in syntax defined by the system
....... display ΣC0..1stringRepresentation defined by the system
....... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... text Σ0..1stringPlain text representation of the concept
.... status Σ0..1CodeableConceptStatus of the code assignment, for example 'provisional', 'approved'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

.... statusDate Σ0..1dateTimeThe date at which the code status was changed
.... note Σ0..*AnnotationAny comment can be provided in this field
.... source Σ0..*Reference(DocumentReference)Supporting literature
... Slices for name SΣC1..*BackboneElementSubstance Name
Slice: Unordered, Closed by value:type.coding
cmc-name-preferred: Name.preferred: at most one = true
.... name:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringThe actual name
..... type Σ0..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanTrue when the name type is Substance Name
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
.... name:sub SΣ0..1BackboneElementNames applicable to this substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGeneric Name
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C97054
....... display1..1stringRepresentation defined by the system
Fixed Value: Generic Name
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanIf this is the preferred name for this substance
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
.... name:gsrs SΣ0..1BackboneElementNames applicable to this substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringGSRS Preferred Term
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C203355
....... display1..1stringRepresentation defined by the system
Fixed Value: GSRS Preferred Term
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanIf this is the preferred name for this substance
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
.... name:isbt SΣ0..1BackboneElementNames applicable to this substance
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringISBT-128 DIN
..... type SΣ1..1CodeableConceptName type e.g. 'systematic', 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.

...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding SΣ1..1CodingCode defined by a terminology system

Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... system1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy
....... version0..1stringVersion of the system - if relevant
....... code1..1codeSymbol in syntax defined by the system
Fixed Value: C95517
....... display1..1stringRepresentation defined by the system
Fixed Value: ISBT-128 DIN
....... userSelected0..1booleanIf this coding was chosen directly by the user
...... text Σ0..1stringPlain text representation of the concept
..... status Σ0..1CodeableConceptThe status of the name e.g. 'current', 'proposed'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

..... preferred SΣ0..1booleanIf this is the preferred name for this substance
..... language Σ0..*CodeableConceptHuman language that the name is written in
Binding: AllLanguages (required): IETF language tag for a human language

Additional BindingsPurpose
CommonLanguagesStarter Set

..... domain Σ0..*CodeableConceptThe 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..*CodeableConceptThe 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 Σ0..*BackboneElementDetails of the official nature of this name
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... authority Σ0..1CodeableConceptWhich authority uses this official name
Binding: SubstanceNameAuthority (preferred): An authority that officates substance names.

...... status Σ0..1CodeableConceptThe status of the official name, for example 'draft', 'active'
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

...... date Σ0..1dateTimeDate of official name change
..... source Σ0..*Reference(DocumentReference)Supporting literature
... relationship Σ0..*BackboneElementA link between this substance and another
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... substanceDefinition[x] Σ0..1A pointer to another substance, as a resource or a representational code
..... substanceDefinitionReferenceReference(SubstanceDefinition)
..... substanceDefinitionCodeableConceptCodeableConcept
.... type Σ1..1CodeableConceptFor example "salt to parent", "active moiety"
Binding: SubstanceRelationshipType (example): The relationship between two substance types.

.... isDefining Σ0..1booleanFor 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..1A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other
..... amountQuantityQuantity
..... amountRatioRatio
..... amountStringstring
.... ratioHighLimitAmount Σ0..1RatioFor use when the numeric has an uncertain range
.... comparator Σ0..1CodeableConceptAn 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..1Reference(SubstanceNucleicAcid)Data items specific to nucleic acids
... polymer Σ0..1Reference(SubstancePolymer)Data items specific to polymers
... protein Σ0..1Reference(SubstanceProtein)Data items specific to proteins
... sourceMaterial Σ0..1BackboneElementMaterial or taxonomic/anatomical source
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ0..1CodeableConceptClassification 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..1CodeableConceptThe 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..1CodeableConceptThe 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..1CodeableConceptAn anatomical origin of the source material within an organism
Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism.

.... countryOfOrigin Σ0..*CodeableConceptThe country or countries where the material is harvested
Binding: CountryValueSet (required): Jurisdiction codes



doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SubstanceDefinition.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.classificationrequiredEVMPDSubstanceClassification
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/evmpd-substance-classification
from this IG
SubstanceDefinition.domainexampleMedicinalProductDomain
http://hl7.org/fhir/ValueSet/medicinal-product-domain
from the FHIR Standard
SubstanceDefinition.gradeexampleSubstanceGrade
http://hl7.org/fhir/ValueSet/substance-grade
from the FHIR Standard
SubstanceDefinition.grade.codingrequiredPqcmcQualityBenchmarkTerminology
http://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-quality-benchmark-terminology
from this IG
SubstanceDefinition.moiety.stereochemistryexampleStereochemistry
http://hl7.org/fhir/ValueSet/substance-stereochemistry
from the FHIR Standard
SubstanceDefinition.moiety.opticalActivityexampleOpticalActivity
http://hl7.org/fhir/ValueSet/substance-optical-activity
from the FHIR Standard
SubstanceDefinition.moiety.measurementTypeexampleSubstanceAmountType
http://hl7.org/fhir/ValueSet/substance-amount-type
from the FHIR Standard
SubstanceDefinition.characterization.techniqueexampleStructureTechnique
http://hl7.org/fhir/ValueSet/substance-structure-technique
from the FHIR Standard
SubstanceDefinition.characterization.formexampleSubstanceForm
http://hl7.org/fhir/ValueSet/substance-form
from the FHIR Standard
SubstanceDefinition.property.typeexampleProductCharacteristic
http://hl7.org/fhir/ValueSet/product-characteristic-codes
from the FHIR Standard
SubstanceDefinition.molecularWeight.methodexampleWeightMethod
http://hl7.org/fhir/ValueSet/substance-weight-method
from the FHIR Standard
SubstanceDefinition.molecularWeight.typeexampleWeightType
http://hl7.org/fhir/ValueSet/substance-weight-type
from the FHIR Standard
SubstanceDefinition.structure.stereochemistryexampleStereochemistry
http://hl7.org/fhir/ValueSet/substance-stereochemistry
from the FHIR Standard
SubstanceDefinition.structure.opticalActivityexampleOpticalActivity
http://hl7.org/fhir/ValueSet/substance-optical-activity
from the FHIR Standard
SubstanceDefinition.structure.techniqueexampleStructureTechnique
http://hl7.org/fhir/ValueSet/substance-structure-technique
from the FHIR Standard
SubstanceDefinition.structure.representation.typeexampleSubstanceRepresentationType
http://hl7.org/fhir/ValueSet/substance-representation-type
from the FHIR Standard
SubstanceDefinition.structure.representation.formatexampleSubstanceRepresentationFormat
http://hl7.org/fhir/ValueSet/substance-representation-format
from the FHIR Standard
SubstanceDefinition.code.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:sub.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:sub.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:sub.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name:sub.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name:sub.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name:sub.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name:sub.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:gsrs.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:gsrs.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:gsrs.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name:gsrs.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name:gsrs.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name:gsrs.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name:gsrs.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:isbt.typeexampleSubstanceNameType
http://hl7.org/fhir/ValueSet/substance-name-type
from the FHIR Standard
SubstanceDefinition.name:isbt.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.name:isbt.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages|5.0.0
from the FHIR Standard
SubstanceDefinition.name:isbt.domainexampleSubstanceNameDomain
http://hl7.org/fhir/ValueSet/substance-name-domain
from the FHIR Standard
SubstanceDefinition.name:isbt.jurisdictionexampleJurisdictionValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
SubstanceDefinition.name:isbt.official.authoritypreferredSubstanceNameAuthority
http://hl7.org/fhir/ValueSet/substance-name-authority
from the FHIR Standard
SubstanceDefinition.name:isbt.official.statuspreferredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status
from the FHIR Standard
SubstanceDefinition.relationship.typeexampleSubstanceRelationshipType
http://hl7.org/fhir/ValueSet/substance-relationship-type
from the FHIR Standard
SubstanceDefinition.relationship.comparatorexampleSubstanceAmountType
http://hl7.org/fhir/ValueSet/substance-amount-type
from the FHIR Standard
SubstanceDefinition.sourceMaterial.typeexampleSourceMaterialType
http://hl7.org/fhir/ValueSet/substance-source-material-type
from the FHIR Standard
SubstanceDefinition.sourceMaterial.genusexampleSourceMaterialGenus
http://hl7.org/fhir/ValueSet/substance-source-material-genus
from the FHIR Standard
SubstanceDefinition.sourceMaterial.speciesexampleSourceMaterialSpecies
http://hl7.org/fhir/ValueSet/substance-source-material-species
from the FHIR Standard
SubstanceDefinition.sourceMaterial.partexampleSourceMaterialPart
http://hl7.org/fhir/ValueSet/substance-source-material-part
from the FHIR Standard
SubstanceDefinition.sourceMaterial.countryOfOriginrequiredCountryValueSet
http://hl7.org/fhir/ValueSet/country|5.0.0
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cmc-name-isbterrorSubstanceDefinitionName.type ISBT 128 required for blood products.
: classification.where(coding.where(code = '8' and system = 'https://www.ema.europa.eu').exists()).exists() implies name.type.coding.exists(code = '226' and system = 'http://hl7.org/fhir/us/pq-cmc-fda/CodeSystem/cmc-ncit-dummy')
cmc-name-preferrederrorSubstanceDefinition.nameName.preferred: at most one = true
: select(preferred = true).count() < 2
dom-2errorSubstanceDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSubstanceDefinitionIf 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-4errorSubstanceDefinitionIf 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-5errorSubstanceDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSubstanceDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SubstanceDefinition

Summary

Mandatory: 6 elements (8 nested mandatory elements)
Must-Support: 23 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element SubstanceDefinition.code.code.coding is sliced based on the value of value:system
  • The element SubstanceDefinition.name is sliced based on the value of value:type.coding (Closed)

 

Other representations of profile: CSV, Excel, Schematron