Vital Signs Cross-Country Cross-Language Cross-Paradigm (Demo) IG
0.6.7 - ci-build

Vital Signs Cross-Country Cross-Language Cross-Paradigm (Demo) IG, published by FO. This guide is not an authorized publication; it is the continuous build for version 0.6.7 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/frankoemig/vital-signs-demo/ and changes regularly. See the Directory of published versions

Logical Model: BMI - Detailed Descriptions

Active as of 2024-04-16

Definitions for the BodyMassIndex logical model.

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

0. BodyMassIndex
Definition

Body Mass Index

ShortBody Mass Index LM
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. BodyMassIndex.value
Definition

value

Shortvalue
Control1..1
TypepositiveInt
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. BodyMassIndex.unit
Definition

units

Shortunits
Control1..1
BindingThe codes SHALL be taken from BMI Units
(required to http://vitals.oemig.de/fhir/ValueSet/BMIunits)
TypeCodeableConcept
6. BodyMassIndex.range
Definition

reference range

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

    Low Range, if relevant

    ShortLow Range, if relevant
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. BodyMassIndex.range.high
    Definition

    High Range, if relevant

    ShortHigh Range, if relevant
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    18. BodyMassIndex.range.age
    Definition

    Applicable age range, if relevant

    ShortApplicable age range, if relevant
    Control0..1
    TypeRange
    20. BodyMassIndex.range.text
    Definition

    Text based reference range in an observation

    ShortText based reference range in an observation
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. BodyMassIndex.interpretation
    Definition

    overall clinical meaning of the BP measurement

    Shortoverall clinical meaning of the BP measurement
    Control0..1
    BindingThe codes SHALL be taken from Interpretation
    (required to http://vitals.oemig.de/fhir/ValueSet/Interpretation)
    TypeCodeableConcept
    Summarytrue
    24. BodyMassIndex.dataAbsentReason
    Definition

    Why the component result is missing

    ShortWhy the component result is missing
    Control0..1
    BindingThe codes SHALL be taken from DataAbsentReason
    (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
    TypeCodeableConcept
    26. BodyMassIndex.effective[x]
    Definition

    different representations

    Shortdate of observation
    Control0..1
    TypeChoice of: date, instant, Period
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    28. BodyMassIndex.comment
    Definition

    any comment

    Shortany comment
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    30. BodyMassIndex.subject
    Definition

    reference to the subject of the measurement

    Shortreference to the subject of the measurement
    Control0..1
    TypeReference(Patient)
    32. BodyMassIndex.author
    Definition

    reference to the author of the measurement

    Shortreference to the author of the measurement
    Control0..1
    TypeReference(Practitioner)
    34. BodyMassIndex.performer
    Definition

    reference to the performer of the measurement

    Shortreference to the performer of the measurement
    Control0..1
    TypeReference(Practitioner)

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

    0. BodyMassIndex
    Definition

    Body Mass Index

    ShortBody Mass Index LM
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. BodyMassIndex.value
    Definition

    value

    Shortvalue
    Control1..1
    TypepositiveInt
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. BodyMassIndex.unit
    Definition

    units

    Shortunits
    Control1..1
    BindingThe codes SHALL be taken from BMI Units
    (required to http://vitals.oemig.de/fhir/ValueSet/BMIunits)
    TypeCodeableConcept
    6. BodyMassIndex.range
    Definition

    reference range

    Shortreference range
    Control0..*
    TypeBackboneElement
    8. BodyMassIndex.range.low
    Definition

    Low Range, if relevant

    ShortLow Range, if relevant
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    10. BodyMassIndex.range.high
    Definition

    High Range, if relevant

    ShortHigh Range, if relevant
    Control0..1
    Typeinteger
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    12. BodyMassIndex.range.age
    Definition

    Applicable age range, if relevant

    ShortApplicable age range, if relevant
    Control0..1
    TypeRange
    14. BodyMassIndex.range.text
    Definition

    Text based reference range in an observation

    ShortText based reference range in an observation
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    16. BodyMassIndex.interpretation
    Definition

    overall clinical meaning of the BP measurement

    Shortoverall clinical meaning of the BP measurement
    Control0..1
    BindingThe codes SHALL be taken from Interpretation
    (required to http://vitals.oemig.de/fhir/ValueSet/Interpretation)
    TypeCodeableConcept
    18. BodyMassIndex.dataAbsentReason
    Definition

    Why the component result is missing

    ShortWhy the component result is missing
    Control0..1
    BindingThe codes SHALL be taken from DataAbsentReason
    (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
    TypeCodeableConcept
    20. BodyMassIndex.effective[x]
    Definition

    different representations

    Shortdate of observation
    Control0..1
    TypeChoice of: date, instant, Period
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    22. BodyMassIndex.comment
    Definition

    any comment

    Shortany comment
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    24. BodyMassIndex.subject
    Definition

    reference to the subject of the measurement

    Shortreference to the subject of the measurement
    Control0..1
    TypeReference(Patient)
    26. BodyMassIndex.author
    Definition

    reference to the author of the measurement

    Shortreference to the author of the measurement
    Control0..1
    TypeReference(Practitioner)
    28. BodyMassIndex.performer
    Definition

    reference to the performer of the measurement

    Shortreference to the performer of the measurement
    Control0..1
    TypeReference(Practitioner)

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

    0. BodyMassIndex
    Definition

    Body Mass Index

    ShortBody Mass Index LM
    Control0..*
    Is Modifierfalse
    Logical ModelInstances of this logical model are not marked to be the target of a Reference
    2. BodyMassIndex.value
    Definition

    value

    Shortvalue
    Control1..1
    TypepositiveInt
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    4. BodyMassIndex.unit
    Definition

    units

    Shortunits
    Control1..1
    BindingThe codes SHALL be taken from BMI Units
    (required to http://vitals.oemig.de/fhir/ValueSet/BMIunits)
    TypeCodeableConcept
    6. BodyMassIndex.range
    Definition

    reference range

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

      Low Range, if relevant

      ShortLow Range, if relevant
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      16. BodyMassIndex.range.high
      Definition

      High Range, if relevant

      ShortHigh Range, if relevant
      Control0..1
      Typeinteger
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      18. BodyMassIndex.range.age
      Definition

      Applicable age range, if relevant

      ShortApplicable age range, if relevant
      Control0..1
      TypeRange
      20. BodyMassIndex.range.text
      Definition

      Text based reference range in an observation

      ShortText based reference range in an observation
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      22. BodyMassIndex.interpretation
      Definition

      overall clinical meaning of the BP measurement

      Shortoverall clinical meaning of the BP measurement
      Control0..1
      BindingThe codes SHALL be taken from Interpretation
      (required to http://vitals.oemig.de/fhir/ValueSet/Interpretation)
      TypeCodeableConcept
      Summarytrue
      24. BodyMassIndex.dataAbsentReason
      Definition

      Why the component result is missing

      ShortWhy the component result is missing
      Control0..1
      BindingThe codes SHALL be taken from DataAbsentReason
      (required to http://hl7.org/fhir/ValueSet/data-absent-reason)
      TypeCodeableConcept
      26. BodyMassIndex.effective[x]
      Definition

      different representations

      Shortdate of observation
      Control0..1
      TypeChoice of: date, instant, Period
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      28. BodyMassIndex.comment
      Definition

      any comment

      Shortany comment
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      30. BodyMassIndex.subject
      Definition

      reference to the subject of the measurement

      Shortreference to the subject of the measurement
      Control0..1
      TypeReference(Patient)
      32. BodyMassIndex.author
      Definition

      reference to the author of the measurement

      Shortreference to the author of the measurement
      Control0..1
      TypeReference(Practitioner)
      34. BodyMassIndex.performer
      Definition

      reference to the performer of the measurement

      Shortreference to the performer of the measurement
      Control0..1
      TypeReference(Practitioner)