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

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

Extension: ExtensionCitation_Summary - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-Citation.summary extension.

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

0. Extension
Definition

R5: Citation.summary (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: A human-readable display of key concepts to represent the citation (new)Optional Extensions Element
Comments

Element Citation.summary is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary has no mapping targets in FHIR STU3. 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() | (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.extension
Definition

An Extension


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.

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
Alternate Namesextensions, user content
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:style
    Slice Namestyle
    Definition

    R5: Citation.summary.style (new:CodeableConcept)

    ShortR5: Format for display of the citation summary (new)Additional Content defined by implementations
    Comments

    Element Citation.summary.style is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.style is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.style has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Requirements

    Element Citation.summary.style is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.style is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.style has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    6. Extension.extension:style.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 Valuestyle
    8. Extension.extension:style.value[x]
    Definition

    Format for display of the citation summary.


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

    ShortFormat for display of the citation summaryValue of extension
    Control0..1
    BindingUnless not suitable, these codes SHALL be taken from For codes, see R5CitationSummaryStyleForR3 (0.1.0)
    (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-citation-summary-style-for-R3|0.1.0)
    TypeCodeableConcept, 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, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    10. Extension.extension:text
    Slice Nametext
    Definition

    R5: Citation.summary.text (new:markdown)

    ShortR5: The human-readable display of the citation summary (new)Additional Content defined by implementations
    Comments

    Element Citation.summary.text is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.text is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.text has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Requirements

    Element Citation.summary.text is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.text is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.text has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

    12. Extension.extension:text.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 Valuetext
    14. Extension.extension:text.value[x]
    Definition

    The human-readable display of the citation summary.


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

    ShortThe human-readable display of the citation summaryValue of extension
    Control10..1
    Typemarkdown, date, dateTime, Meta, code, string, Address, Attachment, integer, oid, Count, instant, ContactPoint, HumanName, Money, Identifier, Coding, SampledData, Ratio, id, positiveInt, Age, Distance, Reference, Period, Quantity, Duration, Range, uri, Annotation, boolean, base64Binary, Signature, unsignedInt, time, Timing, decimal, CodeableConcept
    [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
    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
    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://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.summary
    18. 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..01
    TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

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

    0. Extension
    Definition

    R5: Citation.summary (new:BackboneElement)

    ShortR5: A human-readable display of key concepts to represent the citation (new)
    Comments

    Element Citation.summary is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary has no mapping targets in FHIR STU3. 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:style
      Slice Namestyle
      Definition

      R5: Citation.summary.style (new:CodeableConcept)

      ShortR5: Format for display of the citation summary (new)
      Comments

      Element Citation.summary.style is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.style is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.style has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Citation.summary.style is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.style is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.style has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:style.url
      Control1..1
      Fixed Valuestyle
      8. Extension.extension:style.value[x]
      Definition

      Format for display of the citation summary.

      ShortFormat for display of the citation summary
      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from R5CitationSummaryStyleForR3 (0.1.0)
      (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-citation-summary-style-for-R3|0.1.0)
      TypeCodeableConcept
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:text
      Slice Nametext
      Definition

      R5: Citation.summary.text (new:markdown)

      ShortR5: The human-readable display of the citation summary (new)
      Comments

      Element Citation.summary.text is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.text is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.text has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element Citation.summary.text is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.text is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.text has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:text.url
      Control1..1
      Fixed Valuetext
      14. Extension.extension:text.value[x]
      Definition

      The human-readable display of the citation summary.

      ShortThe human-readable display of the citation summary
      Control1..1
      Typemarkdown
      [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
      16. Extension.url
      Control1..1
      Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.summary
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: Citation.summary (new:BackboneElement)

      ShortR5: A human-readable display of key concepts to represent the citation (new)
      Comments

      Element Citation.summary is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary has no mapping targets in FHIR STU3. 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() | (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

      An Extension

      ShortExtension
      Control1..*
      TypeExtension
      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:style
        Slice Namestyle
        Definition

        R5: Citation.summary.style (new:CodeableConcept)

        ShortR5: Format for display of the citation summary (new)
        Comments

        Element Citation.summary.style is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.style is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.style has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        Control0..1
        TypeExtension
        Requirements

        Element Citation.summary.style is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.style is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.style has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

        8. Extension.extension:style.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.
        10. Extension.extension:style.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 12. Extension.extension:style.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 Valuestyle
          14. Extension.extension:style.value[x]
          Definition

          Format for display of the citation summary.

          ShortFormat for display of the citation summary
          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from R5CitationSummaryStyleForR3 (0.1.0)
          (extensible to http://hl7.org/fhir/uv/xver/ValueSet/R5-citation-summary-style-for-R3|0.1.0)
          TypeCodeableConcept
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          16. Extension.extension:text
          Slice Nametext
          Definition

          R5: Citation.summary.text (new:markdown)

          ShortR5: The human-readable display of the citation summary (new)
          Comments

          Element Citation.summary.text is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.text is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.text has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          Control1..1
          TypeExtension
          Requirements

          Element Citation.summary.text is part of an existing definition because parent element Citation.summary requires a cross-version extension. Element Citation.summary.text is not mapped to FHIR STU3, since FHIR R5 Citation is not mapped. Element Citation.summary.text has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).

          18. Extension.extension:text.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.
          20. Extension.extension:text.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.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 22. Extension.extension:text.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 Valuetext
            24. Extension.extension:text.value[x]
            Definition

            The human-readable display of the citation summary.

            ShortThe human-readable display of the citation summary
            Control1..1
            Typemarkdown
            [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
            26. 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://hl7.org/fhir/5.0/StructureDefinition/extension-Citation.summary
            28. 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..0
            TypeChoice of: base64Binary, boolean, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, Meta
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension