Electronic Medicinal Product Information (ePI) FHIR Implementation Guide
1.0.0 - trial-use International flag

This page is part of the Electronic Medicinal Product Information (ePI) FHIR Implementation Guide (v1.0.0: STU1) based on FHIR v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: SubstanceDefinition (ePI)

Official URL: http://hl7.org/fhir/uv/emedicinal-product-info/StructureDefinition/SubstanceDefinition-uv-epi Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: SubstanceDefinitionUvEpi

SubstanceDefinition (ePI)

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 0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
... identifier 1..*IdentifierIdentifier by which this substance is known
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... status 0..1CodeableConceptdraft|active|retired|unknown
... domain 0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example)
... manufacturer 0..*Reference(Organization (ePI))The entity that creates, makes, produces or fabricates the substance
... molecularWeight
.... amount 1..1QuantityThe molecular weight.
..... value 0..1decimalnumerical value.
..... unit 0..1stringUnit of measure.
..... code 0..1codecoded form of the unit of measure.
... structure
.... molecularFormula 0..1stringMolecular formula (e.g. using the Hill system).
... code 0..*BackboneElementCodes associated with the substance.
.... code 0..1CodeableConceptThe specific code
Binding: Substances (example)
... name 0..*BackboneElementInternational Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.
.... type 0..1CodeableConceptName type e.g. 'scientific, 'brand'

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceDefinition.domainexampleMedicinalProductDomain
SubstanceDefinition.code.codeexampleVsSubstance
NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition 0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
... status Σ0..1CodeableConceptdraft|active|retired|unknown
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... domain Σ0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example)
... description Σ0..1markdownTextual description of the substance.
... manufacturer Σ0..*Reference(Organization (ePI))The entity that creates, makes, produces or fabricates the substance
... code Σ0..*BackboneElementCodes associated with the substance.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe specific code
Binding: Substances (example)
... name Σ0..*BackboneElementInternational Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringThe actual name
.... type Σ0..1CodeableConceptName type e.g. 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SubstanceDefinition.identifier.userequiredIdentifierUse
SubstanceDefinition.statuspreferredPublicationStatus
SubstanceDefinition.domainexampleMedicinalProductDomain
SubstanceDefinition.code.codeexampleVsSubstance
SubstanceDefinition.name.typeexampleSubstanceNameType

Constraints

IdGradePath(s)DetailsRequirements
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 0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
... 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

... 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 Σ1..*IdentifierIdentifier by which this substance is known
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version Σ0..1stringA business level version identifier of the substance
... status Σ0..1CodeableConceptdraft|active|retired|unknown
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... classification Σ0..*CodeableConceptA categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
... domain Σ0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example)
... grade Σ0..*CodeableConceptThe quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies


