Birth Defects Reporting - STU1
0.1.2 - draft United States of America flag

Birth Defects Reporting - STU1, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 0.1.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-birthdefectsreporting-ig/ and changes regularly. See the Directory of published versions

Extension: ExtensionDischargedAge - Detailed Descriptions

Draft as of 2024-11-06

Definitions for the Extension-discharged-age extension.

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

0. Extension
Definition

This Extension profile represents the reported age of the patient at discharged time

ShortReported Age At discharge
2. Extension.extension
Control0..0
4. Extension.url
Fixed Valuehttp://hl7.org/fhir/us/birthdefectreporting/StructureDefinition/Extension-discharged-age
6. Extension.value[x]
ShortReported age
Control1..?
TypeQuantity, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSeeChoice of Data Typesfor further information about how to use [x]
8. Extension.value[x].value
Control1..?
10. Extension.value[x].code
BindingThe codes SHALL be taken from Units of Age
(required to http://hl7.org/fhir/us/birthdefectreporting/ValueSet/ValueSet-units-of-age)

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

0. Extension
Definition

This Extension profile represents the reported age of the patient at discharged time


Optional Extension Element - found in all resources.

ShortReported Age At dischargeOptional Extensions 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())
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.

Control0..0*
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. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. 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/us/birthdefectreporting/StructureDefinition/Extension-discharged-age
    6. Extension.value[x]
    Definition

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

    ShortReported ageValue of extension
    Control10..1
    TypeQuantity, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, CodeableConcept, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, 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()))
    8. Extension.value[x].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).

    Control10..1
    Typedecimal
    Is Modifierfalse
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.value[x].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
    Control0..1
    BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
    (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

    How the Quantity should be understood and represented.

    Typecode
    Is Modifiertrue because 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
    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
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    12. Extension.value[x].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
    BindingThe codes SHALL be taken from For codes, see Units of Age
    (required to http://hl7.org/fhir/us/birthdefectreporting/ValueSet/ValueSet-units-of-age)
    Typecode
    Is Modifierfalse
    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.

    Invariantsele-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 found here

    0. Extension
    Definition

    This Extension profile represents the reported age of the patient at discharged time

    ShortReported Age At discharge
    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
    Control0..0
    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.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/us/birthdefectreporting/StructureDefinition/Extension-discharged-age
      8. Extension.value[x]
      Definition

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

      ShortReported age
      Control1..1
      TypeQuantity
      [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()))
      10. Extension.value[x].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
      12. Extension.value[x].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.value[x].extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 14. Extension.value[x].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).

        Control1..1
        Typedecimal
        Is Modifierfalse
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        16. Extension.value[x].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
        Control0..1
        BindingThe codes SHALL be taken from QuantityComparator
        (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

        How the Quantity should be understood and represented.

        Typecode
        Is Modifiertrue because 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
        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
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. Extension.value[x].unit
        Definition

        A human-readable form of the unit.

        ShortUnit representation
        Control0..1
        Typestring
        Is Modifierfalse
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. Extension.value[x].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
        Is Modifierfalse
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. Extension.value[x].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
        BindingThe codes SHALL be taken from Units of Age
        (required to http://hl7.org/fhir/us/birthdefectreporting/ValueSet/ValueSet-units-of-age)
        Typecode
        Is Modifierfalse
        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.

        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))