Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-AdverseEvent resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. AdverseEvent | |
| Definition | Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death. |
| Short | Medical care, research study or other healthcare event causing physical injury |
| Control | 0..* |
| Alternate Names | AE |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) |
| 2. AdverseEvent.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. |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. AdverseEvent.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. In order 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. |
| Short | ExtensionAdditional 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 |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on AdverseEvent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. AdverseEvent.extension:encounter | |
| Slice Name | encounter |
| Definition | R5: |
| Short | R5: The Encounter associated with the start of the AdverseEvent (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: The Encounter associated with the start of the AdverseEvent (new)) (Extension Type: Reference(Cross-version Profile for R5.Encounter for use in FHIR STU3, Encounter)) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. AdverseEvent.extension:occurrence | |
| Slice Name | occurrence |
| Definition | R5: |
| Short | R5: When the event occurred additional types |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: When the event occurred additional types) (Extension Type: Choice of: Period, Timing) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 10. AdverseEvent.extension:detected | |
| Slice Name | detected |
| Definition | R5: |
| Short | R5: When the event was detected (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: When the event was detected (new)) (Extension Type: dateTime) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 12. AdverseEvent.extension:recordedDate | |
| Slice Name | recordedDate |
| Definition | R5: |
| Short | R5: When the event was recorded (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: When the event was recorded (new)) (Extension Type: dateTime) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 14. AdverseEvent.extension:participant | |
| Slice Name | participant |
| Definition | R5: |
| Short | R5: Who was involved in the adverse event or the potential adverse event and what they did (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Who was involved in the adverse event or the potential adverse event and what they did (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 16. AdverseEvent.extension:expectedInResearchStudy | |
| Slice Name | expectedInResearchStudy |
| Definition | R5: |
| Short | R5: Considered likely or probable or anticipated in the research study (new) |
| Comments | Element |
| Control | 0..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Considered likely or probable or anticipated in the research study (new)) (Extension Type: boolean) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 18. AdverseEvent.extension:contributingFactor | |
| Slice Name | contributingFactor |
| Definition | R5: |
| Short | R5: Contributing factors suspected to have increased the probability or severity of the adverse event (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Contributing factors suspected to have increased the probability or severity of the adverse event (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 20. AdverseEvent.extension:preventiveAction | |
| Slice Name | preventiveAction |
| Definition | R5: |
| Short | R5: Preventive actions that contributed to avoiding the adverse event (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Preventive actions that contributed to avoiding the adverse event (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 22. AdverseEvent.extension:mitigatingAction | |
| Slice Name | mitigatingAction |
| Definition | R5: |
| Short | R5: Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 24. AdverseEvent.extension:supportingInfo | |
| Slice Name | supportingInfo |
| Definition | R5: |
| Short | R5: Supporting information relevant to the event (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Supporting information relevant to the event (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 26. AdverseEvent.extension:note | |
| Slice Name | note |
| Definition | R5: |
| Short | R5: Comment on adverse event (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: Comment on adverse event (new)) (Extension Type: Annotation) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 28. AdverseEvent.modifierExtension | |
| Definition | An Extension 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. Usually modifier elements provide negation or qualification. In order 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. |
| Short | ExtensionExtensions 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..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on AdverseEvent.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 30. AdverseEvent.modifierExtension:status | |
| Slice Name | status |
| Definition | R5: |
| Short | R5: in-progress | completed | entered-in-error | unknown (new) |
| Comments | Element |
| Control | 1..1 This element is affected by the following invariants: ele-1 |
| Type | Extension(R5: in-progress | completed | entered-in-error | unknown (new)) (Extension Type: code) |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (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. AdverseEvent | |
| 2. AdverseEvent.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. AdverseEvent.extension:encounter | |
| Slice Name | encounter |
| Definition | R5: |
| Short | R5: The Encounter associated with the start of the AdverseEvent (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: The Encounter associated with the start of the AdverseEvent (new)) (Extension Type: Reference(Cross-version Profile for R5.Encounter for use in FHIR STU3, Encounter)) |
| 6. AdverseEvent.extension:occurrence | |
| Slice Name | occurrence |
| Definition | R5: |
| Short | R5: When the event occurred additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: When the event occurred additional types) (Extension Type: Choice of: Period, Timing) |
| 8. AdverseEvent.extension:detected | |
| Slice Name | detected |
| Definition | R5: |
| Short | R5: When the event was detected (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: When the event was detected (new)) (Extension Type: dateTime) |
| 10. AdverseEvent.extension:recordedDate | |
| Slice Name | recordedDate |
| Definition | R5: |
| Short | R5: When the event was recorded (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: When the event was recorded (new)) (Extension Type: dateTime) |
| 12. AdverseEvent.extension:participant | |
| Slice Name | participant |
| Definition | R5: |
| Short | R5: Who was involved in the adverse event or the potential adverse event and what they did (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Who was involved in the adverse event or the potential adverse event and what they did (new)) (Complex Extension) |
| 14. AdverseEvent.extension:expectedInResearchStudy | |
| Slice Name | expectedInResearchStudy |
| Definition | R5: |
| Short | R5: Considered likely or probable or anticipated in the research study (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Considered likely or probable or anticipated in the research study (new)) (Extension Type: boolean) |
| 16. AdverseEvent.extension:contributingFactor | |
| Slice Name | contributingFactor |
| Definition | R5: |
| Short | R5: Contributing factors suspected to have increased the probability or severity of the adverse event (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Contributing factors suspected to have increased the probability or severity of the adverse event (new)) (Complex Extension) |
| 18. AdverseEvent.extension:preventiveAction | |
| Slice Name | preventiveAction |
| Definition | R5: |
| Short | R5: Preventive actions that contributed to avoiding the adverse event (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Preventive actions that contributed to avoiding the adverse event (new)) (Complex Extension) |
| 20. AdverseEvent.extension:mitigatingAction | |
| Slice Name | mitigatingAction |
| Definition | R5: |
| Short | R5: Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm (new)) (Complex Extension) |
| 22. AdverseEvent.extension:supportingInfo | |
| Slice Name | supportingInfo |
| Definition | R5: |
| Short | R5: Supporting information relevant to the event (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Supporting information relevant to the event (new)) (Complex Extension) |
| 24. AdverseEvent.extension:note | |
| Slice Name | note |
| Definition | R5: |
| Short | R5: Comment on adverse event (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: Comment on adverse event (new)) (Extension Type: Annotation) |
| 26. AdverseEvent.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. AdverseEvent.modifierExtension:status | |
| Slice Name | status |
| Definition | R5: |
| Short | R5: in-progress | completed | entered-in-error | unknown (new) |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R5: in-progress | completed | entered-in-error | unknown (new)) (Extension Type: code) |
| 30. AdverseEvent.category | |
| 32. AdverseEvent.category.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 34. AdverseEvent.category.extension:category | |
| Slice Name | category |
| Definition | R5: |
| Short | R5: wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R5: wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site additional types) (Extension Type: CodeableConcept) |
| 36. AdverseEvent.type | |
| 38. AdverseEvent.type.modifierExtension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.type.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 40. AdverseEvent.type.modifierExtension:actuality | |
| Slice Name | actuality |
| Definition | R5: |
| Short | R5: actuality |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(R5: actuality) (Extension Type: code) |
| 42. AdverseEvent.subject | |
| 44. AdverseEvent.subject.extension | |
| Control | 1..* |
| Slicing | This element introduces a set of slices on AdverseEvent.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 46. AdverseEvent.subject.extension:subject | |
| Slice Name | subject |
| Definition | R5: |
| Short | R5: Subject impacted by event |
| Comments | Element |
| Control | 1..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 48. AdverseEvent.reaction | |
| 50. AdverseEvent.reaction.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.reaction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 52. AdverseEvent.reaction.extension:resultingEffect | |
| Slice Name | resultingEffect |
| Definition | R5: |
| Short | R5: Effect on the subject due to this event additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 54. AdverseEvent.location | |
| 56. AdverseEvent.location.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 58. AdverseEvent.location.extension:location | |
| Slice Name | location |
| Definition | R5: |
| Short | R5: location additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 60. AdverseEvent.recorder | |
| 62. AdverseEvent.recorder.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.recorder.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 64. AdverseEvent.recorder.extension:recorder | |
| Slice Name | recorder |
| Definition | R5: |
| Short | R5: recorder |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 66. AdverseEvent.suspectEntity | |
| 68. AdverseEvent.suspectEntity.instance | |
| 70. AdverseEvent.suspectEntity.instance.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.suspectEntity.instance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 72. AdverseEvent.suspectEntity.instance.extension:instance | |
| Slice Name | instance |
| Definition | R5: |
| Short | R5: instance additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: instance additional types) (Extension Type: CodeableConcept) |
| 74. AdverseEvent.suspectEntity.instance.extension:instanceAlternateReference | |
| Slice Name | instanceAlternateReference |
| Definition | R5: |
| Short | R5: instance additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 76. AdverseEvent.suspectEntity.causalityProductRelatedness | |
| 78. AdverseEvent.suspectEntity.causalityProductRelatedness.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.suspectEntity.causalityProductRelatedness.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 80. AdverseEvent.suspectEntity.causalityProductRelatedness.extension:entityRelatedness | |
| Slice Name | entityRelatedness |
| Definition | R5: |
| Short | R5: Result of the assessment regarding the relatedness of the suspected entity to the event additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R5: Result of the assessment regarding the relatedness of the suspected entity to the event additional types) (Extension Type: CodeableConcept) |
| 82. AdverseEvent.suspectEntity.causalityAuthor | |
| 84. AdverseEvent.suspectEntity.causalityAuthor.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.suspectEntity.causalityAuthor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 86. AdverseEvent.suspectEntity.causalityAuthor.extension:author | |
| Slice Name | author |
| Definition | R5: |
| Short | R5: Author of the information on the possible cause of the event |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
| 88. AdverseEvent.study | |
| 90. AdverseEvent.study.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on AdverseEvent.study.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 92. AdverseEvent.study.extension:study | |
| Slice Name | study |
| Definition | R5: |
| Short | R5: Research study that the subject is enrolled in additional types |
| Comments | Element |
| Control | 0..* |
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. AdverseEvent | |||||
| Definition | Actual or potential/avoided event causing unintended physical injury resulting from or contributed to by medical care, a research study or other healthcare setting factors that requires additional monitoring, treatment, or hospitalization, or that results in death. | ||||
| Short | Medical care, research study or other healthcare event causing physical injury | ||||
| Control | 0..* | ||||
| Alternate Names | AE | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty()) | ||||
| 2. AdverseEvent.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. AdverseEvent.meta | |||||
| Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. AdverseEvent.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. | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. AdverseEvent.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 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages  (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. AdverseEvent.text | |||||
| Definition | A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. AdverseEvent.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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. AdverseEvent.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. AdverseEvent.extension:encounter | |||||
| Slice Name | encounter | ||||
| Definition | R5: | ||||
| Short | R5: The Encounter associated with the start of the AdverseEvent (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: The Encounter associated with the start of the AdverseEvent (new)) (Extension Type: Reference(Cross-version Profile for R5.Encounter for use in FHIR STU3, Encounter)) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. AdverseEvent.extension:occurrence | |||||
| Slice Name | occurrence | ||||
| Definition | R5: | ||||
| Short | R5: When the event occurred additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: When the event occurred additional types) (Extension Type: Choice of: Period, Timing) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 20. AdverseEvent.extension:detected | |||||
| Slice Name | detected | ||||
| Definition | R5: | ||||
| Short | R5: When the event was detected (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: When the event was detected (new)) (Extension Type: dateTime) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 22. AdverseEvent.extension:recordedDate | |||||
| Slice Name | recordedDate | ||||
| Definition | R5: | ||||
| Short | R5: When the event was recorded (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: When the event was recorded (new)) (Extension Type: dateTime) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 24. AdverseEvent.extension:participant | |||||
| Slice Name | participant | ||||
| Definition | R5: | ||||
| Short | R5: Who was involved in the adverse event or the potential adverse event and what they did (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Who was involved in the adverse event or the potential adverse event and what they did (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 26. AdverseEvent.extension:expectedInResearchStudy | |||||
| Slice Name | expectedInResearchStudy | ||||
| Definition | R5: | ||||
| Short | R5: Considered likely or probable or anticipated in the research study (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Considered likely or probable or anticipated in the research study (new)) (Extension Type: boolean) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 28. AdverseEvent.extension:contributingFactor | |||||
| Slice Name | contributingFactor | ||||
| Definition | R5: | ||||
| Short | R5: Contributing factors suspected to have increased the probability or severity of the adverse event (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Contributing factors suspected to have increased the probability or severity of the adverse event (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 30. AdverseEvent.extension:preventiveAction | |||||
| Slice Name | preventiveAction | ||||
| Definition | R5: | ||||
| Short | R5: Preventive actions that contributed to avoiding the adverse event (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Preventive actions that contributed to avoiding the adverse event (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 32. AdverseEvent.extension:mitigatingAction | |||||
| Slice Name | mitigatingAction | ||||
| Definition | R5: | ||||
| Short | R5: Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Ameliorating actions taken after the adverse event occured in order to reduce the extent of harm (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 34. AdverseEvent.extension:supportingInfo | |||||
| Slice Name | supportingInfo | ||||
| Definition | R5: | ||||
| Short | R5: Supporting information relevant to the event (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Supporting information relevant to the event (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 36. AdverseEvent.extension:note | |||||
| Slice Name | note | ||||
| Definition | R5: | ||||
| Short | R5: Comment on adverse event (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Comment on adverse event (new)) (Extension Type: Annotation) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 38. AdverseEvent.modifierExtension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 40. AdverseEvent.modifierExtension:status | |||||
| Slice Name | status | ||||
| Definition | R5: | ||||
| Short | R5: in-progress | completed | entered-in-error | unknown (new) | ||||
| Comments | Element | ||||
| Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: in-progress | completed | entered-in-error | unknown (new)) (Extension Type: code) | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 42. AdverseEvent.identifier | |||||
| Definition | The identifier(s) of this adverse event that are assigned by business processes and/or used to refer to it when a direct URL reference to the resource itsefl is not appropriate. | ||||
| Short | Business identifier for the event | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 44. AdverseEvent.category | |||||
| Definition | The type of event which is important to characterize what occurred and caused harm to the subject, or had the potential to cause harm to the subject. | ||||
| Short | AE | PAE An adverse event is an event that caused harm to a patient, an adverse reaction is a something that is a subject-specific event that is a result of an exposure to a medication, food, device or environmental substance, a potential adverse event is something that occurred and that could have caused harm to a patient but did not | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdverseEventCategory (required to http://hl7.org/fhir/ValueSet/adverse-event-category|3.0.2)Overall categorization of the event, e.g. real or potential | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 46. AdverseEvent.category.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 48. AdverseEvent.category.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.category.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 50. AdverseEvent.category.extension:category | |||||
| Slice Name | category | ||||
| Definition | R5: | ||||
| Short | R5: wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site additional types | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: wrong-patient | procedure-mishap | medication-mishap | device | unsafe-physical-environment | hospital-aquired-infection | wrong-body-site additional types) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 52. AdverseEvent.category.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 54. AdverseEvent.type | |||||
| Definition | This element defines the specific type of event that occurred or that was prevented from occurring. | ||||
| Short | actual | potential | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see SNOMED CT Clinical Findings (example to http://hl7.org/fhir/ValueSet/adverse-event-type|3.0.2)Detailed type of event | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 56. AdverseEvent.type.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 58. AdverseEvent.type.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 60. AdverseEvent.type.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..* | ||||
| Type | Coding | ||||
| Summary | true | ||||
| Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. | ||||
| 62. AdverseEvent.type.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 | ||||
| Type | string | ||||
| 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. | ||||
| 64. AdverseEvent.subject | |||||
| Definition | This subject or group impacted by the event. With a prospective adverse event, there will be no subject as the adverse event was prevented. | ||||
| Short | Subject or group impacted by event | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, ResearchSubject, Medication, Device) | ||||
| Summary | true | ||||
| Alternate Names | patient | ||||
| 66. AdverseEvent.subject.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 68. AdverseEvent.subject.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 1..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.subject.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. AdverseEvent.subject.extension:subject | |||||
| Slice Name | subject | ||||
| Definition | R5: | ||||
| Short | R5: Subject impacted by event | ||||
| Comments | Element | ||||
| Control | 1..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 72. AdverseEvent.subject.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 74. AdverseEvent.subject.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 76. AdverseEvent.subject.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 78. AdverseEvent.date | |||||
| Definition | The date (and perhaps time) when the adverse event occurred. | ||||
| Short | When the event occurred | ||||
| Control | 0..1 | ||||
| Type | dateTime | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 80. AdverseEvent.reaction | |||||
| Definition | Includes information about the reaction that occurred as a result of exposure to a substance (for example, a drug or a chemical). | ||||
| Short | Adverse Reaction Events linked to exposure to substance | ||||
| Control | 0..* | ||||
| Type | Reference(Condition) | ||||
| Summary | true | ||||
| 82. AdverseEvent.reaction.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 84. AdverseEvent.reaction.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.reaction.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 86. AdverseEvent.reaction.extension:resultingEffect | |||||
| Slice Name | resultingEffect | ||||
| Definition | R5: | ||||
| Short | R5: Effect on the subject due to this event additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 88. AdverseEvent.reaction.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 90. AdverseEvent.reaction.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 92. AdverseEvent.reaction.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 94. AdverseEvent.location | |||||
| Definition | The information about where the adverse event occurred. | ||||
| Short | Location where adverse event occurred | ||||
| Control | 0..1 | ||||
| Type | Reference(Location) | ||||
| Summary | true | ||||
| 96. AdverseEvent.location.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 98. AdverseEvent.location.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.location.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 100. AdverseEvent.location.extension:location | |||||
| Slice Name | location | ||||
| Definition | R5: | ||||
| Short | R5: location additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 102. AdverseEvent.location.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 104. AdverseEvent.location.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 106. AdverseEvent.location.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 108. AdverseEvent.seriousness | |||||
| Definition | Describes the seriousness or severity of the adverse event. | ||||
| Short | Mild | Moderate | Severe | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see AdverseEventSeriousness (example to http://hl7.org/fhir/ValueSet/adverse-event-seriousness|3.0.2)Overall seriousness of this event for the patient | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 110. AdverseEvent.outcome | |||||
| Definition | Describes the type of outcome from the adverse event. | ||||
| Short | resolved | recovering | ongoing | resolvedWithSequelae | fatal | unknown | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdverseEventOutcome (required to http://hl7.org/fhir/ValueSet/adverse-event-outcome|3.0.2)TODO (and should this be required?) | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 112. AdverseEvent.recorder | |||||
| Definition | Information on who recorded the adverse event. May be the patient or a practitioner. | ||||
| Short | Who recorded the adverse event | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient, Practitioner, RelatedPerson) | ||||
| Summary | true | ||||
| 114. AdverseEvent.recorder.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 116. AdverseEvent.recorder.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.recorder.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 118. AdverseEvent.recorder.extension:recorder | |||||
| Slice Name | recorder | ||||
| Definition | R5: | ||||
| Short | R5: recorder | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 120. AdverseEvent.recorder.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 122. AdverseEvent.recorder.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 124. AdverseEvent.recorder.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 126. AdverseEvent.eventParticipant | |||||
| Definition | Parties that may or should contribute or have contributed information to the Act. Such information includes information leading to the decision to perform the Act and how to perform the Act (e.g. consultant), information that the Act itself seeks to reveal (e.g. informant of clinical history), or information about what Act was performed (e.g. informant witness). | ||||
| Short | Who was involved in the adverse event or the potential adverse event | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner, Device) | ||||
| Summary | true | ||||
| 128. AdverseEvent.description | |||||
| Definition | Describes the adverse event in text. | ||||
| Short | Description of the adverse event | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 130. AdverseEvent.suspectEntity | |||||
| Definition | Describes the entity that is suspected to have caused the adverse event. | ||||
| Short | The suspected agent causing the adverse event | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 132. AdverseEvent.suspectEntity.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 134. AdverseEvent.suspectEntity.extension | |||||
| Definition | May be used to represent additional information that is not part of the basic definition of the element. In order 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. | ||||
| 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 | ||||
| Alternate Names | extensions, user content | ||||
| 136. AdverseEvent.suspectEntity.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 that contains it. Usually modifier elements provide negation or qualification. In order 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. | ||||
| 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..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 138. AdverseEvent.suspectEntity.instance | |||||
| Definition | Identifies the actual instance of what caused the adverse event. May be a substance, medication, medication administration, medication statement or a device. | ||||
| Short | Refers to the specific entity that caused the adverse event | ||||
| Control | 1..1 | ||||
| Type | Reference(Substance, Medication, MedicationAdministration, MedicationStatement, Device) | ||||
| Summary | true | ||||
| Alternate Names | Substance or Medication or Device | ||||
| 140. AdverseEvent.suspectEntity.instance.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 142. AdverseEvent.suspectEntity.instance.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.suspectEntity.instance.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 144. AdverseEvent.suspectEntity.instance.extension:instance | |||||
| Slice Name | instance | ||||
| Definition | R5: | ||||
| Short | R5: instance additional types | ||||
| Comments | Element | ||||
| Control | 1..1 | ||||
| Type | Extension(R5: instance additional types) (Extension Type: CodeableConcept) | ||||
| 146. AdverseEvent.suspectEntity.instance.extension:instanceAlternateReference | |||||
| Slice Name | instanceAlternateReference | ||||
| Definition | R5: | ||||
| Short | R5: instance additional types | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 148. AdverseEvent.suspectEntity.instance.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 150. AdverseEvent.suspectEntity.instance.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 152. AdverseEvent.suspectEntity.instance.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 154. AdverseEvent.suspectEntity.causality | |||||
| Definition | causality1 | causality2. | ||||
| Short | causality1 | causality2 | ||||
| Control | 0..1 | ||||
| Binding | The codes SHALL be taken from AdverseEventCausality (required to http://hl7.org/fhir/ValueSet/adverse-event-causality|3.0.2)TODO | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 156. AdverseEvent.suspectEntity.causalityAssessment | |||||
| Definition | assess1 | assess2. | ||||
| Short | assess1 | assess2 | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see AdverseEventCausalityAssessment (example to http://hl7.org/fhir/ValueSet/adverse-event-causality-assess|3.0.2)TODO | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 158. AdverseEvent.suspectEntity.causalityProductRelatedness | |||||
| Definition | AdverseEvent.suspectEntity.causalityProductRelatedness. | ||||
| Short | AdverseEvent.suspectEntity.causalityProductRelatedness | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 160. AdverseEvent.suspectEntity.causalityProductRelatedness.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 162. AdverseEvent.suspectEntity.causalityProductRelatedness.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.suspectEntity.causalityProductRelatedness.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 164. AdverseEvent.suspectEntity.causalityProductRelatedness.extension:entityRelatedness | |||||
| Slice Name | entityRelatedness | ||||
| Definition | R5: | ||||
| Short | R5: Result of the assessment regarding the relatedness of the suspected entity to the event additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R5: Result of the assessment regarding the relatedness of the suspected entity to the event additional types) (Extension Type: CodeableConcept) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 166. AdverseEvent.suspectEntity.causalityProductRelatedness.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for string | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Max Length: | 1048576 | ||||
| 168. AdverseEvent.suspectEntity.causalityMethod | |||||
| Definition | method1 | method2. | ||||
| Short | method1 | method2 | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see AdverseEventCausalityMethod (example to http://hl7.org/fhir/ValueSet/adverse-event-causality-method|3.0.2)TODO | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 170. AdverseEvent.suspectEntity.causalityAuthor | |||||
| Definition | AdverseEvent.suspectEntity.causalityAuthor. | ||||
| Short | AdverseEvent.suspectEntity.causalityAuthor | ||||
| Control | 0..1 | ||||
| Type | Reference(Practitioner, PractitionerRole) | ||||
| Summary | true | ||||
| 172. AdverseEvent.suspectEntity.causalityAuthor.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 174. AdverseEvent.suspectEntity.causalityAuthor.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.suspectEntity.causalityAuthor.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 176. AdverseEvent.suspectEntity.causalityAuthor.extension:author | |||||
| Slice Name | author | ||||
| Definition | R5: | ||||
| Short | R5: Author of the information on the possible cause of the event | ||||
| Comments | Element | ||||
| Control | 0..1 | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 178. AdverseEvent.suspectEntity.causalityAuthor.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 180. AdverseEvent.suspectEntity.causalityAuthor.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 182. AdverseEvent.suspectEntity.causalityAuthor.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 184. AdverseEvent.suspectEntity.causalityResult | |||||
| Definition | result1 | result2. | ||||
| Short | result1 | result2 | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see AdverseEventCausalityResult (example to http://hl7.org/fhir/ValueSet/adverse-event-causality-result|3.0.2)TODO | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 186. AdverseEvent.subjectMedicalHistory | |||||
| Definition | AdverseEvent.subjectMedicalHistory. | ||||
| Short | AdverseEvent.subjectMedicalHistory | ||||
| Control | 0..* | ||||
| Type | Reference(Condition, Observation, AllergyIntolerance, FamilyMemberHistory, Immunization, Procedure) | ||||
| Summary | true | ||||
| 188. AdverseEvent.referenceDocument | |||||
| Definition | AdverseEvent.referenceDocument. | ||||
| Short | AdverseEvent.referenceDocument | ||||
| Control | 0..* | ||||
| Type | Reference(DocumentReference) | ||||
| Summary | true | ||||
| 190. AdverseEvent.study | |||||
| Definition | AdverseEvent.study. | ||||
| Short | AdverseEvent.study | ||||
| Control | 0..* | ||||
| Type | Reference(ResearchStudy) | ||||
| Summary | true | ||||
| 192. AdverseEvent.study.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 | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 194. AdverseEvent.study.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on AdverseEvent.study.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 196. AdverseEvent.study.extension:study | |||||
| Slice Name | study | ||||
| Definition | R5: | ||||
| Short | R5: Research study that the subject is enrolled in additional types | ||||
| Comments | Element | ||||
| Control | 0..* | ||||
| Type | Extension(http://hl7.org/fhir/StructureDefinition/alternate-reference) | ||||
| 198. AdverseEvent.study.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 200. AdverseEvent.study.identifier | |||||
| Definition | An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity 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. | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..1 | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| 202. AdverseEvent.study.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 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r3#0.1.0 based on FHIR 3.0.2. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change