Sparked Logical Models
0.0.1 - CI Build
Australia (AUS)
Sparked Logical Models, published by CSIRO. This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/aehrc/logical-model-web/ and changes regularly. See the Directory of published versions
| Draft as of 2023-09-11 |
Definitions for the AdverseReactionRiskAUCDI logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. AdverseReactionRisk | |
| Definition | A summary or overview of a clinical assessment that identifies the potential for a harmful or undesirable physiological reaction unique to an individual and associated with exposure to a specific substance. |
| Short | Adverse Reaction Risk AUCDI |
| Comments | Purpose To record:
Misuse
Supporting Model(s)
Considerations
|
| Control | 0..* |
| Is Modifier | false |
| Must Support | true |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | reaction, Adverse reaction, Allergy, Intolerance, Hypersensitivity |
| 2. AdverseReactionRisk.Protocol | |
| Definition | @ internal @ |
| Short | Protocol |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. AdverseReactionRisk.Protocol.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 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. AdverseReactionRisk.Protocol.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 | 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| 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()) |
| Slicing | This element introduces a set of slices on AdverseReactionRisk.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. AdverseReactionRisk.Protocol.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 | 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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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, modifiers |
| 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()) |
| 10. AdverseReactionRisk.Protocol.Lastupdated | |
| Definition | The date when this 'Adverse reaction risk summary' data group was last updated. |
| Short | Last updated |
| Comments | Considerations For example: • 7 February 2015 • 7 February 2015, 1:28 pm • 2015-02-07T13:28:17-05:00 |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 12. AdverseReactionRisk.Protocol.Extension | |
| Definition | Additional information required to capture local content or to align with other reference models/formalisms. |
| Short | Extension |
| Comments | Considerations For example: local information requirements or additional metadata to align with FHIR equivalents. |
| Control | 0..1 |
| Type | Reference |
| Must Support | false |
| 14. AdverseReactionRisk.Data | |
| Definition | @ internal @ |
| Short | Data |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. AdverseReactionRisk.Data.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 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| 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()) |
| Slicing | This element introduces a set of slices on AdverseReactionRisk.Data.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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, modifiers |
| 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()) |
| 22. AdverseReactionRisk.Data.Substance | |
| Definition | Identification of a specific substance, compounded product, combination therapy product, or class of substances that is considered to have a causal link to the adverse reaction. |
| Short | Substance name |
| Comments | Considerations In this context, appropriate values for ‘Substance name’ include, but are not limited to:
It is strongly recommended that ‘Substance name’ be coded with a terminology capable of triggering decision support, where possible. Free text entry should only be permitted if no appropriate terminology is available. Example AMT provides concepts at various granularities from brand to specific substance:
Note: The above examples reflect the future state of AMT, v4. Specific substances and non-medicinal substances from SCT-AU:
|
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Agent, Class, Product, Drug, Allergen, Medicine |
| 24. AdverseReactionRisk.Data.Activeinactivestatus | |
| Definition | Status about whether the adverse reaction risk statement is active or inactive. |
| Short | Active/inactive status |
| Control | 0..1 |
| Type | Coding |
| Must Support | false |
| 26. AdverseReactionRisk.Data.Verificationstatus | |
| Definition | Assertion about the certainty of the propensity, or potential future risk, of the identified 'Substance' to cause a reaction. |
| Short | Verification status |
| Comments | Considerations Decision support would typically raise alerts for 'Unconfirmed' and 'Confirmed', and ignore a 'Refuted' reaction. Clinical systems may choose not to display Adverse reaction entries with a 'Refuted' status in the Adverse Reaction List. However, 'Refuted' may be useful for reconciliation of the adverse reaction list or when communicating between systems. Some implementations may choose to make this field mandatory. The free text data type will allow for local variation by enabling other value sets to be applied to this data element in a template - in this situation it is recommended that values should be coded using a terminology. |
| Control | 0..1 |
| Type | Coding |
| Must Support | false |
| 28. AdverseReactionRisk.Data.Criticality | |
| Definition | An indication of the potential for critical system organ damage or life threatening consequence. |
| Short | Criticality |
| Comments | Considerations This can be regarded as a predictive judgement of a 'worst case scenario'. In most contexts 'Low' would be regarded as the default value. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 30. AdverseReactionRisk.Data.Category | |
| Definition | Category of the identified 'Substance'. |
| Short | Category |
| Comments | Considerations This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 32. AdverseReactionRisk.Data.Onsetoflastreaction | |
| Definition | The date and/or time of the onset of the last known occurrence of a reaction event. |
| Short | Onset of last reaction |
| Comments | Considerations For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year. |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 34. AdverseReactionRisk.Data.Onsetoffirstreaction | |
| Definition | The onset of the first known occurrence of a reaction event. |
| Short | Onset of first reaction |
| Comments | Considerations For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year. |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 36. AdverseReactionRisk.Data.Reactionmechanism | |
| Definition | Identification of the underlying physiological mechanism for the adverse reaction. |
| Short | Reaction mechanism |
| Comments | Considerations Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune are actually non-immune and still carry life threatening risk. Immunological testing may provide supporting evidence for the mechanism and causative substance , but no tests are 100% sensitive or specific for a sensitivity. It is acknowledged that most clinicians will NOT be able to distinguish the mechanism of any specific reaction. However this data element is included because many legacy systems have captured this attribute. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 38. AdverseReactionRisk.Data.Reactioneventsummary | |
| Definition | Summary details about each adverse reaction event linked to exposure to the identified 'Substance'. |
| Short | Reaction event summary |
| Control | 0..* |
| Type | Reference(Adverse Reaction Event AUCDI) |
| Must Support | true |
| 40. AdverseReactionRisk.Data.Comment | |
| Definition | Additional narrative about the adverse reaction risk not captured in other fields. |
| Short | Comment |
| Comments | Considerations For example: instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Note |
| 42. AdverseReactionRisk.Data | |
| Definition | @ internal @ |
| Short | Data |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. AdverseReactionRisk.Data.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 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 46. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| 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()) |
| Slicing | This element introduces a set of slices on AdverseReactionRisk.Data.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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, modifiers |
| 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()) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. AdverseReactionRisk | |
| Definition | A summary or overview of a clinical assessment that identifies the potential for a harmful or undesirable physiological reaction unique to an individual and associated with exposure to a specific substance. |
| Short | Adverse Reaction Risk AUCDI |
| Comments | Purpose To record:
Misuse
Supporting Model(s)
Considerations
|
| Control | 0..* |
| Must Support | true |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | Adverse reaction, Allergy, Intolerance, Hypersensitivity |
| 2. AdverseReactionRisk.Data | |
| Definition | @ internal @ |
| Short | Data |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| 4. AdverseReactionRisk.Data.Substance | |
| Definition | Identification of a specific substance, compounded product, combination therapy product, or class of substances that is considered to have a causal link to the adverse reaction. |
| Short | Substance name |
| Comments | Considerations In this context, appropriate values for ‘Substance name’ include, but are not limited to:
It is strongly recommended that ‘Substance name’ be coded with a terminology capable of triggering decision support, where possible. Free text entry should only be permitted if no appropriate terminology is available. Example AMT provides concepts at various granularities from brand to specific substance:
Note: The above examples reflect the future state of AMT, v4. Specific substances and non-medicinal substances from SCT-AU:
|
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Agent, Class, Product, Drug, Allergen, Medicine |
| 6. AdverseReactionRisk.Data.Activeinactivestatus | |
| Definition | Status about whether the adverse reaction risk statement is active or inactive. |
| Short | Active/inactive status |
| Control | 0..1 |
| Type | Coding |
| Must Support | false |
| 8. AdverseReactionRisk.Data.Verificationstatus | |
| Definition | Assertion about the certainty of the propensity, or potential future risk, of the identified 'Substance' to cause a reaction. |
| Short | Verification status |
| Comments | Considerations Decision support would typically raise alerts for 'Unconfirmed' and 'Confirmed', and ignore a 'Refuted' reaction. Clinical systems may choose not to display Adverse reaction entries with a 'Refuted' status in the Adverse Reaction List. However, 'Refuted' may be useful for reconciliation of the adverse reaction list or when communicating between systems. Some implementations may choose to make this field mandatory. The free text data type will allow for local variation by enabling other value sets to be applied to this data element in a template - in this situation it is recommended that values should be coded using a terminology. |
| Control | 0..1 |
| Type | Coding |
| Must Support | false |
| 10. AdverseReactionRisk.Data.Category | |
| Definition | Category of the identified 'Substance'. |
| Short | Category |
| Comments | Considerations This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 12. AdverseReactionRisk.Data.Criticality | |
| Definition | An indication of the potential for critical system organ damage or life threatening consequence. |
| Short | Criticality |
| Comments | Considerations This can be regarded as a predictive judgement of a 'worst case scenario'. In most contexts 'Low' would be regarded as the default value. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 14. AdverseReactionRisk.Data.Onsetoflastreaction | |
| Definition | The date and/or time of the onset of the last known occurrence of a reaction event. |
| Short | Onset of last reaction |
| Comments | Considerations For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year. |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 16. AdverseReactionRisk.Data.Onsetoffirstreaction | |
| Definition | The onset of the first known occurrence of a reaction event. |
| Short | Onset of first reaction |
| Comments | Considerations For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year. |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 18. AdverseReactionRisk.Data.Reactionmechanism | |
| Definition | Identification of the underlying physiological mechanism for the adverse reaction. |
| Short | Reaction mechanism |
| Comments | Considerations Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune are actually non-immune and still carry life threatening risk. Immunological testing may provide supporting evidence for the mechanism and causative substance , but no tests are 100% sensitive or specific for a sensitivity. It is acknowledged that most clinicians will NOT be able to distinguish the mechanism of any specific reaction. However this data element is included because many legacy systems have captured this attribute. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 20. AdverseReactionRisk.Data.Reactioneventsummary | |
| Definition | Summary details about each adverse reaction event linked to exposure to the identified 'Substance'. |
| Short | Reaction event summary |
| Control | 0..* |
| Type | Reference(Adverse Reaction Event AUCDI) |
| Must Support | true |
| 22. AdverseReactionRisk.Data.Comment | |
| Definition | Additional narrative about the adverse reaction risk not captured in other fields. |
| Short | Comment |
| Comments | Considerations For example: instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Note |
| 24. AdverseReactionRisk.Protocol | |
| Definition | @ internal @ |
| Short | Protocol |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| 26. AdverseReactionRisk.Protocol.Lastupdated | |
| Definition | The date when this 'Adverse reaction risk summary' data group was last updated. |
| Short | Last updated |
| Comments | Considerations For example: • 7 February 2015 • 7 February 2015, 1:28 pm • 2015-02-07T13:28:17-05:00 |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 28. AdverseReactionRisk.Protocol.Extension | |
| Definition | Additional information required to capture local content or to align with other reference models/formalisms. |
| Short | Extension |
| Comments | Considerations For example: local information requirements or additional metadata to align with FHIR equivalents. |
| Control | 0..1 |
| Type | Reference |
| Must Support | false |
Guidance on how to interpret the contents of this table can be foundhere
| 0. AdverseReactionRisk | |
| Definition | A summary or overview of a clinical assessment that identifies the potential for a harmful or undesirable physiological reaction unique to an individual and associated with exposure to a specific substance. |
| Short | Adverse Reaction Risk AUCDI |
| Comments | Purpose To record:
Misuse
Supporting Model(s)
Considerations
|
| Control | 0..* |
| Is Modifier | false |
| Must Support | true |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Alternate Names | reaction, Adverse reaction, Allergy, Intolerance, Hypersensitivity |
| 2. AdverseReactionRisk.Protocol | |
| Definition | @ internal @ |
| Short | Protocol |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 4. AdverseReactionRisk.Protocol.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 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 6. AdverseReactionRisk.Protocol.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 | 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| 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()) |
| Slicing | This element introduces a set of slices on AdverseReactionRisk.Protocol.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 8. AdverseReactionRisk.Protocol.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 | 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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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, modifiers |
| 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()) |
| 10. AdverseReactionRisk.Protocol.Lastupdated | |
| Definition | The date when this 'Adverse reaction risk summary' data group was last updated. |
| Short | Last updated |
| Comments | Considerations For example: • 7 February 2015 • 7 February 2015, 1:28 pm • 2015-02-07T13:28:17-05:00 |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| 12. AdverseReactionRisk.Protocol.Extension | |
| Definition | Additional information required to capture local content or to align with other reference models/formalisms. |
| Short | Extension |
| Comments | Considerations For example: local information requirements or additional metadata to align with FHIR equivalents. |
| Control | 0..1 |
| Type | Reference |
| Must Support | false |
| 14. AdverseReactionRisk.Data | |
| Definition | @ internal @ |
| Short | Data |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | true |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 16. AdverseReactionRisk.Data.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 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 18. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| 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()) |
| Slicing | This element introduces a set of slices on AdverseReactionRisk.Data.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 20. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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, modifiers |
| 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()) |
| 22. AdverseReactionRisk.Data.Substance | |
| Definition | Identification of a specific substance, compounded product, combination therapy product, or class of substances that is considered to have a causal link to the adverse reaction. |
| Short | Substance name |
| Comments | Considerations In this context, appropriate values for ‘Substance name’ include, but are not limited to:
It is strongly recommended that ‘Substance name’ be coded with a terminology capable of triggering decision support, where possible. Free text entry should only be permitted if no appropriate terminology is available. Example AMT provides concepts at various granularities from brand to specific substance:
Note: The above examples reflect the future state of AMT, v4. Specific substances and non-medicinal substances from SCT-AU:
|
| Control | 1..1 |
| Type | CodeableConcept |
| Must Support | true |
| Alternate Names | Agent, Class, Product, Drug, Allergen, Medicine |
| 24. AdverseReactionRisk.Data.Activeinactivestatus | |
| Definition | Status about whether the adverse reaction risk statement is active or inactive. |
| Short | Active/inactive status |
| Control | 0..1 |
| Type | Coding |
| Must Support | false |
| 26. AdverseReactionRisk.Data.Verificationstatus | |
| Definition | Assertion about the certainty of the propensity, or potential future risk, of the identified 'Substance' to cause a reaction. |
| Short | Verification status |
| Comments | Considerations Decision support would typically raise alerts for 'Unconfirmed' and 'Confirmed', and ignore a 'Refuted' reaction. Clinical systems may choose not to display Adverse reaction entries with a 'Refuted' status in the Adverse Reaction List. However, 'Refuted' may be useful for reconciliation of the adverse reaction list or when communicating between systems. Some implementations may choose to make this field mandatory. The free text data type will allow for local variation by enabling other value sets to be applied to this data element in a template - in this situation it is recommended that values should be coded using a terminology. |
| Control | 0..1 |
| Type | Coding |
| Must Support | false |
| 28. AdverseReactionRisk.Data.Criticality | |
| Definition | An indication of the potential for critical system organ damage or life threatening consequence. |
| Short | Criticality |
| Comments | Considerations This can be regarded as a predictive judgement of a 'worst case scenario'. In most contexts 'Low' would be regarded as the default value. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 30. AdverseReactionRisk.Data.Category | |
| Definition | Category of the identified 'Substance'. |
| Short | Category |
| Comments | Considerations This data element has been included because it is currently being captured in some clinical systems. This data can be derived from the Substance where coding systems are used, and is effectively redundant in that situation. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 32. AdverseReactionRisk.Data.Onsetoflastreaction | |
| Definition | The date and/or time of the onset of the last known occurrence of a reaction event. |
| Short | Onset of last reaction |
| Comments | Considerations For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year. |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 34. AdverseReactionRisk.Data.Onsetoffirstreaction | |
| Definition | The onset of the first known occurrence of a reaction event. |
| Short | Onset of first reaction |
| Comments | Considerations For example: the actual date and/or time of onset; the interval of time during which the onset occurred; the age of the individual at the time of the onset; or the duration of time since the onset occurred. A partial date is valid, using the DV_DATE_TIME data type, to record only a year. |
| Control | 0..1 |
| Type | Choice of: dateTime, string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | false |
| 36. AdverseReactionRisk.Data.Reactionmechanism | |
| Definition | Identification of the underlying physiological mechanism for the adverse reaction. |
| Short | Reaction mechanism |
| Comments | Considerations Immune-mediated responses have been traditionally regarded as an indicator for escalation of significant future risk. Contemporary knowledge suggests that some reactions previously thought to be immune are actually non-immune and still carry life threatening risk. Immunological testing may provide supporting evidence for the mechanism and causative substance , but no tests are 100% sensitive or specific for a sensitivity. It is acknowledged that most clinicians will NOT be able to distinguish the mechanism of any specific reaction. However this data element is included because many legacy systems have captured this attribute. |
| Control | 0..1 |
| Type | CodeableConcept |
| Must Support | false |
| 38. AdverseReactionRisk.Data.Reactioneventsummary | |
| Definition | Summary details about each adverse reaction event linked to exposure to the identified 'Substance'. |
| Short | Reaction event summary |
| Control | 0..* |
| Type | Reference(Adverse Reaction Event AUCDI) |
| Must Support | true |
| 40. AdverseReactionRisk.Data.Comment | |
| Definition | Additional narrative about the adverse reaction risk not captured in other fields. |
| Short | Comment |
| Comments | Considerations For example: instructions related to future exposure or administration of the Substance, such as administration within an Intensive Care Unit or under corticosteroid cover. |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Must Support | true |
| Alternate Names | Note |
| 42. AdverseReactionRisk.Data | |
| Definition | @ internal @ |
| Short | Data |
| Control | 0..1 |
| Type | BackboneElement |
| Must Support | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 44. AdverseReactionRisk.Data.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 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 46. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| 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()) |
| Slicing | This element introduces a set of slices on AdverseReactionRisk.Data.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 48. AdverseReactionRisk.Data.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 | 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..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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, modifiers |
| 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()) |