Pharmaceutical Quality - Chemistry, Manufacturing and Controls (PQ-CMC) Submissions to FDA, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ballot 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-fda/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/pq-cmc-fda/StructureDefinition/pqcmc-drug-product-substance-impurity | Version: 2.0.0-ballot | |||
Active as of 2024-12-04 | Computable Name: ImpuritySubstance | |||
Other Identifiers: OID:2.16.840.1.113883.4.642.40.36.42.44 |
Any component of the drug substance that is not the chemical entity for procduct composition.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SubstanceDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceDefinition | C | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing cmc-impurity-unii-required: If Product Impurity Chemical Structure Data File is not present, then a unii is required |
identifier | S | 0..1 | Identifier | optional user designated identifier |
classification | S | 1..* | CodeableConcept | Impurity Classification Binding: Impurity Classification Terminology (required) |
characterization | S | 0..* | BackboneElement | General specifications for this substance |
technique | S | 0..1 | CodeableConceptTextOnly | Substance Characterisation Technique |
description | S | 0..1 | markdown | Analysis Narrative Text and Table |
Slices for file | S | 0..* | Attachment | Impurity Analysis Graphic | Impurity Analytical Instrument Data File Slice: Unordered, Open by profile:$this |
file:AnalysisGraphic | 0..* | GraphicAttachment | Analysis Graphic | |
file:AnalyticalInstrumentData | 0..* | AnalyticalInstrumentData | Analytical Instrument Data File | |
structure | S | 0..1 | BackboneElement | Structural information |
technique | S | 0..* | CodeableConceptTextOnly | Impurity Substance Characterisation Technique |
Slices for representation | S | 0..* | BackboneElement | Impurity Structure Graphic | Impurity Structure Data File Slice: Unordered, Closed by value:type |
representation:All Slices | Content/Rules for all slices | |||
type | S | 1..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Representation Types (required) |
representation:graphic | 0..1 | BackboneElement | A graphical, displayable depiction of the structure (e.g. an SVG, PNG) | |
type | 0..1 | CodeableConcept | Graphic Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C54273 | |
document | 1..1 | LiteralReference(Graphic Reference) {b} | Impurity Structure Graphic | |
representation:structureFile | 0..* | BackboneElement | machine-readable representation -- attached file | |
type | 0..1 | CodeableConcept | Structure File Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C103240 | |
document | S | 1..1 | LiteralReference(Structure Data Reference) {b} | Impurity Chemical Structure Data (files, e.g. .SDF, .CIF) |
representation:structureString | 0..* | BackboneElement | machine-readable representation -- plain text | |
type | 0..1 | CodeableConcept | Structure Textual Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C45253 | |
representation | S | 1..1 | string | Impurity Chemical Structure Data (short, plain text representations, e.g. SMILES) |
format | S | 1..1 | CodeableConcept | Drug Substance Impurity Method Type Binding: Chemical Structure Data File Type Terminology (required) |
Slices for code | S | 0..* | BackboneElement | Codes associated with the substance Slice: Unordered, Open by value:code.coding.system |
code:unii | 0..1 | BackboneElement | UNII | |
code | S | 1..1 | CodeableConcept | The specific code |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Required Pattern: http://fdasis.nlm.nih.gov |
code:uniProt | 0..1 | BackboneElement | UniProt ID | |
code | S | 1..1 | CodeableConcept | The specific code |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.uniprot.org |
Slices for name | SC | 1..* | BackboneElement | Substance Name Slice: Unordered, Closed by value:type cmc-name-preferred: Name.preferred: at most one = true |
name:All Slices | Content/Rules for all slices | |||
type | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (required) | |
preferred | S | 0..1 | boolean | True when the name type is Substance Name |
name:sub | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | Generic Name |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C97054 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Generic Name | |
preferred | S | 0..1 | boolean | If this is the preferred name for this substance |
name:gsrs | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | GSRS Preferred Term |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203355 | |
display | 1..1 | string | Representation defined by the system Fixed Value: GSRS Preferred Term | |
preferred | S | 0..1 | boolean | If this is the preferred name for this substance |
name:isbt | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | ISBT-128 DIN |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C95517 | |
display | 1..1 | string | Representation defined by the system Fixed Value: ISBT-128 DIN | |
preferred | S | 0..1 | boolean | If this is the preferred name for this substance |
name:comp | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | Company ID/Code |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203354 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Company ID/Code | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SubstanceDefinition.classification | required | PqcmcImpurityClassificationTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-impurity-classification-terminology from this IG | |
SubstanceDefinition.structure.representation.type | required | PqcmcRepresentationTypeshttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-representation-types from this IG | |
SubstanceDefinition.structure.representation:structureString.format | required | PqcmcChemicalStructureDataFileTypeTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-chemical-structure-datafile-type-terminology from this IG | |
SubstanceDefinition.name.type | required | PqcmcSubstanceNameTypehttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-substance-name-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
cmc-impurity-unii-required | error | SubstanceDefinition | If Product Impurity Chemical Structure Data File is not present, then a unii is required : structure.representation.type.coding.where( system = 'http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl' and code = 'C103240' ).exists().not() implies ( code.where( code.coding.exists(system = 'http://fdasis.nlm.nih.gov') ).exists() ) | |
cmc-name-preferred | error | SubstanceDefinition.name | Name.preferred: at most one = true : select(preferred = true).count() < 2 |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceDefinition | C | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing cmc-impurity-unii-required: If Product Impurity Chemical Structure Data File is not present, then a unii is required |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | optional user designated identifier |
classification | SΣ | 1..* | CodeableConcept | Impurity Classification Binding: Impurity Classification Terminology (required) |
characterization | SΣ | 0..* | BackboneElement | General specifications for this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
technique | S | 0..1 | CodeableConceptTextOnly | Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the characterization of the drug substance. |
description | SΣ | 0..1 | markdown | Analysis Narrative Text and Table |
Slices for file | SΣ | 0..* | Attachment | Impurity Analysis Graphic | Impurity Analytical Instrument Data File Slice: Unordered, Open by profile:$this |
file:AnalysisGraphic | C | 0..* | GraphicAttachment | Analysis Graphic att-1: If the Attachment has data, it SHALL have a contentType |
file:AnalyticalInstrumentData | C | 0..* | AnalyticalInstrumentData | Analytical Instrument Data File att-1: If the Attachment has data, it SHALL have a contentType |
structure | SΣ | 0..1 | BackboneElement | Structural information |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
technique | S | 0..* | CodeableConceptTextOnly | Impurity Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the structure of the drug substance. |
Slices for representation | SΣ | 0..* | BackboneElement | Impurity Structure Graphic | Impurity Structure Data File Slice: Unordered, Closed by value:type |
representation:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Representation Types (required) |
representation:graphic | Σ | 0..1 | BackboneElement | A graphical, displayable depiction of the structure (e.g. an SVG, PNG) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | Graphic Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C54273 | |
document | Σ | 1..1 | LiteralReference(Graphic Reference) {b} | Impurity Structure Graphic |
representation:structureFile | Σ | 0..* | BackboneElement | machine-readable representation -- attached file |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | Structure File Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C103240 | |
document | SΣ | 1..1 | LiteralReference(Structure Data Reference) {b} | Impurity Chemical Structure Data (files, e.g. .SDF, .CIF) |
representation:structureString | Σ | 0..* | BackboneElement | machine-readable representation -- plain text |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | Structure Textual Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C45253 | |
representation | SΣ | 1..1 | string | Impurity Chemical Structure Data (short, plain text representations, e.g. SMILES) |
format | SΣ | 1..1 | CodeableConcept | Drug Substance Impurity Method Type Binding: Chemical Structure Data File Type Terminology (required) |
Slices for code | SΣ | 0..* | BackboneElement | Codes associated with the substance Slice: Unordered, Open by value:code.coding.system |
code:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code:unii | Σ | 0..1 | BackboneElement | UNII |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | The specific code |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fdasis.nlm.nih.gov |
code:uniProt | Σ | 0..1 | BackboneElement | UniProt ID |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | The specific code |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.uniprot.org |
Slices for name | SΣC | 1..* | BackboneElement | Substance Name Slice: Unordered, Closed by value:type cmc-name-preferred: Name.preferred: at most one = true |
name:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | The actual name |
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (required) |
preferred | SΣ | 0..1 | boolean | True when the name type is Substance Name |
name:sub | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Generic Name |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C97054 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Generic Name | |
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance |
name:gsrs | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | GSRS Preferred Term |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203355 | |
display | 1..1 | string | Representation defined by the system Fixed Value: GSRS Preferred Term | |
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance |
name:isbt | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | ISBT-128 DIN |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C95517 | |
display | 1..1 | string | Representation defined by the system Fixed Value: ISBT-128 DIN | |
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance |
name:comp | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Company ID/Code |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203354 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Company ID/Code | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
SubstanceDefinition.classification | required | PqcmcImpurityClassificationTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-impurity-classification-terminology from this IG | |
SubstanceDefinition.characterization.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.structure.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.structure.representation.type | required | PqcmcRepresentationTypeshttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-representation-types from this IG | |
SubstanceDefinition.structure.representation:graphic.type | example | Pattern: C54273http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureFile.type | example | Pattern: C103240http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.type | example | Pattern: C45253http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.format | required | PqcmcChemicalStructureDataFileTypeTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-chemical-structure-datafile-type-terminology from this IG | |
SubstanceDefinition.name.type | required | PqcmcSubstanceNameTypehttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-substance-name-type from this IG | |
SubstanceDefinition.name:sub.type | example | Pattern: C97054("Generic Name")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:gsrs.type | example | Pattern: C203355("GSRS Preferred Term")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:isbt.type | example | Pattern: C95517("ISBT-128 DIN")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:comp.type | example | Pattern: C203354("Company ID/Code")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | SubstanceDefinition.characterization.file:AnalysisGraphic, SubstanceDefinition.characterization.file:AnalyticalInstrumentData | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cmc-impurity-unii-required | error | SubstanceDefinition | If Product Impurity Chemical Structure Data File is not present, then a unii is required : structure.representation.type.coding.where( system = 'http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl' and code = 'C103240' ).exists().not() implies ( code.where( code.coding.exists(system = 'http://fdasis.nlm.nih.gov') ).exists() ) | |
cmc-name-preferred | error | SubstanceDefinition.name | Name.preferred: at most one = true : select(preferred = true).count() < 2 | |
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
SubstanceDefinition | C | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing cmc-impurity-unii-required: If Product Impurity Chemical Structure Data File is not present, then a unii is required | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..1 | Identifier | optional user designated identifier | ||||
version | Σ | 0..1 | string | A business level version identifier of the substance | ||||
status | Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
classification | SΣ | 1..* | CodeableConcept | Impurity Classification Binding: Impurity Classification Terminology (required) | ||||
domain | Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | ||||
grade | Σ | 0..* | CodeableConcept | The 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..1 | markdown | Textual description of the substance | ||||
informationSource | Σ | 0..* | Reference(Citation) | Supporting literature | ||||
note | Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | ||||
manufacturer | Σ | 0..* | Reference(Organization) | 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..* | BackboneElement | Moiety, for structural modifications | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | Σ | 0..1 | CodeableConcept | Role that the moiety is playing | ||||
identifier | Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | ||||
name | Σ | 0..1 | string | Textual name for this moiety substance | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | ||||
amount[x] | Σ | 0..1 | Quantitative value for this moiety | |||||
amountQuantity | Quantity | |||||||
amountString | string | |||||||
measurementType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
characterization | SΣ | 0..* | BackboneElement | General specifications for this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
technique | S | 0..1 | CodeableConceptTextOnly | Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the characterization of the drug substance. | ||||
form | Σ | 0..1 | CodeableConcept | Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form Binding: SubstanceForm (example) | ||||
description | SΣ | 0..1 | markdown | Analysis Narrative Text and Table | ||||
Slices for file | SΣ | 0..* | Attachment | Impurity Analysis Graphic | Impurity Analytical Instrument Data File Slice: Unordered, Open by profile:$this | ||||
file:AnalysisGraphic | C | 0..* | GraphicAttachment | Analysis Graphic att-1: If the Attachment has data, it SHALL have a contentType | ||||
file:AnalyticalInstrumentData | C | 0..* | AnalyticalInstrumentData | Analytical Instrument Data File att-1: If the Attachment has data, it SHALL have a contentType | ||||
property | Σ | 0..* | BackboneElement | General specifications for this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. | ||||
value[x] | Σ | 0..1 | A value for the property | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueDate | date | |||||||
valueBoolean | boolean | |||||||
valueAttachment | Attachment | |||||||
referenceInformation | Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | ||||
molecularWeight | Σ | 0..* | BackboneElement | The average mass of a molecule of a compound | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: WeightMethod (example): The method by which the substance weight was measured. | ||||
type | Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: WeightType (example): The type of substance weight measurement. | ||||
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | ||||
structure | SΣ | 0..1 | BackboneElement | Structural information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
molecularFormula | Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | ||||
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system | ||||
molecularWeight | Σ | 0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range | ||||
technique | S | 0..* | CodeableConceptTextOnly | Impurity Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the structure of the drug substance. | ||||
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | ||||
Slices for representation | SΣ | 0..* | BackboneElement | Impurity Structure Graphic | Impurity Structure Data File Slice: Unordered, Closed by value:type | ||||
representation:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 1..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Representation Types (required) | ||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
representation:graphic | Σ | 0..1 | BackboneElement | A graphical, displayable depiction of the structure (e.g. an SVG, PNG) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Graphic Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C54273 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
document | Σ | 1..1 | LiteralReference(Graphic Reference) {b} | Impurity Structure Graphic | ||||
representation:structureFile | Σ | 0..* | BackboneElement | machine-readable representation -- attached file | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Structure File Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C103240 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
document | SΣ | 1..1 | LiteralReference(Structure Data Reference) {b} | Impurity Chemical Structure Data (files, e.g. .SDF, .CIF) | ||||
representation:structureString | Σ | 0..* | BackboneElement | machine-readable representation -- plain text | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Structure Textual Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C45253 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
representation | SΣ | 1..1 | string | Impurity Chemical Structure Data (short, plain text representations, e.g. SMILES) | ||||
format | SΣ | 1..1 | CodeableConcept | Drug Substance Impurity Method Type Binding: Chemical Structure Data File Type Terminology (required) | ||||
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
Slices for code | SΣ | 0..* | BackboneElement | Codes associated with the substance Slice: Unordered, Open by value:code.coding.system | ||||
code:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 0..1 | CodeableConcept | The specific code | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
code:unii | Σ | 0..1 | BackboneElement | UNII | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | SΣ | 1..1 | CodeableConcept | The specific code | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fdasis.nlm.nih.gov | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
code:uniProt | Σ | 0..1 | BackboneElement | UniProt ID | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | SΣ | 1..1 | CodeableConcept | The specific code | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.uniprot.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
Slices for name | SΣC | 1..* | BackboneElement | Substance Name Slice: Unordered, Closed by value:type cmc-name-preferred: Name.preferred: at most one = true | ||||
name:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | The actual name | ||||
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (required) | ||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | True when the name type is Substance Name | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:sub | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | Generic Name | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C97054 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Generic Name | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:gsrs | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | GSRS Preferred Term | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203355 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: GSRS Preferred Term | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:isbt | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | ISBT-128 DIN | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C95517 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: ISBT-128 DIN | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:comp | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | Company ID/Code | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203354 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Company ID/Code | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | Σ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
relationship | Σ | 0..* | BackboneElement | A link between this substance and another | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
substanceDefinition[x] | Σ | 0..1 | A pointer to another substance, as a resource or a representational code | |||||
substanceDefinitionReference | Reference(SubstanceDefinition) | |||||||
substanceDefinitionCodeableConcept | CodeableConcept | |||||||
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types. | ||||
isDefining | Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | ||||
amount[x] | Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | |||||
amountQuantity | Quantity | |||||||
amountRatio | Ratio | |||||||
amountString | string | |||||||
ratioHighLimitAmount | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | ||||
comparator | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
nucleicAcid | Σ | 0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | ||||
polymer | Σ | 0..1 | Reference(SubstancePolymer) | Data items specific to polymers | ||||
protein | Σ | 0..1 | Reference(SubstanceProtein) | Data items specific to proteins | ||||
sourceMaterial | Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: SourceMaterialType (example): A classification that provides the origin of the substance raw material. | ||||
genus | Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: SourceMaterialGenus (example): The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name. | ||||
species | Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: SourceMaterialSpecies (example): A species of origin a substance raw material. | ||||
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism. | ||||
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: CountryValueSet (required): Jurisdiction codes | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
SubstanceDefinition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.classification | required | PqcmcImpurityClassificationTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-impurity-classification-terminology from this IG | |
SubstanceDefinition.domain | example | MedicinalProductDomainhttp://hl7.org/fhir/ValueSet/medicinal-product-domain from the FHIR Standard | |
SubstanceDefinition.grade | example | SubstanceGradehttp://hl7.org/fhir/ValueSet/substance-grade from the FHIR Standard | |
SubstanceDefinition.moiety.stereochemistry | example | Stereochemistryhttp://hl7.org/fhir/ValueSet/substance-stereochemistry from the FHIR Standard | |
SubstanceDefinition.moiety.opticalActivity | example | OpticalActivityhttp://hl7.org/fhir/ValueSet/substance-optical-activity from the FHIR Standard | |
SubstanceDefinition.moiety.measurementType | example | SubstanceAmountTypehttp://hl7.org/fhir/ValueSet/substance-amount-type from the FHIR Standard | |
SubstanceDefinition.characterization.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.characterization.form | example | SubstanceFormhttp://hl7.org/fhir/ValueSet/substance-form from the FHIR Standard | |
SubstanceDefinition.property.type | example | ProductCharacteristichttp://hl7.org/fhir/ValueSet/product-characteristic-codes from the FHIR Standard | |
SubstanceDefinition.molecularWeight.method | example | WeightMethodhttp://hl7.org/fhir/ValueSet/substance-weight-method from the FHIR Standard | |
SubstanceDefinition.molecularWeight.type | example | WeightTypehttp://hl7.org/fhir/ValueSet/substance-weight-type from the FHIR Standard | |
SubstanceDefinition.structure.stereochemistry | example | Stereochemistryhttp://hl7.org/fhir/ValueSet/substance-stereochemistry from the FHIR Standard | |
SubstanceDefinition.structure.opticalActivity | example | OpticalActivityhttp://hl7.org/fhir/ValueSet/substance-optical-activity from the FHIR Standard | |
SubstanceDefinition.structure.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.structure.representation.type | required | PqcmcRepresentationTypeshttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-representation-types from this IG | |
SubstanceDefinition.structure.representation.format | example | SubstanceRepresentationFormathttp://hl7.org/fhir/ValueSet/substance-representation-format from the FHIR Standard | |
SubstanceDefinition.structure.representation:graphic.type | example | Pattern: C54273http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:graphic.format | example | SubstanceRepresentationFormathttp://hl7.org/fhir/ValueSet/substance-representation-format from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureFile.type | example | Pattern: C103240http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureFile.format | example | SubstanceRepresentationFormathttp://hl7.org/fhir/ValueSet/substance-representation-format from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.type | example | Pattern: C45253http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.format | required | PqcmcChemicalStructureDataFileTypeTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-chemical-structure-datafile-type-terminology from this IG | |
SubstanceDefinition.code.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.code:unii.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.code:uniProt.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name.type | required | PqcmcSubstanceNameTypehttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-substance-name-type from this IG | |
SubstanceDefinition.name.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:sub.type | example | Pattern: C97054("Generic Name")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:sub.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:sub.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:sub.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:sub.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:sub.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:sub.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:gsrs.type | example | Pattern: C203355("GSRS Preferred Term")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:gsrs.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:gsrs.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:gsrs.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:gsrs.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:gsrs.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:gsrs.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:isbt.type | example | Pattern: C95517("ISBT-128 DIN")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:isbt.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:isbt.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:isbt.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:isbt.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:isbt.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:isbt.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:comp.type | example | Pattern: C203354("Company ID/Code")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:comp.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:comp.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:comp.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:comp.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:comp.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:comp.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.relationship.type | example | SubstanceRelationshipTypehttp://hl7.org/fhir/ValueSet/substance-relationship-type from the FHIR Standard | |
SubstanceDefinition.relationship.comparator | example | SubstanceAmountTypehttp://hl7.org/fhir/ValueSet/substance-amount-type from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.type | example | SourceMaterialTypehttp://hl7.org/fhir/ValueSet/substance-source-material-type from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.genus | example | SourceMaterialGenushttp://hl7.org/fhir/ValueSet/substance-source-material-genus from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.species | example | SourceMaterialSpecieshttp://hl7.org/fhir/ValueSet/substance-source-material-species from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.part | example | SourceMaterialParthttp://hl7.org/fhir/ValueSet/substance-source-material-part from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.countryOfOrigin | required | CountryValueSethttp://hl7.org/fhir/ValueSet/country|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | SubstanceDefinition.characterization.file:AnalysisGraphic, SubstanceDefinition.characterization.file:AnalyticalInstrumentData | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cmc-impurity-unii-required | error | SubstanceDefinition | If Product Impurity Chemical Structure Data File is not present, then a unii is required : structure.representation.type.coding.where( system = 'http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl' and code = 'C103240' ).exists().not() implies ( code.where( code.coding.exists(system = 'http://fdasis.nlm.nih.gov') ).exists() ) | |
cmc-name-preferred | error | SubstanceDefinition.name | Name.preferred: at most one = true : select(preferred = true).count() < 2 | |
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from SubstanceDefinition
Summary
Mandatory: 2 elements(15 nested mandatory elements)
Must-Support: 37 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from SubstanceDefinition
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceDefinition | C | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing cmc-impurity-unii-required: If Product Impurity Chemical Structure Data File is not present, then a unii is required |
identifier | S | 0..1 | Identifier | optional user designated identifier |
classification | S | 1..* | CodeableConcept | Impurity Classification Binding: Impurity Classification Terminology (required) |
characterization | S | 0..* | BackboneElement | General specifications for this substance |
technique | S | 0..1 | CodeableConceptTextOnly | Substance Characterisation Technique |
description | S | 0..1 | markdown | Analysis Narrative Text and Table |
Slices for file | S | 0..* | Attachment | Impurity Analysis Graphic | Impurity Analytical Instrument Data File Slice: Unordered, Open by profile:$this |
file:AnalysisGraphic | 0..* | GraphicAttachment | Analysis Graphic | |
file:AnalyticalInstrumentData | 0..* | AnalyticalInstrumentData | Analytical Instrument Data File | |
structure | S | 0..1 | BackboneElement | Structural information |
technique | S | 0..* | CodeableConceptTextOnly | Impurity Substance Characterisation Technique |
Slices for representation | S | 0..* | BackboneElement | Impurity Structure Graphic | Impurity Structure Data File Slice: Unordered, Closed by value:type |
representation:All Slices | Content/Rules for all slices | |||
type | S | 1..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Representation Types (required) |
representation:graphic | 0..1 | BackboneElement | A graphical, displayable depiction of the structure (e.g. an SVG, PNG) | |
type | 0..1 | CodeableConcept | Graphic Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C54273 | |
document | 1..1 | LiteralReference(Graphic Reference) {b} | Impurity Structure Graphic | |
representation:structureFile | 0..* | BackboneElement | machine-readable representation -- attached file | |
type | 0..1 | CodeableConcept | Structure File Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C103240 | |
document | S | 1..1 | LiteralReference(Structure Data Reference) {b} | Impurity Chemical Structure Data (files, e.g. .SDF, .CIF) |
representation:structureString | 0..* | BackboneElement | machine-readable representation -- plain text | |
type | 0..1 | CodeableConcept | Structure Textual Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C45253 | |
representation | S | 1..1 | string | Impurity Chemical Structure Data (short, plain text representations, e.g. SMILES) |
format | S | 1..1 | CodeableConcept | Drug Substance Impurity Method Type Binding: Chemical Structure Data File Type Terminology (required) |
Slices for code | S | 0..* | BackboneElement | Codes associated with the substance Slice: Unordered, Open by value:code.coding.system |
code:unii | 0..1 | BackboneElement | UNII | |
code | S | 1..1 | CodeableConcept | The specific code |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Required Pattern: http://fdasis.nlm.nih.gov |
code:uniProt | 0..1 | BackboneElement | UniProt ID | |
code | S | 1..1 | CodeableConcept | The specific code |
coding | S | 1..1 | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.uniprot.org |
Slices for name | SC | 1..* | BackboneElement | Substance Name Slice: Unordered, Closed by value:type cmc-name-preferred: Name.preferred: at most one = true |
name:All Slices | Content/Rules for all slices | |||
type | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (required) | |
preferred | S | 0..1 | boolean | True when the name type is Substance Name |
name:sub | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | Generic Name |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C97054 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Generic Name | |
preferred | S | 0..1 | boolean | If this is the preferred name for this substance |
name:gsrs | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | GSRS Preferred Term |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203355 | |
display | 1..1 | string | Representation defined by the system Fixed Value: GSRS Preferred Term | |
preferred | S | 0..1 | boolean | If this is the preferred name for this substance |
name:isbt | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | ISBT-128 DIN |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C95517 | |
display | 1..1 | string | Representation defined by the system Fixed Value: ISBT-128 DIN | |
preferred | S | 0..1 | boolean | If this is the preferred name for this substance |
name:comp | S | 0..1 | BackboneElement | Names applicable to this substance |
name | S | 1..1 | string | Company ID/Code |
type | S | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203354 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Company ID/Code | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
SubstanceDefinition.classification | required | PqcmcImpurityClassificationTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-impurity-classification-terminology from this IG | |
SubstanceDefinition.structure.representation.type | required | PqcmcRepresentationTypeshttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-representation-types from this IG | |
SubstanceDefinition.structure.representation:structureString.format | required | PqcmcChemicalStructureDataFileTypeTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-chemical-structure-datafile-type-terminology from this IG | |
SubstanceDefinition.name.type | required | PqcmcSubstanceNameTypehttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-substance-name-type from this IG |
Id | Grade | Path(s) | Details | Requirements |
cmc-impurity-unii-required | error | SubstanceDefinition | If Product Impurity Chemical Structure Data File is not present, then a unii is required : structure.representation.type.coding.where( system = 'http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl' and code = 'C103240' ).exists().not() implies ( code.where( code.coding.exists(system = 'http://fdasis.nlm.nih.gov') ).exists() ) | |
cmc-name-preferred | error | SubstanceDefinition.name | Name.preferred: at most one = true : select(preferred = true).count() < 2 |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
SubstanceDefinition | C | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing cmc-impurity-unii-required: If Product Impurity Chemical Structure Data File is not present, then a unii is required |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 0..1 | Identifier | optional user designated identifier |
classification | SΣ | 1..* | CodeableConcept | Impurity Classification Binding: Impurity Classification Terminology (required) |
characterization | SΣ | 0..* | BackboneElement | General specifications for this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
technique | S | 0..1 | CodeableConceptTextOnly | Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the characterization of the drug substance. |
description | SΣ | 0..1 | markdown | Analysis Narrative Text and Table |
Slices for file | SΣ | 0..* | Attachment | Impurity Analysis Graphic | Impurity Analytical Instrument Data File Slice: Unordered, Open by profile:$this |
file:AnalysisGraphic | C | 0..* | GraphicAttachment | Analysis Graphic att-1: If the Attachment has data, it SHALL have a contentType |
file:AnalyticalInstrumentData | C | 0..* | AnalyticalInstrumentData | Analytical Instrument Data File att-1: If the Attachment has data, it SHALL have a contentType |
structure | SΣ | 0..1 | BackboneElement | Structural information |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
technique | S | 0..* | CodeableConceptTextOnly | Impurity Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the structure of the drug substance. |
Slices for representation | SΣ | 0..* | BackboneElement | Impurity Structure Graphic | Impurity Structure Data File Slice: Unordered, Closed by value:type |
representation:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 1..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Representation Types (required) |
representation:graphic | Σ | 0..1 | BackboneElement | A graphical, displayable depiction of the structure (e.g. an SVG, PNG) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | Graphic Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C54273 | |
document | Σ | 1..1 | LiteralReference(Graphic Reference) {b} | Impurity Structure Graphic |
representation:structureFile | Σ | 0..* | BackboneElement | machine-readable representation -- attached file |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | Structure File Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C103240 | |
document | SΣ | 1..1 | LiteralReference(Structure Data Reference) {b} | Impurity Chemical Structure Data (files, e.g. .SDF, .CIF) |
representation:structureString | Σ | 0..* | BackboneElement | machine-readable representation -- plain text |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | CodeableConcept | Structure Textual Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C45253 | |
representation | SΣ | 1..1 | string | Impurity Chemical Structure Data (short, plain text representations, e.g. SMILES) |
format | SΣ | 1..1 | CodeableConcept | Drug Substance Impurity Method Type Binding: Chemical Structure Data File Type Terminology (required) |
Slices for code | SΣ | 0..* | BackboneElement | Codes associated with the substance Slice: Unordered, Open by value:code.coding.system |
code:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code:unii | Σ | 0..1 | BackboneElement | UNII |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | The specific code |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fdasis.nlm.nih.gov |
code:uniProt | Σ | 0..1 | BackboneElement | UniProt ID |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
code | SΣ | 1..1 | CodeableConcept | The specific code |
coding | SΣ | 1..1 | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.uniprot.org |
Slices for name | SΣC | 1..* | BackboneElement | Substance Name Slice: Unordered, Closed by value:type cmc-name-preferred: Name.preferred: at most one = true |
name:All Slices | Content/Rules for all slices | |||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | The actual name |
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (required) |
preferred | SΣ | 0..1 | boolean | True when the name type is Substance Name |
name:sub | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Generic Name |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C97054 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Generic Name | |
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance |
name:gsrs | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | GSRS Preferred Term |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203355 | |
display | 1..1 | string | Representation defined by the system Fixed Value: GSRS Preferred Term | |
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance |
name:isbt | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | ISBT-128 DIN |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C95517 | |
display | 1..1 | string | Representation defined by the system Fixed Value: ISBT-128 DIN | |
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance |
name:comp | SΣ | 0..1 | BackboneElement | Names applicable to this substance |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | SΣ | 1..1 | string | Company ID/Code |
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203354 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Company ID/Code | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
SubstanceDefinition.classification | required | PqcmcImpurityClassificationTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-impurity-classification-terminology from this IG | |
SubstanceDefinition.characterization.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.structure.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.structure.representation.type | required | PqcmcRepresentationTypeshttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-representation-types from this IG | |
SubstanceDefinition.structure.representation:graphic.type | example | Pattern: C54273http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureFile.type | example | Pattern: C103240http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.type | example | Pattern: C45253http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.format | required | PqcmcChemicalStructureDataFileTypeTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-chemical-structure-datafile-type-terminology from this IG | |
SubstanceDefinition.name.type | required | PqcmcSubstanceNameTypehttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-substance-name-type from this IG | |
SubstanceDefinition.name:sub.type | example | Pattern: C97054("Generic Name")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:gsrs.type | example | Pattern: C203355("GSRS Preferred Term")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:isbt.type | example | Pattern: C95517("ISBT-128 DIN")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:comp.type | example | Pattern: C203354("Company ID/Code")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | SubstanceDefinition.characterization.file:AnalysisGraphic, SubstanceDefinition.characterization.file:AnalyticalInstrumentData | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cmc-impurity-unii-required | error | SubstanceDefinition | If Product Impurity Chemical Structure Data File is not present, then a unii is required : structure.representation.type.coding.where( system = 'http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl' and code = 'C103240' ).exists().not() implies ( code.where( code.coding.exists(system = 'http://fdasis.nlm.nih.gov') ).exists() ) | |
cmc-name-preferred | error | SubstanceDefinition.name | Name.preferred: at most one = true : select(preferred = true).count() < 2 | |
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
SubstanceDefinition | C | 0..* | SubstanceDefinition | The detailed description of a substance, typically at a level beyond what is used for prescribing cmc-impurity-unii-required: If Product Impurity Chemical Structure Data File is not present, then a unii is required | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 0..1 | Identifier | optional user designated identifier | ||||
version | Σ | 0..1 | string | A business level version identifier of the substance | ||||
status | Σ | 0..1 | CodeableConcept | Status of substance within the catalogue e.g. active, retired Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
classification | SΣ | 1..* | CodeableConcept | Impurity Classification Binding: Impurity Classification Terminology (required) | ||||
domain | Σ | 0..1 | CodeableConcept | If the substance applies to human or veterinary use Binding: MedicinalProductDomain (example): Applicable domain for this product (e.g. human, veterinary). | ||||
grade | Σ | 0..* | CodeableConcept | The 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..1 | markdown | Textual description of the substance | ||||
informationSource | Σ | 0..* | Reference(Citation) | Supporting literature | ||||
note | Σ | 0..* | Annotation | Textual comment about the substance's catalogue or registry record | ||||
manufacturer | Σ | 0..* | Reference(Organization) | 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..* | BackboneElement | Moiety, for structural modifications | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | Σ | 0..1 | CodeableConcept | Role that the moiety is playing | ||||
identifier | Σ | 0..1 | Identifier | Identifier by which this moiety substance is known | ||||
name | Σ | 0..1 | string | Textual name for this moiety substance | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
molecularFormula | Σ | 0..1 | string | Molecular formula for this moiety (e.g. with the Hill system) | ||||
amount[x] | Σ | 0..1 | Quantitative value for this moiety | |||||
amountQuantity | Quantity | |||||||
amountString | string | |||||||
measurementType | Σ | 0..1 | CodeableConcept | The measurement type of the quantitative value Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
characterization | SΣ | 0..* | BackboneElement | General specifications for this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
technique | S | 0..1 | CodeableConceptTextOnly | Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the characterization of the drug substance. | ||||
form | Σ | 0..1 | CodeableConcept | Describes the nature of the chemical entity and explains, for instance, whether this is a base or a salt form Binding: SubstanceForm (example) | ||||
description | SΣ | 0..1 | markdown | Analysis Narrative Text and Table | ||||
Slices for file | SΣ | 0..* | Attachment | Impurity Analysis Graphic | Impurity Analytical Instrument Data File Slice: Unordered, Open by profile:$this | ||||
file:AnalysisGraphic | C | 0..* | GraphicAttachment | Analysis Graphic att-1: If the Attachment has data, it SHALL have a contentType | ||||
file:AnalyticalInstrumentData | C | 0..* | AnalyticalInstrumentData | Analytical Instrument Data File att-1: If the Attachment has data, it SHALL have a contentType | ||||
property | Σ | 0..* | BackboneElement | General specifications for this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 1..1 | CodeableConcept | A code expressing the type of property Binding: ProductCharacteristic (example): This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set. | ||||
value[x] | Σ | 0..1 | A value for the property | |||||
valueCodeableConcept | CodeableConcept | |||||||
valueQuantity | Quantity | |||||||
valueDate | date | |||||||
valueBoolean | boolean | |||||||
valueAttachment | Attachment | |||||||
referenceInformation | Σ | 0..1 | Reference(SubstanceReferenceInformation) | General information detailing this substance | ||||
molecularWeight | Σ | 0..* | BackboneElement | The average mass of a molecule of a compound | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
method | Σ | 0..1 | CodeableConcept | The method by which the weight was determined Binding: WeightMethod (example): The method by which the substance weight was measured. | ||||
type | Σ | 0..1 | CodeableConcept | Type of molecular weight e.g. exact, average, weight average Binding: WeightType (example): The type of substance weight measurement. | ||||
amount | Σ | 1..1 | Quantity | Used to capture quantitative values for a variety of elements | ||||
structure | SΣ | 0..1 | BackboneElement | Structural information | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
stereochemistry | Σ | 0..1 | CodeableConcept | Stereochemistry type Binding: Stereochemistry (example): The optical rotation type of a substance. | ||||
opticalActivity | Σ | 0..1 | CodeableConcept | Optical activity type Binding: OpticalActivity (example): The optical rotation type of a substance. | ||||
molecularFormula | Σ | 0..1 | string | An expression which states the number and type of atoms present in a molecule of a substance | ||||
molecularFormulaByMoiety | Σ | 0..1 | string | Specified per moiety according to the Hill system | ||||
molecularWeight | Σ | 0..1 | See molecularWeight (SubstanceDefinition) | The molecular weight or weight range | ||||
technique | S | 0..* | CodeableConceptTextOnly | Impurity Substance Characterisation Technique Binding: StructureTechnique (example): The method used to elucidate the structure of the drug substance. | ||||
sourceDocument | Σ | 0..* | Reference(DocumentReference) | Source of information for the structure | ||||
Slices for representation | SΣ | 0..* | BackboneElement | Impurity Structure Graphic | Impurity Structure Data File Slice: Unordered, Closed by value:type | ||||
representation:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | SΣ | 1..1 | CodeableConcept | The kind of structural representation (e.g. full, partial) Binding: Representation Types (required) | ||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
representation:graphic | Σ | 0..1 | BackboneElement | A graphical, displayable depiction of the structure (e.g. an SVG, PNG) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Graphic Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C54273 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
document | Σ | 1..1 | LiteralReference(Graphic Reference) {b} | Impurity Structure Graphic | ||||
representation:structureFile | Σ | 0..* | BackboneElement | machine-readable representation -- attached file | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Structure File Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C103240 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
representation | Σ | 0..1 | string | The structural representation as a text string in a standard format | ||||
format | Σ | 0..1 | CodeableConcept | The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) Binding: SubstanceRepresentationFormat (example): A format of a substance representation. | ||||
document | SΣ | 1..1 | LiteralReference(Structure Data Reference) {b} | Impurity Chemical Structure Data (files, e.g. .SDF, .CIF) | ||||
representation:structureString | Σ | 0..* | BackboneElement | machine-readable representation -- plain text | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Structure Textual Binding: SubstanceRepresentationType (example): A format of a substance representation. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C45253 | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
representation | SΣ | 1..1 | string | Impurity Chemical Structure Data (short, plain text representations, e.g. SMILES) | ||||
format | SΣ | 1..1 | CodeableConcept | Drug Substance Impurity Method Type Binding: Chemical Structure Data File Type Terminology (required) | ||||
document | Σ | 0..1 | Reference(DocumentReference) | An attachment with the structural representation e.g. a structure graphic or AnIML file | ||||
Slices for code | SΣ | 0..* | BackboneElement | Codes associated with the substance Slice: Unordered, Open by value:code.coding.system | ||||
code:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | Σ | 0..1 | CodeableConcept | The specific code | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
code:unii | Σ | 0..1 | BackboneElement | UNII | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | SΣ | 1..1 | CodeableConcept | The specific code | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: http://fdasis.nlm.nih.gov | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
code:uniProt | Σ | 0..1 | BackboneElement | UniProt ID | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
code | SΣ | 1..1 | CodeableConcept | The specific code | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..1 | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Required Pattern: https://www.uniprot.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
status | Σ | 0..1 | CodeableConcept | Status of the code assignment, for example 'provisional', 'approved' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
statusDate | Σ | 0..1 | dateTime | The date at which the code status was changed | ||||
note | Σ | 0..* | Annotation | Any comment can be provided in this field | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
Slices for name | SΣC | 1..* | BackboneElement | Substance Name Slice: Unordered, Closed by value:type cmc-name-preferred: Name.preferred: at most one = true | ||||
name:All Slices | Content/Rules for all slices | |||||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | Σ | 1..1 | string | The actual name | ||||
type | Σ | 0..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: Substance Name Type (required) | ||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | True when the name type is Substance Name | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:sub | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | Generic Name | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C97054 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Generic Name | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:gsrs | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | GSRS Preferred Term | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203355 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: GSRS Preferred Term | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:isbt | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | ISBT-128 DIN | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C95517 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: ISBT-128 DIN | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | SΣ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
name:comp | SΣ | 0..1 | BackboneElement | Names applicable to this substance | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
name | SΣ | 1..1 | string | Company ID/Code | ||||
type | SΣ | 1..1 | CodeableConcept | Name type e.g. 'systematic', 'scientific, 'brand' Binding: SubstanceNameType (example): The type of a name given to a substance. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: C203354 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Company ID/Code | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
status | Σ | 0..1 | CodeableConcept | The status of the name e.g. 'current', 'proposed' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
preferred | Σ | 0..1 | boolean | If this is the preferred name for this substance | ||||
language | Σ | 0..* | CodeableConcept | Human language that the name is written in Binding: AllLanguages (required): IETF language tag for a human language
| ||||
domain | Σ | 0..* | CodeableConcept | The use context of this name e.g. as an active ingredient or as a food colour additive Binding: SubstanceNameDomain (example): The use context of a substance name for example if there is a different name when used as a drug active ingredient as opposed to a food colour additive. | ||||
jurisdiction | Σ | 0..* | CodeableConcept | The jurisdiction where this name applies Binding: JurisdictionValueSet (example): Jurisdiction codes | ||||
synonym | Σ | 0..* | See name (SubstanceDefinition) | A synonym of this particular name, by which the substance is also known | ||||
translation | Σ | 0..* | See name (SubstanceDefinition) | A translation for this name into another human language | ||||
official | Σ | 0..* | BackboneElement | Details of the official nature of this name | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | Σ | 0..1 | CodeableConcept | Which authority uses this official name Binding: SubstanceNameAuthority (preferred): An authority that officates substance names. | ||||
status | Σ | 0..1 | CodeableConcept | The status of the official name, for example 'draft', 'active' Binding: PublicationStatus (preferred): The lifecycle status of an artifact. | ||||
date | Σ | 0..1 | dateTime | Date of official name change | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
relationship | Σ | 0..* | BackboneElement | A link between this substance and another | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
substanceDefinition[x] | Σ | 0..1 | A pointer to another substance, as a resource or a representational code | |||||
substanceDefinitionReference | Reference(SubstanceDefinition) | |||||||
substanceDefinitionCodeableConcept | CodeableConcept | |||||||
type | Σ | 1..1 | CodeableConcept | For example "salt to parent", "active moiety" Binding: SubstanceRelationshipType (example): The relationship between two substance types. | ||||
isDefining | Σ | 0..1 | boolean | For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships | ||||
amount[x] | Σ | 0..1 | A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other | |||||
amountQuantity | Quantity | |||||||
amountRatio | Ratio | |||||||
amountString | string | |||||||
ratioHighLimitAmount | Σ | 0..1 | Ratio | For use when the numeric has an uncertain range | ||||
comparator | Σ | 0..1 | CodeableConcept | An operator for the amount, for example "average", "approximately", "less than" Binding: SubstanceAmountType (example): The relationship between two substance types. | ||||
source | Σ | 0..* | Reference(DocumentReference) | Supporting literature | ||||
nucleicAcid | Σ | 0..1 | Reference(SubstanceNucleicAcid) | Data items specific to nucleic acids | ||||
polymer | Σ | 0..1 | Reference(SubstancePolymer) | Data items specific to polymers | ||||
protein | Σ | 0..1 | Reference(SubstanceProtein) | Data items specific to proteins | ||||
sourceMaterial | Σ | 0..1 | BackboneElement | Material or taxonomic/anatomical source | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | CodeableConcept | Classification of the origin of the raw material. e.g. cat hair is an Animal source type Binding: SourceMaterialType (example): A classification that provides the origin of the substance raw material. | ||||
genus | Σ | 0..1 | CodeableConcept | The genus of an organism e.g. the Latin epithet of the plant/animal scientific name Binding: SourceMaterialGenus (example): The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name. | ||||
species | Σ | 0..1 | CodeableConcept | The species of an organism e.g. the Latin epithet of the species of the plant/animal Binding: SourceMaterialSpecies (example): A species of origin a substance raw material. | ||||
part | Σ | 0..1 | CodeableConcept | An anatomical origin of the source material within an organism Binding: SourceMaterialPart (example): An anatomical origin of the source material within an organism. | ||||
countryOfOrigin | Σ | 0..* | CodeableConcept | The country or countries where the material is harvested Binding: CountryValueSet (required): Jurisdiction codes | ||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
SubstanceDefinition.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.classification | required | PqcmcImpurityClassificationTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-impurity-classification-terminology from this IG | |
SubstanceDefinition.domain | example | MedicinalProductDomainhttp://hl7.org/fhir/ValueSet/medicinal-product-domain from the FHIR Standard | |
SubstanceDefinition.grade | example | SubstanceGradehttp://hl7.org/fhir/ValueSet/substance-grade from the FHIR Standard | |
SubstanceDefinition.moiety.stereochemistry | example | Stereochemistryhttp://hl7.org/fhir/ValueSet/substance-stereochemistry from the FHIR Standard | |
SubstanceDefinition.moiety.opticalActivity | example | OpticalActivityhttp://hl7.org/fhir/ValueSet/substance-optical-activity from the FHIR Standard | |
SubstanceDefinition.moiety.measurementType | example | SubstanceAmountTypehttp://hl7.org/fhir/ValueSet/substance-amount-type from the FHIR Standard | |
SubstanceDefinition.characterization.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.characterization.form | example | SubstanceFormhttp://hl7.org/fhir/ValueSet/substance-form from the FHIR Standard | |
SubstanceDefinition.property.type | example | ProductCharacteristichttp://hl7.org/fhir/ValueSet/product-characteristic-codes from the FHIR Standard | |
SubstanceDefinition.molecularWeight.method | example | WeightMethodhttp://hl7.org/fhir/ValueSet/substance-weight-method from the FHIR Standard | |
SubstanceDefinition.molecularWeight.type | example | WeightTypehttp://hl7.org/fhir/ValueSet/substance-weight-type from the FHIR Standard | |
SubstanceDefinition.structure.stereochemistry | example | Stereochemistryhttp://hl7.org/fhir/ValueSet/substance-stereochemistry from the FHIR Standard | |
SubstanceDefinition.structure.opticalActivity | example | OpticalActivityhttp://hl7.org/fhir/ValueSet/substance-optical-activity from the FHIR Standard | |
SubstanceDefinition.structure.technique | example | StructureTechniquehttp://hl7.org/fhir/ValueSet/substance-structure-technique from the FHIR Standard | |
SubstanceDefinition.structure.representation.type | required | PqcmcRepresentationTypeshttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-representation-types from this IG | |
SubstanceDefinition.structure.representation.format | example | SubstanceRepresentationFormathttp://hl7.org/fhir/ValueSet/substance-representation-format from the FHIR Standard | |
SubstanceDefinition.structure.representation:graphic.type | example | Pattern: C54273http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:graphic.format | example | SubstanceRepresentationFormathttp://hl7.org/fhir/ValueSet/substance-representation-format from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureFile.type | example | Pattern: C103240http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureFile.format | example | SubstanceRepresentationFormathttp://hl7.org/fhir/ValueSet/substance-representation-format from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.type | example | Pattern: C45253http://hl7.org/fhir/ValueSet/substance-representation-type from the FHIR Standard | |
SubstanceDefinition.structure.representation:structureString.format | required | PqcmcChemicalStructureDataFileTypeTerminologyhttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-chemical-structure-datafile-type-terminology from this IG | |
SubstanceDefinition.code.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.code:unii.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.code:uniProt.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name.type | required | PqcmcSubstanceNameTypehttp://hl7.org/fhir/us/pq-cmc-fda/ValueSet/pqcmc-substance-name-type from this IG | |
SubstanceDefinition.name.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:sub.type | example | Pattern: C97054("Generic Name")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:sub.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:sub.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:sub.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:sub.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:sub.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:sub.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:gsrs.type | example | Pattern: C203355("GSRS Preferred Term")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:gsrs.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:gsrs.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:gsrs.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:gsrs.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:gsrs.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:gsrs.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:isbt.type | example | Pattern: C95517("ISBT-128 DIN")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:isbt.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:isbt.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:isbt.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:isbt.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:isbt.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:isbt.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:comp.type | example | Pattern: C203354("Company ID/Code")http://hl7.org/fhir/ValueSet/substance-name-type from the FHIR Standard | |
SubstanceDefinition.name:comp.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.name:comp.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
SubstanceDefinition.name:comp.domain | example | SubstanceNameDomainhttp://hl7.org/fhir/ValueSet/substance-name-domain from the FHIR Standard | |
SubstanceDefinition.name:comp.jurisdiction | example | JurisdictionValueSethttp://hl7.org/fhir/ValueSet/jurisdiction from the FHIR Standard | |
SubstanceDefinition.name:comp.official.authority | preferred | SubstanceNameAuthorityhttp://hl7.org/fhir/ValueSet/substance-name-authority from the FHIR Standard | |
SubstanceDefinition.name:comp.official.status | preferred | PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status from the FHIR Standard | |
SubstanceDefinition.relationship.type | example | SubstanceRelationshipTypehttp://hl7.org/fhir/ValueSet/substance-relationship-type from the FHIR Standard | |
SubstanceDefinition.relationship.comparator | example | SubstanceAmountTypehttp://hl7.org/fhir/ValueSet/substance-amount-type from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.type | example | SourceMaterialTypehttp://hl7.org/fhir/ValueSet/substance-source-material-type from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.genus | example | SourceMaterialGenushttp://hl7.org/fhir/ValueSet/substance-source-material-genus from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.species | example | SourceMaterialSpecieshttp://hl7.org/fhir/ValueSet/substance-source-material-species from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.part | example | SourceMaterialParthttp://hl7.org/fhir/ValueSet/substance-source-material-part from the FHIR Standard | |
SubstanceDefinition.sourceMaterial.countryOfOrigin | required | CountryValueSethttp://hl7.org/fhir/ValueSet/country|5.0.0 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
att-1 | error | SubstanceDefinition.characterization.file:AnalysisGraphic, SubstanceDefinition.characterization.file:AnalyticalInstrumentData | If the Attachment has data, it SHALL have a contentType : data.empty() or contentType.exists() | |
cmc-impurity-unii-required | error | SubstanceDefinition | If Product Impurity Chemical Structure Data File is not present, then a unii is required : structure.representation.type.coding.where( system = 'http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl' and code = 'C103240' ).exists().not() implies ( code.where( code.coding.exists(system = 'http://fdasis.nlm.nih.gov') ).exists() ) | |
cmc-name-preferred | error | SubstanceDefinition.name | Name.preferred: at most one = true : select(preferred = true).count() < 2 | |
dom-2 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | SubstanceDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | SubstanceDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | SubstanceDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from SubstanceDefinition
Summary
Mandatory: 2 elements(15 nested mandatory elements)
Must-Support: 37 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron