Profile_R4_SubstanceSpecification_R4B_SubstanceDefinition - Definitions - Extensions for Using Data Elements from FHIR R4 in FHIR R4B v0.1.0

Is Modifier false

Must Support false

Summary true

4. SubstanceDefinition.meta

Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Short Metadata about the resource

Control 0..1

Meta

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

6. SubstanceDefinition.implicitRules

Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Short A set of rules under which this content was created

Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control 0..1

uri

Is Modifier true because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

8. SubstanceDefinition.language

Definition

The base language in which the resource is written.

Short Language of the resource content

Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control 0..1

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

IETF language tag

Additional Bindings

Purpose

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

10. SubstanceDefinition.text

Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Short Text summary of the resource, for human interpretation

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control 0..1

Narrative

Is Modifier false

Must Support false

Summary false

Alternate Names narrative, html, xhtml, display

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

12. SubstanceDefinition.contained

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Short Contained, inline Resources

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Control 0..*

Resource

Is Modifier false

Must Support false

Summary false

Alternate Names inline resources, anonymous resources, contained resources

Invariants dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))

14. SubstanceDefinition.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

This element introduces a set of slices on SubstanceDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. SubstanceDefinition.extension:type

Slice Name type

Definition

R4: SubstanceSpecification.type (new:CodeableConcept)

Short R4: High level categorization, e.g. polymer or nucleic acid (new)

Comments

Element SubstanceSpecification.type has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.type has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: High level categorization, e.g. polymer or nucleic acid (new)) (Extension Type: CodeableConcept)

Is Modifier false

Must Support false

Summary false

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())

18. SubstanceDefinition.extension:source

Slice Name source

Definition

R4: SubstanceSpecification.source (new:Reference(DocumentReference))

Short R4: Supporting literature (new)

Comments

Element SubstanceSpecification.source has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.source has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4: Supporting literature (new)) (Extension Type: Reference(Cross-version Profile for R4.DocumentReference for use in FHIR R4B, DocumentReference))

Is Modifier false

Must Support false

Summary false

20. SubstanceDefinition.extension:comment

Slice Name comment

Definition

R4: SubstanceSpecification.comment (new:string)

Short R4: Textual comment about this record of a substance (new)

Comments

Element SubstanceSpecification.comment has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.comment has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Textual comment about this record of a substance (new)) (Extension Type: string)

Is Modifier false

Must Support false

Summary false

22. SubstanceDefinition.extension:referenceInformation

Slice Name referenceInformation

Definition

R4: SubstanceSpecification.referenceInformation (new:Reference(SubstanceReferenceInformation))

Short R4: General information detailing this substance (new)

Comments

Element SubstanceSpecification.referenceInformation has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.referenceInformation has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: General information detailing this substance (new)) (Extension Type: Reference(Cross-version Profile for R4.SubstanceReferenceInformation for use in FHIR R4B, Basic))

Is Modifier false

Must Support false

Summary false

24. SubstanceDefinition.extension:nucleicAcid

Slice Name nucleicAcid

Definition

R4: SubstanceSpecification.nucleicAcid (new:Reference(SubstanceNucleicAcid))

Short R4: Data items specific to nucleic acids (new)

Comments

Element SubstanceSpecification.nucleicAcid has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.nucleicAcid has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Data items specific to nucleic acids (new)) (Extension Type: Reference(Cross-version Profile for R4.SubstanceNucleicAcid for use in FHIR R4B, Basic))

Is Modifier false

Must Support false

Summary false

26. SubstanceDefinition.extension:polymer

Slice Name polymer

Definition

R4: SubstanceSpecification.polymer (new:Reference(SubstancePolymer))

Short R4: Data items specific to polymers (new)

Comments

Element SubstanceSpecification.polymer has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.polymer has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Data items specific to polymers (new)) (Extension Type: Reference(Cross-version Profile for R4.SubstancePolymer for use in FHIR R4B, Basic))

Is Modifier false

Must Support false

Summary false

28. SubstanceDefinition.extension:protein

Slice Name protein

Definition

