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

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

Extension: ExtensionAdverseEvent_SupportingInfo - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-AdverseEvent.supportingInfo extension.

Guidance on how to interpret the contents of this table can be foundhere

0. Extension
Definition

R5: AdverseEvent.supportingInfo (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Supporting information relevant to the event (new)Optional Extensions Element
Comments

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

Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
2. Extension.extension
Definition

An Extension


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

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

Control10..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
    • 4. Extension.extension:item
    Slice Nameitem
    Definition

    R5: AdverseEvent.supportingInfo.item[x] (new:CodeableConcept, Reference(Condition,Observation,AllergyIntolerance,FamilyMemberHistory,Immunization,Procedure,DocumentReference,MedicationAdministration,MedicationStatement,QuestionnaireResponse))

    ShortR5: Subject medical history or document relevant to this adverse event (new)Additional content defined by implementations
    Comments

    Element AdverseEvent.supportingInfo.item[x] is part of an existing definition because parent element AdverseEvent.supportingInfo requires a cross-version extension. Element AdverseEvent.supportingInfo.item[x] has a context of AdverseEvent based on following the parent source element upwards and mapping to AdverseEvent. Element AdverseEvent.supportingInfo.item[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element AdverseEvent.supportingInfo.item[x] is part of an existing definition because parent element AdverseEvent.supportingInfo requires a cross-version extension. Element AdverseEvent.supportingInfo.item[x] has a context of AdverseEvent based on following the parent source element upwards and mapping to AdverseEvent. Element AdverseEvent.supportingInfo.item[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

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

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valueitem
    8. Extension.extension:item.value[x]
    Definition

    Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.


    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortSubject medical history or document relevant to this adverse eventValue of extension
    Control10..1
    TypeChoice of: Reference(Cross-version Profile for R5.Condition for use in FHIR R4, Condition, Cross-version Profile for R5.Observation for use in FHIR R4, Observation, Cross-version Profile for R5.AllergyIntolerance for use in FHIR R4, AllergyIntolerance, Cross-version Profile for R5.FamilyMemberHistory for use in FHIR R4, FamilyMemberHistory, Cross-version Profile for R5.Immunization for use in FHIR R4, Immunization, Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure, Cross-version Profile for R5.DocumentReference for use in FHIR R4, Media, Cross-version Profile for R5.MedicationAdministration for use in FHIR R4, MedicationAdministration, Cross-version Profile for R5.MedicationStatement for use in FHIR R4, MedicationStatement, Cross-version Profile for R5.QuestionnaireResponse for use in FHIR R4, QuestionnaireResponse), CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.url
    Definition

    Source of the definition for the extension code - a logical name or a URL.

    Shortidentifies the meaning of the extension
    Comments

    The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

    Control1..1
    Typeuri
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-AdverseEvent.supportingInfo
    12. Extension.value[x]
    Definition

    Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

    Guidance on how to interpret the contents of this table can be foundhere

    0. Extension
    Definition

    R5: AdverseEvent.supportingInfo (new:BackboneElement)

    ShortR5: Supporting information relevant to the event (new)
    Comments

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

    Control0..*
    Is Modifierfalse
    2. Extension.extension
    Control1..*
    SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
      • 4. Extension.extension:item
      Slice Nameitem
      Definition

      R5: AdverseEvent.supportingInfo.item[x] (new:CodeableConcept, Reference(Condition,Observation,AllergyIntolerance,FamilyMemberHistory,Immunization,Procedure,DocumentReference,MedicationAdministration,MedicationStatement,QuestionnaireResponse))

      ShortR5: Subject medical history or document relevant to this adverse event (new)
      Comments

      Element AdverseEvent.supportingInfo.item[x] is part of an existing definition because parent element AdverseEvent.supportingInfo requires a cross-version extension. Element AdverseEvent.supportingInfo.item[x] has a context of AdverseEvent based on following the parent source element upwards and mapping to AdverseEvent. Element AdverseEvent.supportingInfo.item[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element AdverseEvent.supportingInfo.item[x] is part of an existing definition because parent element AdverseEvent.supportingInfo requires a cross-version extension. Element AdverseEvent.supportingInfo.item[x] has a context of AdverseEvent based on following the parent source element upwards and mapping to AdverseEvent. Element AdverseEvent.supportingInfo.item[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:item.url
      Control1..1
      Fixed Valueitem
      8. Extension.extension:item.value[x]
      Definition

      Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.

      ShortSubject medical history or document relevant to this adverse event
      Control1..1
      TypeChoice of: Reference(Cross-version Profile for R5.Condition for use in FHIR R4, Condition, Cross-version Profile for R5.Observation for use in FHIR R4, Observation, Cross-version Profile for R5.AllergyIntolerance for use in FHIR R4, AllergyIntolerance, Cross-version Profile for R5.FamilyMemberHistory for use in FHIR R4, FamilyMemberHistory, Cross-version Profile for R5.Immunization for use in FHIR R4, Immunization, Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure, Cross-version Profile for R5.DocumentReference for use in FHIR R4, Media, Cross-version Profile for R5.MedicationAdministration for use in FHIR R4, MedicationAdministration, Cross-version Profile for R5.MedicationStatement for use in FHIR R4, MedicationStatement, Cross-version Profile for R5.QuestionnaireResponse for use in FHIR R4, QuestionnaireResponse), CodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-AdverseEvent.supportingInfo
      12. Extension.value[x]
      Control0..0

      Guidance on how to interpret the contents of this table can be foundhere

      0. Extension
      Definition

      R5: AdverseEvent.supportingInfo (new:BackboneElement)

      ShortR5: Supporting information relevant to the event (new)
      Comments

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

      Control0..*
      This element is affected by the following invariants: ele-1
      Is Modifierfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      2. Extension.id
      Definition

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

      ShortUnique id for inter-element referencing
      Control0..1
      Typestring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      4. Extension.extension
      Definition

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
      SlicingThis element introduces a set of slices on Extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
        • 6. Extension.extension:item
        Slice Nameitem
        Definition

        R5: AdverseEvent.supportingInfo.item[x] (new:CodeableConcept, Reference(Condition,Observation,AllergyIntolerance,FamilyMemberHistory,Immunization,Procedure,DocumentReference,MedicationAdministration,MedicationStatement,QuestionnaireResponse))

        ShortR5: Subject medical history or document relevant to this adverse event (new)
        Comments

        Element AdverseEvent.supportingInfo.item[x] is part of an existing definition because parent element AdverseEvent.supportingInfo requires a cross-version extension. Element AdverseEvent.supportingInfo.item[x] has a context of AdverseEvent based on following the parent source element upwards and mapping to AdverseEvent. Element AdverseEvent.supportingInfo.item[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Control1..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element AdverseEvent.supportingInfo.item[x] is part of an existing definition because parent element AdverseEvent.supportingInfo requires a cross-version extension. Element AdverseEvent.supportingInfo.item[x] has a context of AdverseEvent based on following the parent source element upwards and mapping to AdverseEvent. Element AdverseEvent.supportingInfo.item[x] has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

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

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

        ShortUnique id for inter-element referencing
        Control0..1
        Typestring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        10. Extension.extension:item.extension
        Definition

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

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

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
        SlicingThis element introduces a set of slices on Extension.extension.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
          • 12. Extension.extension:item.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valueitem
          14. Extension.extension:item.value[x]
          Definition

          Relevant past history for the subject. In a clinical care context, an example being a patient had an adverse event following a pencillin administration and the patient had a previously documented penicillin allergy. In a clinical trials context, an example is a bunion or rash that was present prior to the study. Additionally, the supporting item can be a document that is relevant to this instance of the adverse event that is not part of the subject's medical history. For example, a clinical note, staff list, or material safety data sheet (MSDS). Supporting information is not a contributing factor, preventive action, or mitigating action.

          ShortSubject medical history or document relevant to this adverse event
          Control1..1
          TypeChoice of: Reference(Cross-version Profile for R5.Condition for use in FHIR R4, Condition, Cross-version Profile for R5.Observation for use in FHIR R4, Observation, Cross-version Profile for R5.AllergyIntolerance for use in FHIR R4, AllergyIntolerance, Cross-version Profile for R5.FamilyMemberHistory for use in FHIR R4, FamilyMemberHistory, Cross-version Profile for R5.Immunization for use in FHIR R4, Immunization, Cross-version Profile for R5.Procedure for use in FHIR R4, Procedure, Cross-version Profile for R5.DocumentReference for use in FHIR R4, Media, Cross-version Profile for R5.MedicationAdministration for use in FHIR R4, MedicationAdministration, Cross-version Profile for R5.MedicationStatement for use in FHIR R4, MedicationStatement, Cross-version Profile for R5.QuestionnaireResponse for use in FHIR R4, QuestionnaireResponse), CodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Is Modifierfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          16. Extension.url
          Definition

          Source of the definition for the extension code - a logical name or a URL.

          Shortidentifies the meaning of the extension
          Comments

          The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

          Control1..1
          Typeuri
          Is Modifierfalse
          XML FormatIn the XML format, this property is represented as an attribute.
          Summaryfalse
          Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-AdverseEvent.supportingInfo
          18. Extension.value[x]
          Definition

          Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

          ShortValue of extension
          Control0..0
          TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))