Nictiz FHIR NL STU3 Zib2017
1.3.15 - CI Build

Nictiz FHIR NL STU3 Zib2017 - Local Development build (v1.3.15) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Extension: Zib BurnWound Extent - Detailed Descriptions

Draft as of 2024-04-09

Definitions for the zib-BurnWound-Extent extension.

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

0. Extension
ShortExtent
Alternate NamesUitgebreidheid
2. Extension.url
Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-BurnWound-Extent
4. Extension.valueQuantity:valueQuantity
Slice NamevalueQuantity
TypeQuantity
6. Extension.valueQuantity:valueQuantity.value
Min Value0
Max Value100
8. Extension.valueQuantity:valueQuantity.unit
Default Value%
10. Extension.valueQuantity:valueQuantity.system
Default Valuehttp://unitsofmeasure.org
12. Extension.valueQuantity:valueQuantity.code
Default Value%

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

0. Extension
Definition

An Extension


Optional Extension Element - found in all resources.

ShortExtentOptional Extensions Element
Control0..*
This element is affected by the following invariants: ele-1
Alternate NamesUitgebreidheid
Invariantsele-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())
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())
2. 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
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-BurnWound-Extent
4. Extension.value[x]
Definition

Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

ShortValue of extension
Control0..1
TypeQuantity, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
    • 6. Extension.value[x]:valueQuantity
    Slice NamevalueQuantity
    Definition

    Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

    ShortValue of extension
    Control0..1
    TypeQuantity, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, markdown, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [x] NoteSee Choice of Data Types for further information about how to use [x]
    8. Extension.value[x]:valueQuantity.comparator
    Definition

    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

    Short< | <= | >= | > - how to understand the value
    Comments

    This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.

    Control0..1
    BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator
    (required to http://hl7.org/fhir/ValueSet/quantity-comparator)

    How the Quantity should be understood and represented.

    Typecode
    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

    Meaning if MissingIf there is no comparator, then there is no modification of the value

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

    0. Extension
    Definition

    An Extension

    ShortExtent
    Control0..*
    This element is affected by the following invariants: ele-1
    Alternate NamesUitgebreidheid
    Invariantsele-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())
    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.

    Shortxml:id (or equivalent in JSON)
    Control0..1
    Typestring
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    XML FormatIn the XML format, this property is represented as an attribute.
    4. Extension.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.

    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
    Alternate Namesextensions, user content
    SlicingThis element introduces a set of slices on Extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
    • value @ url
      • 6. 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
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      XML FormatIn the XML format, this property is represented as an attribute.
      Fixed Valuehttp://nictiz.nl/fhir/StructureDefinition/zib-BurnWound-Extent
      8. Extension.value[x]
      Definition

      Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

      ShortValue of extension
      Control0..1
      TypeQuantity
      [x] NoteSee Choice of Data Types for further information about how to use [x]
      SlicingThis element introduces a set of slices on Extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
      • type @ $this
        • 10. Extension.value[x]:valueQuantity
        Slice NamevalueQuantity
        Definition

        Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).

        ShortValue of extension
        Control0..1
        TypeQuantity
        [x] NoteSee Choice of Data Types for further information about how to use [x]
        12. Extension.value[x]:valueQuantity.id
        Definition

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

        Shortxml:id (or equivalent in JSON)
        Control0..1
        Typestring
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        XML FormatIn the XML format, this property is represented as an attribute.
        14. Extension.value[x]:valueQuantity.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.

        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
        Alternate Namesextensions, user content
        SlicingThis element introduces a set of slices on Extension.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
        • value @ url
          • 16. Extension.value[x]:valueQuantity.value
          Definition

          The value of the measured amount. The value includes an implicit precision in the presentation of the value.

          ShortNumerical value (with implicit precision)
          Comments

          The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

          Control0..1
          Typedecimal
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Precision is handled implicitly in almost all cases of measurement.

          Min Value0
          Max Value100
          18. Extension.value[x]:valueQuantity.comparator
          Definition

          How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

          Short< | <= | >= | > - how to understand the value
          Comments

          This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.

          Control0..1
          BindingThe codes SHALL be taken from QuantityComparator
          (required to http://hl7.org/fhir/ValueSet/quantity-comparator)

          How the Quantity should be understood and represented.

          Typecode
          Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

          Meaning if MissingIf there is no comparator, then there is no modification of the value
          20. Extension.value[x]:valueQuantity.unit
          Definition

          A human-readable form of the unit.

          ShortUnit representation
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

          22. Extension.value[x]:valueQuantity.system
          Definition

          The identification of the system that provides the coded form of the unit.

          ShortSystem that defines coded unit form
          Control0..1
          This element is affected by the following invariants: qty-3
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need to know the system that defines the coded form of the unit.

          24. Extension.value[x]:valueQuantity.code
          Definition

          A computer processable form of the unit in some unit representation system.

          ShortCoded form of the unit
          Comments

          The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

          Control0..1
          Typecode
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Summarytrue
          Requirements

          Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.