R4: SubstanceSpecification.protein (new:Reference(SubstanceProtein))

Short R4: Data items specific to proteins (new)

Comments

Element SubstanceSpecification.protein has a context of SubstanceDefinition based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.protein has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Data items specific to proteins (new)) (Extension Type: Reference(Cross-version Profile for R4.SubstanceProtein for use in FHIR R4B, Basic))

Is Modifier false

Must Support false

Summary false

30. SubstanceDefinition.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them

Must Support false

Summary false

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Names extensions, user content

32. SubstanceDefinition.identifier

Definition

Identifier by which this substance is known.

Short Identifier by which this substance is known

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..*

Identifier

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

34. SubstanceDefinition.version

Definition

A business level version identifier of the substance.

Short A business level version identifier of the substance

Note This is a business version Id, not a resource version Id (see discussion)

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

36. SubstanceDefinition.status

Definition

Status of substance within the catalogue e.g. active, retired.

Short Status of substance within the catalogue e.g. active, retired

Control 0..1

The codes SHOULD be taken from PublicationStatus
(preferred to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

38. SubstanceDefinition.classification

Definition

A high level categorization, e.g. polymer or nucleic acid, or food, chemical, biological, or a lower level such as the general types of polymer (linear or branch chain) or type of impurity (process related or contaminant).

Short A categorization, high level e.g. polymer or nucleic acid, or food, chemical, biological, or lower e.g. polymer linear or branch chain, or type of impurity

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

40. SubstanceDefinition.domain

Definition

If the substance applies to human or veterinary use.

Short If the substance applies to human or veterinary use

Control 0..1

For example codes, see MedicinalProductDomain
(example to http://hl7.org/fhir/ValueSet/medicinal-product-domain|4.3.0)

Applicable domain for this product (e.g. human, veterinary).

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

42. SubstanceDefinition.grade

Definition

The quality standard, established benchmark, to which substance complies (e.g. USP/NF, Ph. Eur, JP, BP, Company Standard).

Short The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP)

Control 0..*

For example codes, see SubstanceGrade
(example to http://hl7.org/fhir/ValueSet/substance-grade|4.3.0)

The quality standard, established benchmark, to which a substance complies

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

44. SubstanceDefinition.description

Definition

Textual description of the substance.

Short Textual description of the substance

Control 0..1

markdown

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

46. SubstanceDefinition.informationSource

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(Citation)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

48. SubstanceDefinition.note

Definition

Textual comment about the substance's catalogue or registry record.

Short Textual comment about the substance's catalogue or registry record

Control 0..*

Annotation

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

50. SubstanceDefinition.manufacturer

Definition

The entity that creates, makes, produces or fabricates the substance. This is a set of potential manufacturers but is not necessarily comprehensive.

Short The entity that creates, makes, produces or fabricates the substance

Control 0..*

Type Reference(Organization)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

52. SubstanceDefinition.supplier

Definition

An entity that is the source for the substance. It may be different from the manufacturer. Supplier is synonymous to a distributor.

Short An entity that is the source for the substance. It may be different from the manufacturer

Control 0..*

Type Reference(Organization)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

54. SubstanceDefinition.moiety

Definition

Moiety, for structural modifications.

Short Moiety, for structural modifications

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

56. SubstanceDefinition.moiety.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

58. SubstanceDefinition.moiety.extension

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

60. SubstanceDefinition.moiety.modifierExtension

Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

62. SubstanceDefinition.moiety.role

Definition

Role that the moiety is playing.

Short Role that the moiety is playing

Control 0..1

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

64. SubstanceDefinition.moiety.identifier

Definition

Identifier by which this moiety substance is known.

Short Identifier by which this moiety substance is known

Note This is a business identifier, not a resource identifier (see discussion)

Control 0..1

Identifier

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

66. SubstanceDefinition.moiety.name

Definition

Textual name for this moiety substance.

Short Textual name for this moiety substance

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

68. SubstanceDefinition.moiety.stereochemistry

Definition

Stereochemistry type.

Short Stereochemistry type

Control 0..1

For example codes, see Stereochemistry
(example to http://hl7.org/fhir/ValueSet/substance-stereochemistry|4.3.0)

The optical rotation type of a substance.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

70. SubstanceDefinition.moiety.opticalActivity

Definition

Optical activity type.

Short Optical activity type

Control 0..1

For example codes, see OpticalActivity
(example to http://hl7.org/fhir/ValueSet/substance-optical-activity|4.3.0)

The optical rotation type of a substance.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

72. SubstanceDefinition.moiety.molecularFormula

Definition

Molecular formula for this moiety of this substance, typically using the Hill system.

Short Molecular formula for this moiety (e.g. with the Hill system)

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

74. SubstanceDefinition.moiety.amount[x]

Definition

Quantitative value for this moiety.

Short Quantitative value for this moiety

Control 0..1

Type Choice of: Quantity, string

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

76. SubstanceDefinition.moiety.measurementType

Definition

The measurement type of the quantitative value. In capturing the actual relative amounts of substances or molecular fragments it may be necessary to indicate whether the amount refers to, for example, a mole ratio or weight ratio.

Short The measurement type of the quantitative value

Control 0..1

For example codes, see SubstanceAmountType
(example to http://hl7.org/fhir/ValueSet/substance-amount-type|4.3.0)

The relationship between two substance types.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

78. SubstanceDefinition.property

Definition

General specifications for this substance.

Short General specifications for this substance

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

80. SubstanceDefinition.property.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

82. SubstanceDefinition.property.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SubstanceDefinition.property.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

84. SubstanceDefinition.property.extension:category

Slice Name category

Definition

R4: SubstanceSpecification.property.category (new:CodeableConcept)

Short R4: A category for this property, e.g. Physical, Chemical, Enzymatic (new)

Comments

Element SubstanceSpecification.property.category has a context of SubstanceDefinition.property based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.property.category has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: A category for this property, e.g. Physical, Chemical, Enzymatic (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

86. SubstanceDefinition.property.extension:code

Slice Name code

Definition

R4: SubstanceSpecification.property.code (new:CodeableConcept)

Short R4: Property type e.g. viscosity, pH, isoelectric point (new)

Comments

Element SubstanceSpecification.property.code has a context of SubstanceDefinition.property based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.property.code has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Property type e.g. viscosity, pH, isoelectric point (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

88. SubstanceDefinition.property.extension:parameters

Slice Name parameters

Definition

R4: SubstanceSpecification.property.parameters (new:string)

Short R4: Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1) (new)

Comments

Element SubstanceSpecification.property.parameters has a context of SubstanceDefinition.property based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.property.parameters has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Parameters that were used in the measurement of a property (e.g. for viscosity: measured at 20C with a pH of 7.1) (new)) (Extension Type: string)

Is Modifier false

Summary false

90. SubstanceDefinition.property.extension:definingSubstance

Slice Name definingSubstance

Definition

R4: SubstanceSpecification.property.definingSubstance[x] (new:CodeableConcept, Reference(SubstanceSpecification,Substance))

Short R4: A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol) (new)

Comments

Element SubstanceSpecification.property.definingSubstance[x] has a context of SubstanceDefinition.property based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.property.definingSubstance[x] has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: A substance upon which a defining property depends (e.g. for solubility: in water, in alcohol) (new)) (Extension Type: Choice of: Reference(Cross-version Profile for R4.SubstanceSpecification for use in FHIR R4B, SubstanceDefinition, Cross-version Profile for R4.Substance for use in FHIR R4B, Substance), CodeableConcept)

Is Modifier false

Summary false

92. SubstanceDefinition.property.extension:amount

Slice Name amount

Definition

R4: SubstanceSpecification.property.amount[x] (new:Quantity, string)

Short R4: Quantitative value for this property (new)

Comments

Element SubstanceSpecification.property.amount[x] has a context of SubstanceDefinition.property based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.property.amount[x] has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Quantitative value for this property (new)) (Extension Type: Choice of: Quantity, string)

Is Modifier false

Summary false

94. SubstanceDefinition.property.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

96. SubstanceDefinition.property.type

Definition

A code expressing the type of property.

Short A code expressing the type of property

Control 1..1

For example codes, see product-characteristic-codes (??)
(example to http://hl7.org/fhir/ValueSet/product-characteristic-codes)

This value set includes all observable entity codes from SNOMED CT - provided as an exemplar value set.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

98. SubstanceDefinition.property.value[x]

Definition

A value for the property.

Short A value for the property

Control 0..1

Type Choice of: CodeableConcept, Quantity, date, boolean, Attachment

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

100. SubstanceDefinition.molecularWeight

Definition

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Short The molecular weight or weight range

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

102. SubstanceDefinition.molecularWeight.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

104. SubstanceDefinition.molecularWeight.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

106. SubstanceDefinition.molecularWeight.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

108. SubstanceDefinition.molecularWeight.method

Definition

The method by which the molecular weight was determined.

Short The method by which the weight was determined

Control 0..1

For example codes, see WeightMethod
(example to http://hl7.org/fhir/ValueSet/substance-weight-method|4.3.0)

The method by which the substance weight was measured.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

110. SubstanceDefinition.molecularWeight.type

Definition

Type of molecular weight such as exact, average (also known as. number average), weight average.

Short Type of molecular weight e.g. exact, average, weight average

Control 0..1

For example codes, see WeightType
(example to http://hl7.org/fhir/ValueSet/substance-weight-type|4.3.0)

The type of substance weight measurement.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

112. SubstanceDefinition.molecularWeight.amount

Definition

Used to capture quantitative values for a variety of elements. If only limits are given, the arithmetic mean would be the average. If only a single definite value for a given element is given, it would be captured in this field.

Short Used to capture quantitative values for a variety of elements

Control 1..1

Quantity

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

114. SubstanceDefinition.structure

Definition

Structural information.

Short Structural information

Control 0..1

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

116. SubstanceDefinition.structure.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

118. SubstanceDefinition.structure.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SubstanceDefinition.structure.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

120. SubstanceDefinition.structure.extension:isotope

Slice Name isotope

Definition

R4: SubstanceSpecification.structure.isotope (new:BackboneElement)

Short R4: Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio (new)

Comments

Element SubstanceSpecification.structure.isotope has a context of SubstanceDefinition.structure based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.structure.isotope has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4: Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio (new)) (Complex Extension)

Is Modifier false

122. SubstanceDefinition.structure.extension:source

Slice Name source

Definition

R4: SubstanceSpecification.structure.source (new:Reference(DocumentReference))

Short R4: Supporting literature (new)

Comments

Element SubstanceSpecification.structure.source has a context of SubstanceDefinition.structure based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.structure.source has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..*
This element is affected by the following invariants: ele-1

Type Extension(R4: Supporting literature (new)) (Extension Type: Reference(Cross-version Profile for R4.DocumentReference for use in FHIR R4B, DocumentReference))

Is Modifier false

Summary false

124. SubstanceDefinition.structure.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

126. SubstanceDefinition.structure.stereochemistry

Definition

Stereochemistry type.

Short Stereochemistry type

Control 0..1

For example codes, see Stereochemistry
(example to http://hl7.org/fhir/ValueSet/substance-stereochemistry|4.3.0)

The optical rotation type of a substance.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

128. SubstanceDefinition.structure.opticalActivity

Definition

Optical activity type.

Short Optical activity type

Control 0..1

For example codes, see OpticalActivity
(example to http://hl7.org/fhir/ValueSet/substance-optical-activity|4.3.0)

The optical rotation type of a substance.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

130. SubstanceDefinition.structure.molecularFormula

Definition

Molecular formula of this substance, typically using the Hill system.

Short Molecular formula (e.g. using the Hill system)

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

132. SubstanceDefinition.structure.molecularFormulaByMoiety

Definition

Specified per moiety according to the Hill system, i.e. first C, then H, then alphabetical, each moiety separated by a dot.

Short Specified per moiety according to the Hill system

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

134. SubstanceDefinition.structure.molecularWeight

Definition

The molecular weight or weight range (for proteins, polymers or nucleic acids).

Short The molecular weight or weight range

Control 0..1

Type Seettp://hl7.org/fhir/StructureDefinition/SubstanceDefinition#SubstanceDefinition.molecularWeight

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

136. SubstanceDefinition.structure.technique

Definition

The method used to elucidate the structure or characterization of the drug substance. Examples: X-ray, HPLC, NMR, Peptide mapping, Ligand binding assay.

Short The method used to find the structure e.g. X-ray, NMR

Control 0..*

For example codes, see StructureTechnique
(example to http://hl7.org/fhir/ValueSet/substance-structure-technique|4.3.0)

The method used to elucidate the structure or characterization of the drug substance.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

138. SubstanceDefinition.structure.sourceDocument

Definition

The source of information about the structure.

Short Source of information for the structure

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

140. SubstanceDefinition.structure.representation

Definition

A depiction of the structure or characterization of the substance.

Short A depiction of the structure or characterization of the substance

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

142. SubstanceDefinition.structure.representation.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

144. SubstanceDefinition.structure.representation.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SubstanceDefinition.structure.representation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

146. SubstanceDefinition.structure.representation.extension:attachment

Slice Name attachment

Definition

R4: SubstanceSpecification.structure.representation.attachment (new:Attachment)

Short R4: An attached file with the structural representation (new)

Comments

Element SubstanceSpecification.structure.representation.attachment has a context of SubstanceDefinition.structure.representation based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.structure.representation.attachment has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: An attached file with the structural representation (new)) (Extension Type: Attachment)

Is Modifier false

Summary false

148. SubstanceDefinition.structure.representation.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

150. SubstanceDefinition.structure.representation.type

Definition

The kind of structural representation (e.g. full, partial).

Short The kind of structural representation (e.g. full, partial)

Control 0..1

For example codes, see SubstanceRepresentationType
(example to http://hl7.org/fhir/ValueSet/substance-representation-type|4.3.0)

A format of a substance representation.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

152. SubstanceDefinition.structure.representation.representation

Definition

The structural representation or characterization as a text string in a standard format.

Short The structural representation or characterization as a text string in a standard format

Control 0..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

154. SubstanceDefinition.structure.representation.format

Definition

The format of the representation e.g. InChI, SMILES, MOLFILE, CDX, SDF, PDB, mmCIF. The logical content type rather than the physical file format of a document.

Short The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format)

Control 0..1

For example codes, see SubstanceRepresentationFormat
(example to http://hl7.org/fhir/ValueSet/substance-representation-format|4.3.0)

A format of a substance representation.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

156. SubstanceDefinition.structure.representation.document

Definition

An attached file with the structural representation or characterization e.g. a molecular structure graphic of the substance, a JCAMP or AnIML file.

Short An attachment with the structural representation e.g. a structure graphic or AnIML file

Control 0..1

Type Reference(DocumentReference)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

158. SubstanceDefinition.code

Definition

Codes associated with the substance.

Short Codes associated with the substance

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

160. SubstanceDefinition.code.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

162. SubstanceDefinition.code.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SubstanceDefinition.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

164. SubstanceDefinition.code.extension:comment

Slice Name comment

Definition

R4: SubstanceSpecification.code.comment (new:string)

Short R4: Any comment can be provided in this field, if necessary (new)

Comments

Element SubstanceSpecification.code.comment has a context of SubstanceDefinition.code based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.code.comment has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: Any comment can be provided in this field, if necessary (new)) (Extension Type: string)

Is Modifier false

Summary false

166. SubstanceDefinition.code.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

168. SubstanceDefinition.code.code

Definition

The specific code.

Short The specific code

Control 0..1

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

170. SubstanceDefinition.code.status

Definition

Status of the code assignment, for example 'provisional', 'approved'.

Short Status of the code assignment, for example 'provisional', 'approved'

Control 0..1

The codes SHOULD be taken from PublicationStatus
(preferred to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

172. SubstanceDefinition.code.statusDate

Definition

The date at which the code status was changed as part of the terminology maintenance.

Short The date at which the code status was changed

Control 0..1

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

174. SubstanceDefinition.code.note

Definition

Any comment can be provided in this field, if necessary.

Short Any comment can be provided in this field

Control 0..*

Annotation

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

176. SubstanceDefinition.code.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

178. SubstanceDefinition.name

Definition

Names applicable to this substance.

Short Names applicable to this substance

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

180. SubstanceDefinition.name.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

182. SubstanceDefinition.name.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

184. SubstanceDefinition.name.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

186. SubstanceDefinition.name.name

Definition

The actual name.

Short The actual name

Control 1..1

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

188. SubstanceDefinition.name.type

Definition

Name type, for example 'systematic', 'scientific, 'brand'.

Short Name type e.g. 'systematic', 'scientific, 'brand'

Control 0..1

For example codes, see SubstanceNameType
(example to http://hl7.org/fhir/ValueSet/substance-name-type|4.3.0)

The type of a name given to a substance.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

190. SubstanceDefinition.name.status

Definition

The status of the name, for example 'current', 'proposed'.

Short The status of the name e.g. 'current', 'proposed'

Control 0..1

The codes SHOULD be taken from PublicationStatus
(preferred to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

192. SubstanceDefinition.name.preferred

Definition

If this is the preferred name for this substance.

Short If this is the preferred name for this substance

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Meaning if Missing If this value is not present, there is no statement being made about whether this is the preferred name or not. No inference can be made

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

194. SubstanceDefinition.name.language

Definition

Human language that the name is written in.

Short Human language that the name is written in

Control 0..*

The codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages|4.3.0)

IETF language tag

Additional Bindings

Purpose

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

196. SubstanceDefinition.name.domain

Definition

The use context of this name for example if there is a different name a drug active ingredient as opposed to a food colour additive.

Short The use context of this name e.g. as an active ingredient or as a food colour additive

Control 0..*

For example codes, see SubstanceNameDomain
(example to http://hl7.org/fhir/ValueSet/substance-name-domain|4.3.0)

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.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

198. SubstanceDefinition.name.jurisdiction

Definition

The jurisdiction where this name applies.

Short The jurisdiction where this name applies

Control 0..*

For example codes, see Jurisdiction ValueSet
(example to http://hl7.org/fhir/ValueSet/jurisdiction|4.3.0)

Jurisdiction codes

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

200. SubstanceDefinition.name.synonym

Definition

A synonym of this particular name, by which the substance is also known.

Short A synonym of this particular name, by which the substance is also known

Control 0..*

Type Seettp://hl7.org/fhir/StructureDefinition/SubstanceDefinition#SubstanceDefinition.name

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

202. SubstanceDefinition.name.translation

Definition

A translation for this name into another human language.

Short A translation for this name into another human language

Control 0..*

Type Seettp://hl7.org/fhir/StructureDefinition/SubstanceDefinition#SubstanceDefinition.name

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

204. SubstanceDefinition.name.official

Definition

Details of the official nature of this name.

Short Details of the official nature of this name

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

206. SubstanceDefinition.name.official.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

208. SubstanceDefinition.name.official.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

210. SubstanceDefinition.name.official.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

212. SubstanceDefinition.name.official.authority

Definition

Which authority uses this official name.

Short Which authority uses this official name

Control 0..1

The codes SHOULD be taken from SubstanceNameAuthority
(preferred to http://hl7.org/fhir/ValueSet/substance-name-authority|4.3.0)

An authority that officates substance names.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

214. SubstanceDefinition.name.official.status

Definition

The status of the official name, for example 'draft', 'active', 'retired'.

Short The status of the official name, for example 'draft', 'active'

Control 0..1

The codes SHOULD be taken from PublicationStatus
(preferred to http://hl7.org/fhir/ValueSet/publication-status|4.3.0)

The lifecycle status of an artifact.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

216. SubstanceDefinition.name.official.date

Definition

Date of the official name change.

Short Date of official name change

Control 0..1

dateTime

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

218. SubstanceDefinition.name.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

220. SubstanceDefinition.relationship

Definition

A link between this substance and another, with details of the relationship.

Short A link between this substance and another

Control 0..*

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

222. SubstanceDefinition.relationship.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

224. SubstanceDefinition.relationship.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

This element introduces a set of slices on SubstanceDefinition.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

226. SubstanceDefinition.relationship.extension:substance

Slice Name substance

Definition

R4: SubstanceSpecification.relationship.substance[x] (new:CodeableConcept, Reference(SubstanceSpecification))

Short R4: A pointer to another substance, as a resource or just a representational code (new)

Comments

Element SubstanceSpecification.relationship.substance[x] has a context of SubstanceDefinition.relationship based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.relationship.substance[x] has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: A pointer to another substance, as a resource or just a representational code (new)) (Extension Type: Choice of: Reference(Cross-version Profile for R4.SubstanceSpecification for use in FHIR R4B, SubstanceDefinition), CodeableConcept)

Is Modifier false

Summary false

228. SubstanceDefinition.relationship.extension:relationship

Slice Name relationship

Definition

R4: SubstanceSpecification.relationship.relationship (new:CodeableConcept)

Short R4: For example "salt to parent", "active moiety", "starting material" (new)

Comments

Element SubstanceSpecification.relationship.relationship has a context of SubstanceDefinition.relationship based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.relationship.relationship has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: For example "salt to parent", "active moiety", "starting material" (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

230. SubstanceDefinition.relationship.extension:amount

Slice Name amount

Definition

R4: SubstanceSpecification.relationship.amount[x] additional types (Range)

Short R4: A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other additional types

Comments

Element SubstanceSpecification.relationship.amount[x] is mapped to FHIR R4B element SubstanceDefinition.relationship.amount[x] as SourceIsBroaderThanTarget. The mappings for SubstanceSpecification.relationship.amount[x] do not cover the following types: Range. The target context SubstanceDefinition.relationship.amount[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element SubstanceDefinition.relationship.

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other additional types) (Extension Type: Range)

Is Modifier false

Summary false

232. SubstanceDefinition.relationship.extension:amountRatioLowLimit

Slice Name amountRatioLowLimit

Definition

R4: SubstanceSpecification.relationship.amountRatioLowLimit (new:Ratio)

Short R4: For use when the numeric (new)

Comments

Element SubstanceSpecification.relationship.amountRatioLowLimit has a context of SubstanceDefinition.relationship based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.relationship.amountRatioLowLimit has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: For use when the numeric (new)) (Extension Type: Ratio)

Is Modifier false

Summary false

234. SubstanceDefinition.relationship.extension:amountType

Slice Name amountType

Definition

R4: SubstanceSpecification.relationship.amountType (new:CodeableConcept)

Short R4: An operator for the amount, for example "average", "approximately", "less than" (new)

Comments

Element SubstanceSpecification.relationship.amountType has a context of SubstanceDefinition.relationship based on following the parent source element upwards and mapping to SubstanceDefinition. Element SubstanceSpecification.relationship.amountType has no mapping targets in FHIR R4B. Typically, this is because the element has been added (is a new element).

Control 0..1
This element is affected by the following invariants: ele-1

Type Extension(R4: An operator for the amount, for example "average", "approximately", "less than" (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

236. SubstanceDefinition.relationship.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

238. SubstanceDefinition.relationship.substanceDefinition[x]

Definition

A pointer to another substance, as a resource or just a representational code.

Short A pointer to another substance, as a resource or a representational code

Control 0..1

Type Choice of: Reference(SubstanceDefinition), CodeableConcept

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

240. SubstanceDefinition.relationship.type

Definition

For example "salt to parent", "active moiety", "starting material", "polymorph", "impurity of".

Short For example "salt to parent", "active moiety"

Control 1..1

For example codes, see SubstanceRelationshipType
(example to http://hl7.org/fhir/ValueSet/substance-relationship-type|4.3.0)

The relationship between two substance types.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

242. SubstanceDefinition.relationship.isDefining

Definition

For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible substance relationships.

Short For example where an enzyme strongly bonds with a particular substance, this is a defining relationship for that enzyme, out of several possible relationships

Control 0..1

boolean

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Meaning if Missing If this value is not present, there is no statement being made about whether this is a defining relationship or not. No inference can be made

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

244. SubstanceDefinition.relationship.amount[x]

Definition

A numeric factor for the relationship, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other.

Short A numeric factor for the relationship, e.g. that a substance salt has some percentage of active substance in relation to some other

Control 0..1

Type Choice of: Quantity, Ratio, string

[x] Note SeeChoice of Data Typesfor further information about how to use [x]

Is Modifier false

Primitive Value This primitive element may be present, or absent, or replaced by an extension

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

246. SubstanceDefinition.relationship.ratioHighLimitAmount

Definition

For use when the numeric has an uncertain range.

Short For use when the numeric has an uncertain range

Control 0..1

Ratio

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

248. SubstanceDefinition.relationship.comparator

Definition

An operator for the amount, for example "average", "approximately", "less than".

Short An operator for the amount, for example "average", "approximately", "less than"

Control 0..1

For example codes, see SubstanceAmountType
(example to http://hl7.org/fhir/ValueSet/substance-amount-type|4.3.0)

The relationship between two substance types.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

250. SubstanceDefinition.relationship.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

252. SubstanceDefinition.sourceMaterial

Definition

Material or taxonomic/anatomical source for the substance.

Short Material or taxonomic/anatomical source

Control 0..1

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)

254. SubstanceDefinition.sourceMaterial.id

Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Short Unique id for inter-element referencing

Control 0..1

Is Modifier false

XML Format In the XML format, this property is represented as an attribute.

Summary false

256. SubstanceDefinition.sourceMaterial.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

258. SubstanceDefinition.sourceMaterial.modifierExtension

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Short Extensions that cannot be ignored even if unrecognized

Comments

Control 0..*

Is Modifier true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them

Summary true

Requirements

Alternate Names extensions, user content, modifiers

260. SubstanceDefinition.sourceMaterial.type

Definition

A classification that provides the origin of the raw material. Example: cat hair would be an Animal source type.

Short Classification of the origin of the raw material. e.g. cat hair is an Animal source type

Control 0..1

For example codes, see SourceMaterialType
(example to http://hl7.org/fhir/ValueSet/substance-source-material-type|4.3.0)

A classification that provides the origin of the substance raw material.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

262. SubstanceDefinition.sourceMaterial.genus

Definition

The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.

Short The genus of an organism e.g. the Latin epithet of the plant/animal scientific name

Control 0..1

For example codes, see SourceMaterialGenus
(example to http://hl7.org/fhir/ValueSet/substance-source-material-genus|4.3.0)

The genus of an organism, typically referring to the Latin epithet of the genus element of the plant/animal scientific name.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

264. SubstanceDefinition.sourceMaterial.species

Definition

The species of an organism, typically referring to the Latin epithet of the species of the plant/animal.

Short The species of an organism e.g. the Latin epithet of the species of the plant/animal

Control 0..1

For example codes, see SourceMaterialSpecies
(example to http://hl7.org/fhir/ValueSet/substance-source-material-species|4.3.0)

A species of origin a substance raw material.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

266. SubstanceDefinition.sourceMaterial.part

Definition

An anatomical origin of the source material within an organism.

Short An anatomical origin of the source material within an organism

Control 0..1

For example codes, see SourceMaterialPart
(example to http://hl7.org/fhir/ValueSet/substance-source-material-part|4.3.0)

An anatomical origin of the source material within an organism.

Is Modifier false

Must Support false

Summary true

Invariants ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

268. SubstanceDefinition.sourceMaterial.countryOfOrigin

Definition

The country or countries where the material is harvested.

Short The country or countries where the material is harvested

Control 0..*

The codes SHALL be taken from Country ValueSet
(required to http://hl7.org/fhir/ValueSet/country|4.3.0)

Jurisdiction codes