... 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 Σ0..*Reference(Organization (ePI))The entity that creates, makes, produces or fabricates the substance
... supplier Σ0..*Reference(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..1QuantityThe molecular weight.
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ0..1decimalnumerical value.
..... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit of measure.
..... system ΣC0..1uriSystem that defines coded unit form
..... code ΣC0..1codecoded form of the unit of measure.
... 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..1stringMolecular formula (e.g. using the Hill system).
.... 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 Σ0..*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 Σ0..1CodeableConceptThe specific code
Binding: Substances (example)
.... 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
... name Σ0..*BackboneElementInternational Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.
.... 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. '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 Σ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


.... 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

PathConformanceValueSet
SubstanceDefinition.languagerequiredAllLanguages
SubstanceDefinition.identifier.userequiredIdentifierUse
SubstanceDefinition.identifier.typeextensibleIdentifierTypeCodes
SubstanceDefinition.statuspreferredPublicationStatus
SubstanceDefinition.domainexampleMedicinalProductDomain
SubstanceDefinition.gradeexampleSubstanceGrade
SubstanceDefinition.moiety.stereochemistryexampleStereochemistry
SubstanceDefinition.moiety.opticalActivityexampleOpticalActivity
SubstanceDefinition.moiety.measurementTypeexampleSubstanceAmountType
SubstanceDefinition.characterization.techniqueexampleStructureTechnique
SubstanceDefinition.characterization.formexampleSubstanceForm
SubstanceDefinition.property.typeexampleProductCharacteristic
SubstanceDefinition.molecularWeight.methodexampleWeightMethod
SubstanceDefinition.molecularWeight.typeexampleWeightType
SubstanceDefinition.molecularWeight.amount.comparatorrequiredQuantityComparator
SubstanceDefinition.structure.stereochemistryexampleStereochemistry
SubstanceDefinition.structure.opticalActivityexampleOpticalActivity
SubstanceDefinition.structure.techniqueexampleStructureTechnique
SubstanceDefinition.structure.representation.typeexampleSubstanceRepresentationType
SubstanceDefinition.structure.representation.formatexampleSubstanceRepresentationFormat
SubstanceDefinition.code.codeexampleVsSubstance
SubstanceDefinition.code.statuspreferredPublicationStatus
SubstanceDefinition.name.typeexampleSubstanceNameType
SubstanceDefinition.name.statuspreferredPublicationStatus
SubstanceDefinition.name.languagerequiredAllLanguages
SubstanceDefinition.name.domainexampleSubstanceNameDomain
SubstanceDefinition.name.jurisdictionexampleJurisdictionValueSet
SubstanceDefinition.name.official.authoritypreferredSubstanceNameAuthority
SubstanceDefinition.name.official.statuspreferredPublicationStatus
SubstanceDefinition.relationship.typeexampleSubstanceRelationshipType
SubstanceDefinition.relationship.comparatorexampleSubstanceAmountType
SubstanceDefinition.sourceMaterial.typeexampleSourceMaterialType
SubstanceDefinition.sourceMaterial.genusexampleSourceMaterialGenus
SubstanceDefinition.sourceMaterial.speciesexampleSourceMaterialSpecies
SubstanceDefinition.sourceMaterial.partexampleSourceMaterialPart
SubstanceDefinition.sourceMaterial.countryOfOriginrequiredCountryValueSet

Constraints

IdGradePath(s)DetailsRequirements
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: 3 elements

Structures

This structure refers to these other structures:

Maturity: 2

Differential View

This structure is derived from SubstanceDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition 0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
... identifier 1..*IdentifierIdentifier by which this substance is known
.... system 1..1uriThe namespace for the identifier value
.... value 1..1stringThe value that is unique
... status 0..1CodeableConceptdraft|active|retired|unknown
... domain 0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example)
... manufacturer 0..*Reference(Organization (ePI))The entity that creates, makes, produces or fabricates the substance
... molecularWeight
.... amount 1..1QuantityThe molecular weight.
..... value 0..1decimalnumerical value.
..... unit 0..1stringUnit of measure.
..... code 0..1codecoded form of the unit of measure.
... structure
.... molecularFormula 0..1stringMolecular formula (e.g. using the Hill system).
... code 0..*BackboneElementCodes associated with the substance.
.... code 0..1CodeableConceptThe specific code
Binding: Substances (example)
... name 0..*BackboneElementInternational Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.
.... type 0..1CodeableConceptName type e.g. 'scientific, 'brand'

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
SubstanceDefinition.domainexampleMedicinalProductDomain
SubstanceDefinition.code.codeexampleVsSubstance

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SubstanceDefinition 0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... contained 0..*ResourceContained, inline Resources
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
... status Σ0..1CodeableConceptdraft|active|retired|unknown
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... domain Σ0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example)
... description Σ0..1markdownTextual description of the substance.
... manufacturer Σ0..*Reference(Organization (ePI))The entity that creates, makes, produces or fabricates the substance
... code Σ0..*BackboneElementCodes associated with the substance.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... code Σ0..1CodeableConceptThe specific code
Binding: Substances (example)
... name Σ0..*BackboneElementInternational Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ1..1stringThe actual name
.... type Σ0..1CodeableConceptName type e.g. 'scientific, 'brand'
Binding: SubstanceNameType (example): The type of a name given to a substance.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
SubstanceDefinition.identifier.userequiredIdentifierUse
SubstanceDefinition.statuspreferredPublicationStatus
SubstanceDefinition.domainexampleMedicinalProductDomain
SubstanceDefinition.code.codeexampleVsSubstance
SubstanceDefinition.name.typeexampleSubstanceNameType

Constraints

IdGradePath(s)DetailsRequirements
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 0..*SubstanceDefinitionThe detailed description of a substance, typically at a level beyond what is used for prescribing
... 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

... 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 Σ1..*IdentifierIdentifier by which this substance is known
.... id 0..1idUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

