Profile_R5_SubstanceDefinition_R4_SubstanceSpecification - Definitions - Extensions for Using Data Elements from FHIR R5 in FHIR R4 v0.1.0

Is Modifier false

Summary true

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

Summary true

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

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

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

Summary true

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

8. SubstanceSpecification.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.0.1)

A human language.

Additional Bindings

Purpose

Is Modifier false

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

Summary false

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

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

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

Summary false

Alternate Names inline resources, anonymous resources, contained resources

14. SubstanceSpecification.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier 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 SubstanceSpecification.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:

value @ url

16. SubstanceSpecification.extension:version

Slice Name version

Definition

R5: SubstanceDefinition.version (new:string)

Short R5: A business level version identifier of the substance (new)

Comments

Element SubstanceDefinition.version has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.version has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). An externally-defined extension that has been mapped as the representation of FHIR R5 element SubstanceDefinition.version: http://hl7.org/fhir/StructureDefinition/artifact-version.

Control 0..1

Type Extension(ArtifactVersion) (Extension Type: string)

Is Modifier false

Summary false

18. SubstanceSpecification.extension:classification

Slice Name classification

Definition

R5: SubstanceDefinition.classification (new:CodeableConcept)

Short R5: 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 (new)

Comments

Element SubstanceDefinition.classification has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.classification has no mapping targets in FHIR R4. 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(R5: 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 (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

20. SubstanceSpecification.extension:grade

Slice Name grade

Definition

R5: SubstanceDefinition.grade (new:CodeableConcept)

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

Comments

Element SubstanceDefinition.grade has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.grade has no mapping targets in FHIR R4. 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(R5: The quality standard, established benchmark, to which substance complies (e.g. USP/NF, BP) (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

22. SubstanceSpecification.extension:informationSource

Slice Name informationSource

Definition

R5: SubstanceDefinition.informationSource (new:Reference(Citation))

Short R5: Supporting literature (new)

Comments

Element SubstanceDefinition.informationSource has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.informationSource has no mapping targets in FHIR R4. 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(R5: Supporting literature (new)) (Extension Type: Reference(Cross-version Profile for R5.Citation for use in FHIR R4, Basic))

Is Modifier false

Summary false

24. SubstanceSpecification.extension:note

Slice Name note

Definition

R5: SubstanceDefinition.note (new:Annotation)

Short R5: Textual comment about the substance's catalogue or registry record (new)

Comments

Element SubstanceDefinition.note has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.note has no mapping targets in FHIR R4. 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(R5: Textual comment about the substance's catalogue or registry record (new)) (Extension Type: Annotation)

Is Modifier false

Summary false

26. SubstanceSpecification.extension:manufacturer

Slice Name manufacturer

Definition

R5: SubstanceDefinition.manufacturer (new:Reference(Organization))

Short R5: The entity that creates, makes, produces or fabricates the substance (new)

Comments

Element SubstanceDefinition.manufacturer has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.manufacturer has no mapping targets in FHIR R4. 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(R5: The entity that creates, makes, produces or fabricates the substance (new)) (Extension Type: Reference(Cross-version Profile for R5.Organization for use in FHIR R4, Organization))

Is Modifier false

Summary false

28. SubstanceSpecification.extension:supplier

Slice Name supplier

Definition

R5: SubstanceDefinition.supplier (new:Reference(Organization))

Short R5: An entity that is the source for the substance. It may be different from the manufacturer (new)

Comments

Element SubstanceDefinition.supplier has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.supplier has no mapping targets in FHIR R4. 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(R5: An entity that is the source for the substance. It may be different from the manufacturer (new)) (Extension Type: Reference(Cross-version Profile for R5.Organization for use in FHIR R4, Organization))

Is Modifier false

Summary false

30. SubstanceSpecification.extension:characterization

Slice Name characterization

Definition

R5: SubstanceDefinition.characterization (new:BackboneElement)

Short R5: General specifications for this substance (new)

Comments

Element SubstanceDefinition.characterization has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.characterization has no mapping targets in FHIR R4. 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(R5: General specifications for this substance (new)) (Complex Extension)

Is Modifier false

32. SubstanceSpecification.extension:referenceInformation

Slice Name referenceInformation

Definition

R5: SubstanceDefinition.referenceInformation (new:Reference(SubstanceReferenceInformation))

Short R5: General information detailing this substance (new)

Comments

Element SubstanceDefinition.referenceInformation has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.referenceInformation has no mapping targets in FHIR R4. 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(R5: General information detailing this substance (new)) (Extension Type: Reference(Cross-version Profile for R5.SubstanceReferenceInformation for use in FHIR R4, Basic))

Is Modifier false

Summary false

34. SubstanceSpecification.extension:nucleicAcid

Slice Name nucleicAcid

Definition

R5: SubstanceDefinition.nucleicAcid (new:Reference(SubstanceNucleicAcid))

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

Comments

Element SubstanceDefinition.nucleicAcid has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.nucleicAcid has no mapping targets in FHIR R4. 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(R5: Data items specific to nucleic acids (new)) (Extension Type: Reference(Cross-version Profile for R5.SubstanceNucleicAcid for use in FHIR R4, Basic))

Is Modifier false

Summary false

36. SubstanceSpecification.extension:polymer

Slice Name polymer

Definition

R5: SubstanceDefinition.polymer (new:Reference(SubstancePolymer))

Short R5: Data items specific to polymers (new)

Comments

Element SubstanceDefinition.polymer has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.polymer has no mapping targets in FHIR R4. 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(R5: Data items specific to polymers (new)) (Extension Type: Reference(Cross-version Profile for R5.SubstancePolymer for use in FHIR R4, Basic))

Is Modifier false

Summary false

38. SubstanceSpecification.extension:protein

Slice Name protein

Definition

R5: SubstanceDefinition.protein (new:Reference(SubstanceProtein))

Short R5: Data items specific to proteins (new)

Comments

Element SubstanceDefinition.protein has a context of SubstanceSpecification based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.protein has no mapping targets in FHIR R4. 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(R5: Data items specific to proteins (new)) (Extension Type: Reference(Cross-version Profile for R5.SubstanceProtein for use in FHIR R4, Basic))

Is Modifier false

Summary false

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

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

42. SubstanceSpecification.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..1

Is Modifier false

Summary true

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

44. SubstanceSpecification.identifier.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

46. SubstanceSpecification.identifier.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

48. SubstanceSpecification.identifier.extension:identifier

Slice Name identifier

Definition

R5: SubstanceDefinition.identifier

Short R5: identifier

Comments

Element SubstanceDefinition.identifier is mapped to FHIR R4 element SubstanceSpecification.identifier as SourceIsBroaderThanTarget. An externally-defined extension that has been mapped as the representation of FHIR R5 element SubstanceDefinition.identifier: http://hl7.org/fhir/StructureDefinition/artifact-identifier.

Control 0..*

Type Extension(Artifact Identifier) (Extension Type: Identifier)

Is Modifier false

Summary false

50. SubstanceSpecification.identifier.use

Definition

The purpose of this identifier.

Short usual | official | temp | secondary | old (If known)

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Control 0..1

The codes SHALL be taken from IdentifierUse
(required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

Identifies the purpose for this identifier, if known .

code

Is Modifier true because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.

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

Summary true

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

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

52. SubstanceSpecification.identifier.type

Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Short Description of identifier

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

Control 0..1

Unless not suitable, these codes SHALL be taken from Identifier Type Codes
(extensible to http://hl7.org/fhir/ValueSet/identifier-type|4.0.1)

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Is Modifier false

Summary true

Requirements

Allows users to make use of identifiers when the identifier system is not known.

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

54. SubstanceSpecification.identifier.system

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Short The namespace for the identifier value

Comments

Identifier.system is always case sensitive.

Control 0..1

Is Modifier false

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

Summary true

Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Example General: http://www.acme.com/identifiers/patient

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

56. SubstanceSpecification.identifier.value

Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Short The value that is unique

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Control 0..1

Is Modifier false

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

Summary true

Example General: 123456

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

58. SubstanceSpecification.identifier.period

Definition

Time period during which identifier is/was valid for use.

Short Time period when id is/was valid for use

Control 0..1

Period

Is Modifier false

Summary true

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

60. SubstanceSpecification.identifier.assigner

Definition

Organization that issued/manages the identifier.

Short Organization that issued id (may be just text)

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Control 0..1

Type Reference(Organization)

Is Modifier false

Summary true

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

62. SubstanceSpecification.type

Definition

High level categorization, e.g. polymer or nucleic acid.

Short High level categorization, e.g. polymer or nucleic acid

Control 0..1

Is Modifier false

Summary true

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

64. SubstanceSpecification.status

Definition

Status of substance within the catalogue e.g. approved.

Short Status of substance within the catalogue e.g. approved

Control 0..1

Is Modifier false

Summary true

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

66. SubstanceSpecification.status.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

68. SubstanceSpecification.status.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

70. SubstanceSpecification.status.extension:status

Slice Name status

Definition

R5: SubstanceDefinition.status

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

Comments

Element SubstanceDefinition.status is mapped to FHIR R4 element SubstanceSpecification.status as Equivalent. An externally-defined extension that has been mapped as the representation of FHIR R5 element SubstanceDefinition.status: http://hl7.org/fhir/StructureDefinition/artifact-status.

Control 0..1

Type Extension(Artifact Status) (Extension Type: code)

Is Modifier false

Summary false

72. SubstanceSpecification.status.coding

Definition

A reference to a code defined by a terminology system.

Short Code defined by a terminology system

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

Control 0..*

Coding

Is Modifier false

Summary true

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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

74. SubstanceSpecification.status.text

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Short Plain text representation of the concept

Comments

Very often the text is the same as a displayName of one of the codings.

Control 0..1

Is Modifier false

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

Summary true

Requirements

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

76. SubstanceSpecification.domain

Definition

If the substance applies to only human or veterinary use.

Short If the substance applies to only human or veterinary use

Control 0..1

Is Modifier false

Summary true

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

78. SubstanceSpecification.description

Definition

Textual description of the substance.

Short Textual description of the substance

Control 0..1

Is Modifier false

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

Summary true

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

80. SubstanceSpecification.description.id

Definition

unique id for the element within a resource (for internal references)

Short xml:id (or equivalent in JSON)

Control 0..1

Is Modifier false

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

Summary false

82. SubstanceSpecification.description.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

84. SubstanceSpecification.description.extension:description

Slice Name description

Definition

R5: SubstanceDefinition.description

Short R5: description

Comments

Element SubstanceDefinition.description is mapped to FHIR R4 element SubstanceSpecification.description as Equivalent. An externally-defined extension that has been mapped as the representation of FHIR R5 element SubstanceDefinition.description: http://hl7.org/fhir/StructureDefinition/artifact-description.

Control 0..1

Type Extension(Artifact Description) (Extension Type: markdown)

Is Modifier false

Summary false

86. SubstanceSpecification.description.value

Definition

The actual value

Short Primitive value for string

Control 0..1

Is Modifier false

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

Summary false

Max Length: 1048576

88. SubstanceSpecification.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Summary true

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

90. SubstanceSpecification.comment

Definition

Textual comment about this record of a substance.

Short Textual comment about this record of a substance

Control 0..1

Is Modifier false

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

Summary true

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

92. SubstanceSpecification.moiety

Definition

Moiety, for structural modifications.

Short Moiety, for structural modifications

Control 0..*

Is Modifier false

Summary true

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

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

96. SubstanceSpecification.moiety.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

98. SubstanceSpecification.moiety.extension:measurementType

Slice Name measurementType

Definition

R5: SubstanceDefinition.moiety.measurementType (new:CodeableConcept)

Short R5: The measurement type of the quantitative value (new)

Comments

Element SubstanceDefinition.moiety.measurementType has a context of SubstanceSpecification.moiety based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.moiety.measurementType has no mapping targets in FHIR R4. 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(R5: The measurement type of the quantitative value (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

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

102. SubstanceSpecification.moiety.role

Definition

Role that the moiety is playing.

Short Role that the moiety is playing

Control 0..1

Is Modifier false

Summary true

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

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

Is Modifier false

Summary true

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

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

Summary true

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

108. SubstanceSpecification.moiety.stereochemistry

Definition

Stereochemistry type.

Short Stereochemistry type

Control 0..1

Is Modifier false

Summary true

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

110. SubstanceSpecification.moiety.opticalActivity

Definition

Optical activity type.

Short Optical activity type

Control 0..1

Is Modifier false

Summary true

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

112. SubstanceSpecification.moiety.molecularFormula

Definition

Molecular formula.

Short Molecular formula

Control 0..1

Is Modifier false

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

Summary true

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

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

Summary true

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

116. SubstanceSpecification.property

Definition

General specifications for this substance, including how it is related to other substances.

Short General specifications for this substance, including how it is related to other substances

Control 0..*

Is Modifier false

Summary true

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

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

120. SubstanceSpecification.property.extension

Definition

An Extension

Short Extension

Control 1..*

Is Modifier false

Summary false

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

value @ url

122. SubstanceSpecification.property.extension:type

Slice Name type

Definition

R5: SubstanceDefinition.property.type (new:CodeableConcept)

Short R5: A code expressing the type of property (new)

Comments

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

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

Type Extension(R5: A code expressing the type of property (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

124. SubstanceSpecification.property.extension:value

Slice Name value

Definition

R5: SubstanceDefinition.property.value[x] (new:Attachment, boolean, CodeableConcept, date, Quantity)

Short R5: A value for the property (new)

Comments

Element SubstanceDefinition.property.value[x] has a context of SubstanceSpecification.property based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.property.value[x] has no mapping targets in FHIR R4. 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(R5: A value for the property (new)) (Extension Type: Choice of: CodeableConcept, Quantity, date, boolean, Attachment)

Is Modifier false

Summary false

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

128. SubstanceSpecification.property.category

Definition

A category for this property, e.g. Physical, Chemical, Enzymatic.

Short A category for this property, e.g. Physical, Chemical, Enzymatic

Control 0..1

Is Modifier false

Summary true

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

130. SubstanceSpecification.property.code

Definition

Property type e.g. viscosity, pH, isoelectric point.

Short Property type e.g. viscosity, pH, isoelectric point

Control 0..1

Is Modifier false

Summary true

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

132. SubstanceSpecification.property.parameters

Definition

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

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

Control 0..1

Is Modifier false

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

Summary true

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

134. SubstanceSpecification.property.definingSubstance[x]

Definition

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

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

Control 0..1

Type Choice of: Reference(SubstanceSpecification, Substance), CodeableConcept

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

Is Modifier false

Summary true

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

136. SubstanceSpecification.property.amount[x]

Definition

Quantitative value for this property.

Short Quantitative value for this property

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

Summary true

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

138. SubstanceSpecification.referenceInformation

Definition

General information detailing this substance.

Short General information detailing this substance

Control 0..1

Type Reference(SubstanceReferenceInformation)

Is Modifier false

Summary true

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

140. SubstanceSpecification.structure

Definition

Structural information.

Short Structural information

Control 0..1

Is Modifier false

Summary true

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

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

144. SubstanceSpecification.structure.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

146. SubstanceSpecification.structure.extension:technique

Slice Name technique

Definition

R5: SubstanceDefinition.structure.technique (new:CodeableConcept)

Short R5: The method used to find the structure e.g. X-ray, NMR (new)

Comments

Element SubstanceDefinition.structure.technique has a context of SubstanceSpecification.structure based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.structure.technique has no mapping targets in FHIR R4. 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(R5: The method used to find the structure e.g. X-ray, NMR (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

148. SubstanceSpecification.structure.extension:sourceDocument

Slice Name sourceDocument

Definition

R5: SubstanceDefinition.structure.sourceDocument (new:Reference(DocumentReference))

Short R5: Source of information for the structure (new)

Comments

Element SubstanceDefinition.structure.sourceDocument has a context of SubstanceSpecification.structure based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.structure.sourceDocument has no mapping targets in FHIR R4. 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(R5: Source of information for the structure (new)) (Extension Type: Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4, Media))

Is Modifier false

Summary false

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

152. SubstanceSpecification.structure.stereochemistry

Definition

Stereochemistry type.

Short Stereochemistry type

Control 0..1

Is Modifier false

Summary true

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

154. SubstanceSpecification.structure.opticalActivity

Definition

Optical activity type.

Short Optical activity type

Control 0..1

Is Modifier false

Summary true

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

156. SubstanceSpecification.structure.molecularFormula

Definition

Molecular formula.

Short Molecular formula

Control 0..1

Is Modifier false

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

Summary true

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

158. SubstanceSpecification.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, i.e. first C, then H, then alphabetical, each moiety separated by a dot

Control 0..1

Is Modifier false

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

Summary true

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

160. SubstanceSpecification.structure.isotope

Definition

Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio.

Short Applicable for single substances that contain a radionuclide or a non-natural isotopic ratio

Control 0..*

Is Modifier false

Summary true

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

162. SubstanceSpecification.structure.isotope.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

164. SubstanceSpecification.structure.isotope.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

166. SubstanceSpecification.structure.isotope.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. SubstanceSpecification.structure.isotope.identifier

Definition

Substance identifier for each non-natural or radioisotope.

Short Substance identifier for each non-natural or radioisotope

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

Control 0..1

Is Modifier false

Summary true

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

170. SubstanceSpecification.structure.isotope.name

Definition

Substance name for each non-natural or radioisotope.

Short Substance name for each non-natural or radioisotope

Control 0..1

Is Modifier false

Summary true

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

172. SubstanceSpecification.structure.isotope.substitution

Definition

The type of isotopic substitution present in a single substance.

Short The type of isotopic substitution present in a single substance

Control 0..1

Is Modifier false

Summary true

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

174. SubstanceSpecification.structure.isotope.halfLife

Definition

Half life - for a non-natural nuclide.

Short Half life - for a non-natural nuclide

Control 0..1

Quantity

Is Modifier false

Summary true

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

176. SubstanceSpecification.structure.isotope.molecularWeight

Definition

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

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

Control 0..1

Is Modifier false

Summary true

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

178. SubstanceSpecification.structure.isotope.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

180. SubstanceSpecification.structure.isotope.molecularWeight.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

182. SubstanceSpecification.structure.isotope.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

184. SubstanceSpecification.structure.isotope.molecularWeight.method

Definition

The method by which the molecular weight was determined.

Short The method by which the molecular weight was determined

Control 0..1

Is Modifier false

Summary true

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

186. SubstanceSpecification.structure.isotope.molecularWeight.type

Definition

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

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

Control 0..1

Is Modifier false

Summary true

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

188. SubstanceSpecification.structure.isotope.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. 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

Control 0..1

Quantity

Is Modifier false

Summary true

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

190. SubstanceSpecification.structure.molecularWeight

Definition

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

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

Control 0..1

Type Seettp://hl7.org/fhir/StructureDefinition/SubstanceSpecification#SubstanceSpecification.structure.isotope.molecularWeight

Is Modifier false

Summary true

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

192. SubstanceSpecification.structure.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Summary true

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

194. SubstanceSpecification.structure.representation

Definition

Molecular structural representation.

Short Molecular structural representation

Control 0..*

Is Modifier false

Summary true

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

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

198. SubstanceSpecification.structure.representation.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

200. SubstanceSpecification.structure.representation.extension:format

Slice Name format

Definition

R5: SubstanceDefinition.structure.representation.format (new:CodeableConcept)

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

Comments

Element SubstanceDefinition.structure.representation.format has a context of SubstanceSpecification.structure.representation based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.structure.representation.format has no mapping targets in FHIR R4. 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(R5: The format of the representation e.g. InChI, SMILES, MOLFILE (note: not the physical file format) (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

202. SubstanceSpecification.structure.representation.extension:document

Slice Name document

Definition

R5: SubstanceDefinition.structure.representation.document (new:Reference(DocumentReference))

Short R5: An attachment with the structural representation e.g. a structure graphic or AnIML file (new)

Comments

Element SubstanceDefinition.structure.representation.document has a context of SubstanceSpecification.structure.representation based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.structure.representation.document has no mapping targets in FHIR R4. 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(R5: An attachment with the structural representation e.g. a structure graphic or AnIML file (new)) (Extension Type: Reference(Cross-version Profile for R5.DocumentReference for use in FHIR R4, Media))

Is Modifier false

Summary false

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

206. SubstanceSpecification.structure.representation.type

Definition

The type of structure (e.g. Full, Partial, Representative).

Short The type of structure (e.g. Full, Partial, Representative)

Control 0..1

Is Modifier false

Summary true

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

208. SubstanceSpecification.structure.representation.representation

Definition

The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX.

Short The structural representation as text string in a format e.g. InChI, SMILES, MOLFILE, CDX

Control 0..1

Is Modifier false

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

Summary true

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

210. SubstanceSpecification.structure.representation.attachment

Definition

An attached file with the structural representation.

Short An attached file with the structural representation

Control 0..1

Attachment

Is Modifier false

Summary true

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

212. SubstanceSpecification.code

Definition

Codes associated with the substance.

Short Codes associated with the substance

Control 0..*

Is Modifier false

Summary true

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

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

216. SubstanceSpecification.code.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

218. SubstanceSpecification.code.extension:note

Slice Name note

Definition

R5: SubstanceDefinition.code.note (new:Annotation)

Short R5: Any comment can be provided in this field (new)

Comments

Element SubstanceDefinition.code.note has a context of SubstanceSpecification.code based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.code.note has no mapping targets in FHIR R4. 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(R5: Any comment can be provided in this field (new)) (Extension Type: Annotation)

Is Modifier false

Summary false

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

222. SubstanceSpecification.code.code

Definition

The specific code.

Short The specific code

Control 0..1

Is Modifier false

Summary true

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

224. SubstanceSpecification.code.status

Definition

Status of the code assignment.

Short Status of the code assignment

Control 0..1

Is Modifier false

Summary true

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

226. SubstanceSpecification.code.statusDate

Definition

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

Short The date at which the code status is changed as part of the terminology maintenance

Control 0..1

dateTime

Is Modifier false

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

Summary true

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

228. SubstanceSpecification.code.comment

Definition

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

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

Control 0..1

Is Modifier false

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

Summary true

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

230. SubstanceSpecification.code.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Summary true

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

232. SubstanceSpecification.code.source.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

234. SubstanceSpecification.code.source.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

236. SubstanceSpecification.code.source.extension:source

Slice Name source

Definition

R5: SubstanceDefinition.code.source additional types from child elements (display, identifier, reference, type)

Short R5: source additional types

Comments

Element SubstanceDefinition.code.source is mapped to FHIR R4 element SubstanceSpecification.code.source as SourceIsBroaderThanTarget. The mappings for SubstanceDefinition.code.source do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element SubstanceDefinition.code.source with unmapped reference targets: DocumentReference.

Control 0..1

Type Extension(Alternate Reference) (Extension Type: Reference(Resource))

Is Modifier false

Summary false

238. SubstanceSpecification.code.source.reference

Definition

A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

Short Literal reference, Relative, internal or absolute URL

Comments

Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

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

Is Modifier false

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

Summary true

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

240. SubstanceSpecification.code.source.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).

Short Type the reference refers to (e.g. "Patient")

Comments

This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.

Control 0..1

Unless not suitable, these codes SHALL be taken from ResourceType

(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Is Modifier false

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

Summary true

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

242. SubstanceSpecification.code.source.identifier

Definition

An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

Short Logical reference, when literal reference is not known

Comments

When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).

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

Control 0..1

Is Modifier false

Summary true

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

244. SubstanceSpecification.code.source.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

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

Summary true

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

246. SubstanceSpecification.name

Definition

Names applicable to this substance.

Short Names applicable to this substance

Control 0..*

Is Modifier false

Summary true

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

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

250. SubstanceSpecification.name.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

252. SubstanceSpecification.name.extension:name

Slice Name name

Definition

R5: SubstanceDefinition.name

Short R5: name

Comments

Element SubstanceDefinition.name is mapped to FHIR R4 element SubstanceSpecification.name as Equivalent. An externally-defined extension that has been mapped as the representation of FHIR R5 element SubstanceDefinition.name: http://hl7.org/fhir/StructureDefinition/artifact-name.

Control 0..*

Type Extension(ArtifactName) (Extension Type: string)

Is Modifier false

Summary false

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

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

Summary true

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

258. SubstanceSpecification.name.type

Definition

Name type.

Short Name type

Control 0..1

Is Modifier false

Summary true

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

260. SubstanceSpecification.name.status

Definition

The status of the name.

Short The status of the name

Control 0..1

Is Modifier false

Summary true

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

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

Summary true

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

264. SubstanceSpecification.name.language

Definition

Language of the name.

Short Language of the name

Control 0..*

Is Modifier false

Summary true

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

266. SubstanceSpecification.name.language.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

268. SubstanceSpecification.name.language.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

270. SubstanceSpecification.name.language.extension:language

Slice Name language

Definition

R5: SubstanceDefinition.name.language

Short R5: Human language that the name is written in

Comments

Element SubstanceDefinition.name.language is mapped to FHIR R4 element SubstanceSpecification.name.language as Equivalent.

Control 0..*

Type Extension(R5: Human language that the name is written in) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

272. SubstanceSpecification.name.language.coding

Definition

A reference to a code defined by a terminology system.

Short Code defined by a terminology system

Comments

Control 0..*

Coding

Is Modifier false

Summary true

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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

274. SubstanceSpecification.name.language.text

Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

Short Plain text representation of the concept

Comments

Very often the text is the same as a displayName of one of the codings.

Control 0..1

Is Modifier false

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

Summary true

Requirements

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

276. SubstanceSpecification.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 for example if there is a different name a drug active ingredient as opposed to a food colour additive

Control 0..*

Is Modifier false

Summary true

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

278. SubstanceSpecification.name.jurisdiction

Definition

The jurisdiction where this name applies.

Short The jurisdiction where this name applies

Control 0..*

Is Modifier false

Summary true

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

280. SubstanceSpecification.name.synonym

Definition

A synonym of this name.

Short A synonym of this name

Control 0..*

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

Is Modifier false

Summary true

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

282. SubstanceSpecification.name.translation

Definition

A translation for this name.

Short A translation for this name

Control 0..*

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

Is Modifier false

Summary true

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

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

Summary true

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

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

288. SubstanceSpecification.name.official.extension

Definition

Short Additional content defined by implementations

Comments

Control 0..*

Is Modifier false

Summary false

Alternate Names extensions, user content

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

292. SubstanceSpecification.name.official.authority

Definition

Which authority uses this official name.

Short Which authority uses this official name

Control 0..1

Is Modifier false

Summary true

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

294. SubstanceSpecification.name.official.status

Definition

The status of the official name.

Short The status of the official name

Control 0..1

Is Modifier false

Summary true

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

296. SubstanceSpecification.name.official.date

Definition

Date of 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

Summary true

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

298. SubstanceSpecification.name.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Summary true

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

300. SubstanceSpecification.name.source.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

302. SubstanceSpecification.name.source.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

304. SubstanceSpecification.name.source.extension:source

Slice Name source

Definition

R5: SubstanceDefinition.name.source additional types from child elements (display, identifier, reference, type)

Short R5: source additional types

Comments

Element SubstanceDefinition.name.source is mapped to FHIR R4 element SubstanceSpecification.name.source as SourceIsBroaderThanTarget. The mappings for SubstanceDefinition.name.source do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element SubstanceDefinition.name.source with unmapped reference targets: DocumentReference.

Control 0..1

Type Extension(Alternate Reference) (Extension Type: Reference(Resource))

Is Modifier false

Summary false

306. SubstanceSpecification.name.source.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

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

Is Modifier false

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

Summary true

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

308. SubstanceSpecification.name.source.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from ResourceType

(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Is Modifier false

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

Summary true

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

310. SubstanceSpecification.name.source.identifier

Definition

Short Logical reference, when literal reference is not known

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

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

Control 0..1

Is Modifier false

Summary true

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

312. SubstanceSpecification.name.source.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

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

Summary true

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

314. SubstanceSpecification.molecularWeight

Definition

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

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

Control 0..*

Is Modifier false

Summary true

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

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

318. SubstanceSpecification.molecularWeight.extension

Definition

An Extension

Short Extension

Control 1..*

Is Modifier false

Summary false

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

value @ url

320. SubstanceSpecification.molecularWeight.extension:method

Slice Name method

Definition

R5: SubstanceDefinition.molecularWeight.method (new:CodeableConcept)

Short R5: The method by which the weight was determined (new)

Comments

Element SubstanceDefinition.molecularWeight.method has a context of SubstanceSpecification.molecularWeight based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.molecularWeight.method has no mapping targets in FHIR R4. 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(R5: The method by which the weight was determined (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

322. SubstanceSpecification.molecularWeight.extension:type

Slice Name type

Definition

R5: SubstanceDefinition.molecularWeight.type (new:CodeableConcept)

Short R5: Type of molecular weight e.g. exact, average, weight average (new)

Comments

Element SubstanceDefinition.molecularWeight.type has a context of SubstanceSpecification.molecularWeight based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.molecularWeight.type has no mapping targets in FHIR R4. 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(R5: Type of molecular weight e.g. exact, average, weight average (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

324. SubstanceSpecification.molecularWeight.extension:amount

Slice Name amount

Definition

R5: SubstanceDefinition.molecularWeight.amount (new:Quantity)

Short R5: Used to capture quantitative values for a variety of elements (new)

Comments

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

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

Type Extension(R5: Used to capture quantitative values for a variety of elements (new)) (Extension Type: Quantity)

Is Modifier false

Summary false

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

328. SubstanceSpecification.molecularWeight.method

Definition

The method by which the molecular weight was determined.

Short The method by which the molecular weight was determined

Control 0..1

Is Modifier false

Summary true

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

330. SubstanceSpecification.molecularWeight.type

Definition

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

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

Control 0..1

Is Modifier false

Summary true

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

332. SubstanceSpecification.molecularWeight.amount

Definition

Control 0..1

Quantity

Is Modifier false

Summary true

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

334. SubstanceSpecification.relationship

Definition

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

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

Control 0..*

Is Modifier false

Summary true

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

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

338. SubstanceSpecification.relationship.extension

Definition

An Extension

Short Extension

Control 1..*

Is Modifier false

Summary false

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

value @ url

340. SubstanceSpecification.relationship.extension:substanceDefinition

Slice Name substanceDefinition

Definition

R5: SubstanceDefinition.relationship.substanceDefinition[x] (new:CodeableConcept, Reference(SubstanceDefinition))

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

Comments

Element SubstanceDefinition.relationship.substanceDefinition[x] has a context of SubstanceSpecification.relationship based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.relationship.substanceDefinition[x] has no mapping targets in FHIR R4. 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(R5: A pointer to another substance, as a resource or a representational code (new)) (Extension Type: Choice of: Reference(Cross-version Profile for R5.SubstanceDefinition for use in FHIR R4, SubstanceSpecification), CodeableConcept)

Is Modifier false

Summary false

342. SubstanceSpecification.relationship.extension:type

Slice Name type

Definition

R5: SubstanceDefinition.relationship.type (new:CodeableConcept)

Short R5: For example "salt to parent", "active moiety" (new)

Comments

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

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

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

Is Modifier false

Summary false

344. SubstanceSpecification.relationship.extension:ratioHighLimitAmount

Slice Name ratioHighLimitAmount

Definition

R5: SubstanceDefinition.relationship.ratioHighLimitAmount (new:Ratio)

Short R5: For use when the numeric has an uncertain range (new)

Comments

Element SubstanceDefinition.relationship.ratioHighLimitAmount has a context of SubstanceSpecification.relationship based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.relationship.ratioHighLimitAmount has no mapping targets in FHIR R4. 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(R5: For use when the numeric has an uncertain range (new)) (Extension Type: Ratio)

Is Modifier false

Summary false

346. SubstanceSpecification.relationship.extension:comparator

Slice Name comparator

Definition

R5: SubstanceDefinition.relationship.comparator (new:CodeableConcept)

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

Comments

Element SubstanceDefinition.relationship.comparator has a context of SubstanceSpecification.relationship based on following the parent source element upwards and mapping to SubstanceSpecification. Element SubstanceDefinition.relationship.comparator has no mapping targets in FHIR R4. 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(R5: An operator for the amount, for example "average", "approximately", "less than" (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

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

350. SubstanceSpecification.relationship.substance[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 just a representational code

Control 0..1

Type Choice of: Reference(SubstanceSpecification), CodeableConcept

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

Is Modifier false

Summary true

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

352. SubstanceSpecification.relationship.relationship

Definition

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

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

Control 0..1

Is Modifier false

Summary true

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

354. SubstanceSpecification.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 substance relationships

Control 0..1

boolean

Is Modifier false

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

Summary true

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

356. SubstanceSpecification.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, for instance to express that the salt of a substance has some percentage of the active substance in relation to some other

Control 0..1

Type Choice of: Quantity, Range, 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

Summary true

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

358. SubstanceSpecification.relationship.amountRatioLowLimit

Definition

For use when the numeric.

Short For use when the numeric

Control 0..1

Ratio

Is Modifier false

Summary true

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

360. SubstanceSpecification.relationship.amountType

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

Is Modifier false

Summary true

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

362. SubstanceSpecification.relationship.source

Definition

Supporting literature.

Short Supporting literature

Control 0..*

Type Reference(DocumentReference)

Is Modifier false

Summary true

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

364. SubstanceSpecification.relationship.source.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

366. SubstanceSpecification.relationship.source.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

368. SubstanceSpecification.relationship.source.extension:source

Slice Name source

Definition

R5: SubstanceDefinition.relationship.source additional types from child elements (display, identifier, reference, type)

Short R5: source additional types

Comments

Element SubstanceDefinition.relationship.source is mapped to FHIR R4 element SubstanceSpecification.relationship.source as SourceIsBroaderThanTarget. The mappings for SubstanceDefinition.relationship.source do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R5 element SubstanceDefinition.relationship.source with unmapped reference targets: DocumentReference.

Control 0..1

Type Extension(Alternate Reference) (Extension Type: Reference(Resource))

Is Modifier false

Summary false

370. SubstanceSpecification.relationship.source.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

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

Is Modifier false

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

Summary true

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

372. SubstanceSpecification.relationship.source.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from ResourceType

(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Is Modifier false

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

Summary true

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

374. SubstanceSpecification.relationship.source.identifier

Definition

Short Logical reference, when literal reference is not known

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

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

Control 0..1

Is Modifier false

Summary true

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

376. SubstanceSpecification.relationship.source.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1

Is Modifier false

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

Summary true

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

378. SubstanceSpecification.nucleicAcid

Definition

Data items specific to nucleic acids.

Short Data items specific to nucleic acids

Control 0..1

Type Reference(SubstanceNucleicAcid)

Is Modifier false

Summary true

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

380. SubstanceSpecification.polymer

Definition

Data items specific to polymers.

Short Data items specific to polymers

Control 0..1

Type Reference(SubstancePolymer)

Is Modifier false

Summary true

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

382. SubstanceSpecification.protein

Definition

Data items specific to proteins.

Short Data items specific to proteins

Control 0..1

Type Reference(SubstanceProtein)

Is Modifier false

Summary true

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

384. SubstanceSpecification.sourceMaterial

Definition

Material or taxonomic/anatomical source for the substance.

Short Material or taxonomic/anatomical source for the substance

Control 0..1

Type Reference(SubstanceSourceMaterial)

Is Modifier false

Summary true

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

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

388. SubstanceSpecification.sourceMaterial.extension

Definition

An Extension

Short Extension

Control 0..*

Is Modifier false

Summary false

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

value @ url

390. SubstanceSpecification.sourceMaterial.extension:type

Slice Name type

Definition

R5: SubstanceDefinition.sourceMaterial.type (new:CodeableConcept)

Short R5: Classification of the origin of the raw material. e.g. cat hair is an Animal source type (new)

Comments

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

Control 0..1

Type Extension(R5: Classification of the origin of the raw material. e.g. cat hair is an Animal source type (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

392. SubstanceSpecification.sourceMaterial.extension:genus

Slice Name genus

Definition

R5: SubstanceDefinition.sourceMaterial.genus (new:CodeableConcept)

Short R5: The genus of an organism e.g. the Latin epithet of the plant/animal scientific name (new)

Comments

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

Control 0..1

Type Extension(R5: The genus of an organism e.g. the Latin epithet of the plant/animal scientific name (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

394. SubstanceSpecification.sourceMaterial.extension:species

Slice Name species

Definition

R5: SubstanceDefinition.sourceMaterial.species (new:CodeableConcept)

Short R5: The species of an organism e.g. the Latin epithet of the species of the plant/animal (new)

Comments

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

Control 0..1

Type Extension(R5: The species of an organism e.g. the Latin epithet of the species of the plant/animal (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

396. SubstanceSpecification.sourceMaterial.extension:part

Slice Name part

Definition

R5: SubstanceDefinition.sourceMaterial.part (new:CodeableConcept)

Short R5: An anatomical origin of the source material within an organism (new)

Comments

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

Control 0..1

Type Extension(R5: An anatomical origin of the source material within an organism (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

398. SubstanceSpecification.sourceMaterial.extension:countryOfOrigin

Slice Name countryOfOrigin

Definition

R5: SubstanceDefinition.sourceMaterial.countryOfOrigin (new:CodeableConcept)

Short R5: The country or countries where the material is harvested (new)

Comments

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

Control 0..*

Type Extension(R5: The country or countries where the material is harvested (new)) (Extension Type: CodeableConcept)

Is Modifier false

Summary false

400. SubstanceSpecification.sourceMaterial.reference

Definition

Short Literal reference, Relative, internal or absolute URL

Comments

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

Is Modifier false

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

Summary true

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

402. SubstanceSpecification.sourceMaterial.type

Definition

The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent.

Short Type the reference refers to (e.g. "Patient")

Comments

Control 0..1

Unless not suitable, these codes SHALL be taken from ResourceType

(extensible to http://hl7.org/fhir/ValueSet/resource-types|4.0.1)

Aa resource (or, for logical models, the URI of the logical model).

Is Modifier false

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

Summary true

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

404. SubstanceSpecification.sourceMaterial.identifier

Definition

Short Logical reference, when literal reference is not known

Comments

Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

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

Control 0..1

Is Modifier false

Summary true

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

406. SubstanceSpecification.sourceMaterial.display

Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Short Text alternative for the resource

Comments

This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

Control 0..1