International Patient Summary Implementation Guide
2.0.0 - STU 2 International flag

International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/fhir-ips/ and changes regularly. See the Directory of published versions

Logical Model: AlertsSection - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 2

Definitions for the AlertsSection logical model.

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

0. AlertsSection
Definition

Information used to warn or call to a state of preparedness

ShortAlerts
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. AlertsSection.alert
Definition

Alert

ShortAlert
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. AlertsSection.alert.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
6. AlertsSection.alert.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 AlertsSection.alert.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 8. AlertsSection.alert.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    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())
    10. AlertsSection.alert.type
    Definition

    Alert type

    ShortAlert type
    Comments

    Required if known

    Control0..1
    TypeCodeableConcept
    12. AlertsSection.alert.identifier
    Definition

    Alert identifier

    ShortAlert identifier
    Comments

    Required if known

    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..1
    TypeIdentifier
    14. AlertsSection.alert.description
    Definition

    Alert description

    ShortAlert description
    Comments

    Required (Exceptions allowed)

    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. AlertsSection.alert.level
    Definition

    Alert level

    ShortAlert level
    Comments

    Required if known

    Control0..1
    TypeQuantity
    18. AlertsSection.diseaseRelatedDiagnosis
    Definition

    Disease-related diagnosis

    ShortDisease-related diagnosis
    Control0..1
    TypeBackboneElement
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    20. AlertsSection.diseaseRelatedDiagnosis.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
    22. AlertsSection.diseaseRelatedDiagnosis.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 AlertsSection.diseaseRelatedDiagnosis.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 24. AlertsSection.diseaseRelatedDiagnosis.modifierExtension
      Definition

      May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

      Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

      ShortExtensions that cannot be ignored even if unrecognized
      Comments

      There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

      Control0..*
      TypeExtension
      Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
      Summarytrue
      Requirements

      Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

      Alternate Namesextensions, user content, modifiers
      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())
      26. AlertsSection.diseaseRelatedDiagnosis.diseaseName
      Definition

      Disease name

      ShortDisease name
      Comments

      Optional

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      28. AlertsSection.diseaseRelatedDiagnosis.onsetDate
      Definition

      Onset date

      ShortOnset date
      Comments

      Required if known

      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      30. AlertsSection.diseaseRelatedDiagnosis.assertionDegree
      Definition

      Assertion degree

      ShortAssertion degree
      Comments

      Required if known

      Control0..1
      TypeCodeableConcept
      32. AlertsSection.diseaseRelatedDiagnosis.confirmationMethod
      Definition

      Confirmation method

      ShortConfirmation method
      Comments

      Required if known

      Control0..1
      TypeCodeableConcept
      34. AlertsSection.diseaseRelatedDiagnosis.specialistContact
      Definition

      Specialist contact

      ShortSpecialist contact
      Comments

      Optional

      Control0..1
      TypeReference
      36. AlertsSection.diseaseRelatedDiagnosis.referenceToSpecialistAdvice
      Definition

      A reference to specialist advice or guideline

      ShortA reference to specialist advice or guideline
      Comments

      Optional

      Control0..1
      TypeReference

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

      0. AlertsSection
      Definition

      Information used to warn or call to a state of preparedness

      ShortAlerts
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. AlertsSection.alert
      Definition

      Alert

      ShortAlert
      Control0..*
      TypeBackboneElement
      4. AlertsSection.alert.type
      Definition

      Alert type

      ShortAlert type
      Comments

      Required if known

      Control0..1
      TypeCodeableConcept
      6. AlertsSection.alert.identifier
      Definition

      Alert identifier

      ShortAlert identifier
      Comments

      Required if known

      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      TypeIdentifier
      8. AlertsSection.alert.description
      Definition

      Alert description

      ShortAlert description
      Comments

      Required (Exceptions allowed)

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      10. AlertsSection.alert.level
      Definition

      Alert level

      ShortAlert level
      Comments

      Required if known

      Control0..1
      TypeQuantity
      12. AlertsSection.diseaseRelatedDiagnosis
      Definition

      Disease-related diagnosis

      ShortDisease-related diagnosis
      Control0..1
      TypeBackboneElement
      14. AlertsSection.diseaseRelatedDiagnosis.diseaseName
      Definition

      Disease name

      ShortDisease name
      Comments

      Optional

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. AlertsSection.diseaseRelatedDiagnosis.onsetDate
      Definition

      Onset date

      ShortOnset date
      Comments

      Required if known

      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. AlertsSection.diseaseRelatedDiagnosis.assertionDegree
      Definition

      Assertion degree

      ShortAssertion degree
      Comments

      Required if known

      Control0..1
      TypeCodeableConcept
      20. AlertsSection.diseaseRelatedDiagnosis.confirmationMethod
      Definition

      Confirmation method

      ShortConfirmation method
      Comments

      Required if known

      Control0..1
      TypeCodeableConcept
      22. AlertsSection.diseaseRelatedDiagnosis.specialistContact
      Definition

      Specialist contact

      ShortSpecialist contact
      Comments

      Optional

      Control0..1
      TypeReference
      24. AlertsSection.diseaseRelatedDiagnosis.referenceToSpecialistAdvice
      Definition

      A reference to specialist advice or guideline

      ShortA reference to specialist advice or guideline
      Comments

      Optional

      Control0..1
      TypeReference

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

      0. AlertsSection
      Definition

      Information used to warn or call to a state of preparedness

      ShortAlerts
      Control0..*
      Is Modifierfalse
      Logical ModelInstances of this logical model are not marked to be the target of a Reference
      2. AlertsSection.alert
      Definition

      Alert

      ShortAlert
      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      4. AlertsSection.alert.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
      6. AlertsSection.alert.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 AlertsSection.alert.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 8. AlertsSection.alert.modifierExtension
        Definition

        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        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())
        10. AlertsSection.alert.type
        Definition

        Alert type

        ShortAlert type
        Comments

        Required if known

        Control0..1
        TypeCodeableConcept
        12. AlertsSection.alert.identifier
        Definition

        Alert identifier

        ShortAlert identifier
        Comments

        Required if known

        NoteThis is a business identifier, not a resource identifier (see discussion)
        Control0..1
        TypeIdentifier
        14. AlertsSection.alert.description
        Definition

        Alert description

        ShortAlert description
        Comments

        Required (Exceptions allowed)

        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        16. AlertsSection.alert.level
        Definition

        Alert level

        ShortAlert level
        Comments

        Required if known

        Control0..1
        TypeQuantity
        18. AlertsSection.diseaseRelatedDiagnosis
        Definition

        Disease-related diagnosis

        ShortDisease-related diagnosis
        Control0..1
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. AlertsSection.diseaseRelatedDiagnosis.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
        22. AlertsSection.diseaseRelatedDiagnosis.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 AlertsSection.diseaseRelatedDiagnosis.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 24. AlertsSection.diseaseRelatedDiagnosis.modifierExtension
          Definition

          May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

          Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          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())
          26. AlertsSection.diseaseRelatedDiagnosis.diseaseName
          Definition

          Disease name

          ShortDisease name
          Comments

          Optional

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          28. AlertsSection.diseaseRelatedDiagnosis.onsetDate
          Definition

          Onset date

          ShortOnset date
          Comments

          Required if known

          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          30. AlertsSection.diseaseRelatedDiagnosis.assertionDegree
          Definition

          Assertion degree

          ShortAssertion degree
          Comments

          Required if known

          Control0..1
          TypeCodeableConcept
          32. AlertsSection.diseaseRelatedDiagnosis.confirmationMethod
          Definition

          Confirmation method

          ShortConfirmation method
          Comments

          Required if known

          Control0..1
          TypeCodeableConcept
          34. AlertsSection.diseaseRelatedDiagnosis.specialistContact
          Definition

          Specialist contact

          ShortSpecialist contact
          Comments

          Optional

          Control0..1
          TypeReference
          36. AlertsSection.diseaseRelatedDiagnosis.referenceToSpecialistAdvice
          Definition

          A reference to specialist advice or guideline

          ShortA reference to specialist advice or guideline
          Comments

          Optional

          Control0..1
          TypeReference