Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions

Extension: ExtensionClinicalUseDefinition_Interaction

Official URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-ClinicalUseDefinition.interaction Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: ExtensionClinicalUseDefinition_Interaction

R5: ClinicalUseDefinition.interaction (new:BackboneElement)

This extension is part of the cross-version definitions generated to enable use of the element ClinicalUseDefinition.interaction as defined in FHIR R5 in FHIR R4.

The source element is defined as: ClinicalUseDefinition.interaction 0..1 BackboneElement

Across FHIR versions, the element set has been mapped as:

  • R5: ClinicalUseDefinition.interaction 0..1 BackboneElement

Following are the generation technical comments: Element ClinicalUseDefinition.interaction is not mapped to FHIR R4, since FHIR R5 ClinicalUseDefinition is not mapped. Element ClinicalUseDefinition.interaction has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

Context of Use

    This extension may be used on the following element(s)

    This extension is allowed for use with FHIR versions R4 to R4 .

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) R5: Specifics for when this is an interaction (new)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:interactant 0..* Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 1..1 Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
....... url 1..1 uri "item"
....... value[x] 1..1 The specific medication, product, food etc. or laboratory test that interacts
........ valueReference Reference(Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR R4(0.1.0) | MedicinalProduct | Cross-version Profile for R5.Medication for use in FHIR R4(0.1.0) | Medication | Cross-version Profile for R5.Substance for use in FHIR R4(0.1.0) | Substance | Cross-version Profile for R5.NutritionProduct for use in FHIR R4(0.1.0) | Basic | Cross-version Profile for R5.BiologicallyDerivedProduct for use in FHIR R4(0.1.0) | BiologicallyDerivedProduct | Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition)
........ valueCodeableConcept CodeableConcept
..... url 1..1 uri "interactant"
..... value[x] 0..0 Value of extension
.... extension:type 0..1 Extension R5: The type of the interaction e.g. drug-drug interaction, drug-lab test interaction (new)
..... url 1..1 uri "type"
..... value[x] 0..1 CodeableConcept The type of the interaction e.g. drug-drug interaction, drug-lab test interaction
Binding: R5InteractionTypeForR4 (0.1.0) (example): A categorisation for an interaction between two substances.
.... extension:effect 0..1 Extension R5: The effect of the interaction, for example "reduced gastric absorption of primary medication" (new)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
...... extension:concept 0..1 Extension R5: Reference to a concept (by class)
....... url 1..1 uri "concept"
....... value[x] 0..1 CodeableConcept Reference to a concept (by class)
...... extension:reference 0..1 Extension R5: Reference to a resource (by instance)
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) Reference to a resource (by instance)
..... url 1..1 uri "effect"
..... value[x] 0..0 Value of extension
.... extension:incidence 0..1 Extension R5: The incidence of the interaction, e.g. theoretical, observed (new)
..... url 1..1 uri "incidence"
..... value[x] 0..1 CodeableConcept The incidence of the interaction, e.g. theoretical, observed
Binding: R5InteractionIncidenceForR4 (0.1.0) (example): A categorisation for incidence of occurence of an interaction.
.... extension:management 0..* Extension R5: Actions for managing the interaction (new)
..... url 1..1 uri "management"
..... value[x] 0..1 CodeableConcept Actions for managing the interaction
... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-ClinicalUseDefinition.interaction"
... value[x] 0..0 Value of extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) R5: Specifics for when this is an interaction (new)
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:interactant 0..* Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:item 1..1 Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "item"
....... value[x] 1..1 The specific medication, product, food etc. or laboratory test that interacts
........ valueReference Reference(Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR R4(0.1.0) | MedicinalProduct | Cross-version Profile for R5.Medication for use in FHIR R4(0.1.0) | Medication | Cross-version Profile for R5.Substance for use in FHIR R4(0.1.0) | Substance | Cross-version Profile for R5.NutritionProduct for use in FHIR R4(0.1.0) | Basic | Cross-version Profile for R5.BiologicallyDerivedProduct for use in FHIR R4(0.1.0) | BiologicallyDerivedProduct | Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition)
........ valueCodeableConcept CodeableConcept
..... url 1..1 uri "interactant"
.... extension:type 0..1 Extension R5: The type of the interaction e.g. drug-drug interaction, drug-lab test interaction (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "type"
..... value[x] 0..1 CodeableConcept The type of the interaction e.g. drug-drug interaction, drug-lab test interaction
Binding: R5InteractionTypeForR4 (0.1.0) (example): A categorisation for an interaction between two substances.
.... extension:effect 0..1 Extension R5: The effect of the interaction, for example "reduced gastric absorption of primary medication" (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
...... extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "concept"
....... value[x] 0..1 CodeableConcept Reference to a concept (by class)
...... extension:reference 0..1 Extension R5: Reference to a resource (by instance)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) Reference to a resource (by instance)
..... url 1..1 uri "effect"
.... extension:incidence 0..1 Extension R5: The incidence of the interaction, e.g. theoretical, observed (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "incidence"
..... value[x] 0..1 CodeableConcept The incidence of the interaction, e.g. theoretical, observed
Binding: R5InteractionIncidenceForR4 (0.1.0) (example): A categorisation for incidence of occurence of an interaction.
.... extension:management 0..* Extension R5: Actions for managing the interaction (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "management"
..... value[x] 0..1 CodeableConcept Actions for managing the interaction
... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-ClinicalUseDefinition.interaction"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: R5: ClinicalUseDefinition.interaction (new:BackboneElement)

  • item: Reference, CodeableConcept: R5: ClinicalUseDefinition.interaction.interactant.item[x] (new:CodeableConcept, Reference(MedicinalProductDefinition,Medication,Substance,NutritionProduct,BiologicallyDerivedProduct,ObservationDefinition))
  • type: CodeableConcept: R5: ClinicalUseDefinition.interaction.type (new:CodeableConcept)
  • _datatype: string: Slice to indicate the presence of a R5 CodeableReference in FHIR R4
  • concept: CodeableConcept: R5: CodeableReference.concept
  • reference: Reference: R5: CodeableReference.reference
  • incidence: CodeableConcept: R5: ClinicalUseDefinition.interaction.incidence (new:CodeableConcept)
  • management: CodeableConcept: R5: ClinicalUseDefinition.interaction.management (new:CodeableConcept)

Maturity: 0

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) R5: Specifics for when this is an interaction (new)
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:interactant 0..* Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:item 1..1 Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
....... url 1..1 uri "item"
....... value[x] 1..1 The specific medication, product, food etc. or laboratory test that interacts
........ valueReference Reference(Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR R4(0.1.0) | MedicinalProduct | Cross-version Profile for R5.Medication for use in FHIR R4(0.1.0) | Medication | Cross-version Profile for R5.Substance for use in FHIR R4(0.1.0) | Substance | Cross-version Profile for R5.NutritionProduct for use in FHIR R4(0.1.0) | Basic | Cross-version Profile for R5.BiologicallyDerivedProduct for use in FHIR R4(0.1.0) | BiologicallyDerivedProduct | Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition)
........ valueCodeableConcept CodeableConcept
..... url 1..1 uri "interactant"
..... value[x] 0..0 Value of extension
.... extension:type 0..1 Extension R5: The type of the interaction e.g. drug-drug interaction, drug-lab test interaction (new)
..... url 1..1 uri "type"
..... value[x] 0..1 CodeableConcept The type of the interaction e.g. drug-drug interaction, drug-lab test interaction
Binding: R5InteractionTypeForR4 (0.1.0) (example): A categorisation for an interaction between two substances.
.... extension:effect 0..1 Extension R5: The effect of the interaction, for example "reduced gastric absorption of primary medication" (new)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
...... extension:concept 0..1 Extension R5: Reference to a concept (by class)
....... url 1..1 uri "concept"
....... value[x] 0..1 CodeableConcept Reference to a concept (by class)
...... extension:reference 0..1 Extension R5: Reference to a resource (by instance)
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) Reference to a resource (by instance)
..... url 1..1 uri "effect"
..... value[x] 0..0 Value of extension
.... extension:incidence 0..1 Extension R5: The incidence of the interaction, e.g. theoretical, observed (new)
..... url 1..1 uri "incidence"
..... value[x] 0..1 CodeableConcept The incidence of the interaction, e.g. theoretical, observed
Binding: R5InteractionIncidenceForR4 (0.1.0) (example): A categorisation for incidence of occurence of an interaction.
.... extension:management 0..* Extension R5: Actions for managing the interaction (new)
..... url 1..1 uri "management"
..... value[x] 0..1 CodeableConcept Actions for managing the interaction
... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-ClinicalUseDefinition.interaction"
... value[x] 0..0 Value of extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..1 Extension(4.0.1) R5: Specifics for when this is an interaction (new)
Constraints: ext-1
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:interactant 0..* Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:item 1..1 Extension R5: The specific medication, product, food etc. or laboratory test that interacts (new)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "item"
....... value[x] 1..1 The specific medication, product, food etc. or laboratory test that interacts
........ valueReference Reference(Cross-version Profile for R5.MedicinalProductDefinition for use in FHIR R4(0.1.0) | MedicinalProduct | Cross-version Profile for R5.Medication for use in FHIR R4(0.1.0) | Medication | Cross-version Profile for R5.Substance for use in FHIR R4(0.1.0) | Substance | Cross-version Profile for R5.NutritionProduct for use in FHIR R4(0.1.0) | Basic | Cross-version Profile for R5.BiologicallyDerivedProduct for use in FHIR R4(0.1.0) | BiologicallyDerivedProduct | Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition)
........ valueCodeableConcept CodeableConcept
..... url 1..1 uri "interactant"
.... extension:type 0..1 Extension R5: The type of the interaction e.g. drug-drug interaction, drug-lab test interaction (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "type"
..... value[x] 0..1 CodeableConcept The type of the interaction e.g. drug-drug interaction, drug-lab test interaction
Binding: R5InteractionTypeForR4 (0.1.0) (example): A categorisation for an interaction between two substances.
.... extension:effect 0..1 Extension R5: The effect of the interaction, for example "reduced gastric absorption of primary medication" (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
....... value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
...... extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "concept"
....... value[x] 0..1 CodeableConcept Reference to a concept (by class)
...... extension:reference 0..1 Extension R5: Reference to a resource (by instance)
Constraints: ext-1
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
....... url 1..1 uri "reference"
....... value[x] 0..1 Reference(Cross-version Profile for R5.ObservationDefinition for use in FHIR R4(0.1.0) | ObservationDefinition) Reference to a resource (by instance)
..... url 1..1 uri "effect"
.... extension:incidence 0..1 Extension R5: The incidence of the interaction, e.g. theoretical, observed (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "incidence"
..... value[x] 0..1 CodeableConcept The incidence of the interaction, e.g. theoretical, observed
Binding: R5InteractionIncidenceForR4 (0.1.0) (example): A categorisation for incidence of occurence of an interaction.
.... extension:management 0..* Extension R5: Actions for managing the interaction (new)
Constraints: ext-1
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
..... url 1..1 uri "management"
..... value[x] 0..1 CodeableConcept Actions for managing the interaction
... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-ClinicalUseDefinition.interaction"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: R5: ClinicalUseDefinition.interaction (new:BackboneElement)

  • item: Reference, CodeableConcept: R5: ClinicalUseDefinition.interaction.interactant.item[x] (new:CodeableConcept, Reference(MedicinalProductDefinition,Medication,Substance,NutritionProduct,BiologicallyDerivedProduct,ObservationDefinition))
  • type: CodeableConcept: R5: ClinicalUseDefinition.interaction.type (new:CodeableConcept)
  • _datatype: string: Slice to indicate the presence of a R5 CodeableReference in FHIR R4
  • concept: CodeableConcept: R5: CodeableReference.concept
  • reference: Reference: R5: CodeableReference.reference
  • incidence: CodeableConcept: R5: ClinicalUseDefinition.interaction.incidence (new:CodeableConcept)
  • management: CodeableConcept: R5: ClinicalUseDefinition.interaction.management (new:CodeableConcept)

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path Status Usage ValueSet Version Source
Extension.extension:type.​value[x] Base example Cross-version ValueSet R5.InteractionType for use in FHIR R4 📍0.1.0 This IG
Extension.extension:incidence.​value[x] Base example Cross-version ValueSet R5.InteractionIncidence for use in FHIR R4 📍0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
ele-1 error Extension, Extension.extension, Extension.extension:interactant, Extension.extension:interactant.extension, Extension.extension:interactant.extension:item, Extension.extension:interactant.extension:item.extension, Extension.extension:interactant.extension:item.value[x], Extension.extension:type, Extension.extension:type.extension, Extension.extension:type.value[x], Extension.extension:effect, Extension.extension:effect.extension, Extension.extension:effect.extension:_datatype, Extension.extension:effect.extension:_datatype.extension, Extension.extension:effect.extension:_datatype.value[x], Extension.extension:effect.extension:concept, Extension.extension:effect.extension:concept.extension, Extension.extension:effect.extension:concept.value[x], Extension.extension:effect.extension:reference, Extension.extension:effect.extension:reference.extension, Extension.extension:effect.extension:reference.value[x], Extension.extension:incidence, Extension.extension:incidence.extension, Extension.extension:incidence.value[x], Extension.extension:management, Extension.extension:management.extension, Extension.extension:management.value[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error Extension, Extension.extension, Extension.extension:interactant, Extension.extension:interactant.extension, Extension.extension:interactant.extension:item, Extension.extension:interactant.extension:item.extension, Extension.extension:type, Extension.extension:type.extension, Extension.extension:effect, Extension.extension:effect.extension, Extension.extension:effect.extension:_datatype, Extension.extension:effect.extension:_datatype.extension, Extension.extension:effect.extension:concept, Extension.extension:effect.extension:concept.extension, Extension.extension:effect.extension:reference, Extension.extension:effect.extension:reference.extension, Extension.extension:incidence, Extension.extension:incidence.extension, Extension.extension:management, Extension.extension:management.extension Must have either extensions or value[x], not both extension.exists() != value.exists()