.... type Σ0..1CodeableConceptDescription of identifier
Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

.... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
.... value ΣC1..1stringThe value that is unique
Example General: 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... version Σ0..1stringA business level version identifier of the substance
... status Σ0..1CodeableConceptdraft|active|retired|unknown
Binding: PublicationStatus (preferred): The lifecycle status of an artifact.

... classification Σ0..*CodeableConceptA categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity
... domain Σ0..1CodeableConceptIf the substance applies to human or veterinary use
Binding: MedicinalProductDomain (example)
... grade Σ0..*CodeableConceptThe quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)
Binding: SubstanceGrade (example): The quality standard, established benchmark, to which a substance complies


... 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 Σ0..*Reference(Organization (ePI))The entity that creates, makes, produces or fabricates the substance
... supplier Σ0..*Reference(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..1QuantityThe molecular weight.
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... value Σ0..1decimalnumerical value.
..... comparator ?!Σ0..1code< | <= | >= | > | ad - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.

..... unit Σ0..1stringUnit of measure.
..... system ΣC0..1uriSystem that defines coded unit form
..... code ΣC0..1codecoded form of the unit of measure.
... 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..1stringMolecular formula (e.g. using the Hill system).
.... 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 Σ0..*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 Σ0..1CodeableConceptThe specific code
Binding: Substances (example)
.... 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
... name Σ0..*BackboneElementInternational Non-Proprietary Name (INN) of the substance; or United States Adopted Name (USAN) if applicable.
.... 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. '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 Σ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


.... 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

PathConformanceValueSet
SubstanceDefinition.languagerequiredAllLanguages
SubstanceDefinition.identifier.userequiredIdentifierUse
SubstanceDefinition.identifier.typeextensibleIdentifierTypeCodes
SubstanceDefinition.statuspreferredPublicationStatus
SubstanceDefinition.domainexampleMedicinalProductDomain
SubstanceDefinition.gradeexampleSubstanceGrade
SubstanceDefinition.moiety.stereochemistryexampleStereochemistry
SubstanceDefinition.moiety.opticalActivityexampleOpticalActivity
SubstanceDefinition.moiety.measurementTypeexampleSubstanceAmountType
SubstanceDefinition.characterization.techniqueexampleStructureTechnique
SubstanceDefinition.characterization.formexampleSubstanceForm
SubstanceDefinition.property.typeexampleProductCharacteristic
SubstanceDefinition.molecularWeight.methodexampleWeightMethod
SubstanceDefinition.molecularWeight.typeexampleWeightType
SubstanceDefinition.molecularWeight.amount.comparatorrequiredQuantityComparator
SubstanceDefinition.structure.stereochemistryexampleStereochemistry
SubstanceDefinition.structure.opticalActivityexampleOpticalActivity
SubstanceDefinition.structure.techniqueexampleStructureTechnique
SubstanceDefinition.structure.representation.typeexampleSubstanceRepresentationType
SubstanceDefinition.structure.representation.formatexampleSubstanceRepresentationFormat
SubstanceDefinition.code.codeexampleVsSubstance
SubstanceDefinition.code.statuspreferredPublicationStatus
SubstanceDefinition.name.typeexampleSubstanceNameType
SubstanceDefinition.name.statuspreferredPublicationStatus
SubstanceDefinition.name.languagerequiredAllLanguages
SubstanceDefinition.name.domainexampleSubstanceNameDomain
SubstanceDefinition.name.jurisdictionexampleJurisdictionValueSet
SubstanceDefinition.name.official.authoritypreferredSubstanceNameAuthority
SubstanceDefinition.name.official.statuspreferredPublicationStatus
SubstanceDefinition.relationship.typeexampleSubstanceRelationshipType
SubstanceDefinition.relationship.comparatorexampleSubstanceAmountType
SubstanceDefinition.sourceMaterial.typeexampleSourceMaterialType
SubstanceDefinition.sourceMaterial.genusexampleSourceMaterialGenus
SubstanceDefinition.sourceMaterial.speciesexampleSourceMaterialSpecies
SubstanceDefinition.sourceMaterial.partexampleSourceMaterialPart
SubstanceDefinition.sourceMaterial.countryOfOriginrequiredCountryValueSet

Constraints

IdGradePath(s)DetailsRequirements
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: 3 elements

Structures

This structure refers to these other structures:

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron