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

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

Extension: ExtensionCoverage_PaymentBy - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the ext-R5-Coverage.paymentBy extension.

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

0. Extension
Definition

R5: Coverage.paymentBy (new:BackboneElement)


Optional Extension Element - found in all resources.

ShortR5: Self-pay parties and responsibility (new)Optional Extensions Element
Comments

Element Coverage.paymentBy has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy has no mapping targets in FHIR R4. 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() or (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() or (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. 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.

Control10..*
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())
ele-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.extension:party
    Slice Nameparty
    Definition

    R5: Coverage.paymentBy.party (new:Reference(Patient,RelatedPerson,Organization))

    ShortR5: Parties performing self-payment (new)Additional content defined by implementations
    Comments

    Element Coverage.paymentBy.party is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.party has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.party has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control10..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Coverage.paymentBy.party is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.party has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.party has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    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())
    ele-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())
    6. Extension.extension:party.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 Valueparty
    8. Extension.extension:party.value[x]
    Definition

    The list of parties providing non-insurance payment for the treatment costs.


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

    ShortParties performing self-paymentValue of extension
    Control10..1
    TypeReference(Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson, Cross-version Profile for R5.Organization for use in FHIR R4, Organization), 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, TriggerDefinition, Quantity, 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()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    10. Extension.extension:responsibility
    Slice Nameresponsibility
    Definition

    R5: Coverage.paymentBy.responsibility (new:string)

    ShortR5: Party's responsibility (new)Additional content defined by implementations
    Comments

    Element Coverage.paymentBy.responsibility is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.responsibility has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.responsibility has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    Control0..1*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Requirements

    Element Coverage.paymentBy.responsibility is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.responsibility has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.responsibility has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

    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())
    ele-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())
    12. Extension.extension:responsibility.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 Valueresponsibility
    14. Extension.extension:responsibility.value[x]
    Definition

    Description of the financial responsibility.


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

    ShortParty's responsibilityValue of extension
    Control0..1
    Typestring, 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, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    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
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.paymentBy
    18. Extension.value[x]
    Definition

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

    ShortValue of extension
    Control0..01
    TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-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 foundhere

    0. Extension
    Definition

    R5: Coverage.paymentBy (new:BackboneElement)

    ShortR5: Self-pay parties and responsibility (new)
    Comments

    Element Coverage.paymentBy has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy has no mapping targets in FHIR R4. 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:party
      Slice Nameparty
      Definition

      R5: Coverage.paymentBy.party (new:Reference(Patient,RelatedPerson,Organization))

      ShortR5: Parties performing self-payment (new)
      Comments

      Element Coverage.paymentBy.party is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.party has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.party has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control1..1
      Requirements

      Element Coverage.paymentBy.party is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.party has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.party has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      6. Extension.extension:party.url
      Control1..1
      Fixed Valueparty
      8. Extension.extension:party.value[x]
      Definition

      The list of parties providing non-insurance payment for the treatment costs.

      ShortParties performing self-payment
      Control1..1
      TypeReference(Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson, Cross-version Profile for R5.Organization for use in FHIR R4, Organization)
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      10. Extension.extension:responsibility
      Slice Nameresponsibility
      Definition

      R5: Coverage.paymentBy.responsibility (new:string)

      ShortR5: Party's responsibility (new)
      Comments

      Element Coverage.paymentBy.responsibility is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.responsibility has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.responsibility has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      Control0..1
      Requirements

      Element Coverage.paymentBy.responsibility is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.responsibility has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.responsibility has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

      12. Extension.extension:responsibility.url
      Control1..1
      Fixed Valueresponsibility
      14. Extension.extension:responsibility.value[x]
      Definition

      Description of the financial responsibility.

      ShortParty's responsibility
      Control0..1
      Typestring
      [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-Coverage.paymentBy
      18. Extension.value[x]
      Control0..0

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

      0. Extension
      Definition

      R5: Coverage.paymentBy (new:BackboneElement)

      ShortR5: Self-pay parties and responsibility (new)
      Comments

      Element Coverage.paymentBy has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy has no mapping targets in FHIR R4. 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() 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
      Control1..*
      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.extension:party
        Slice Nameparty
        Definition

        R5: Coverage.paymentBy.party (new:Reference(Patient,RelatedPerson,Organization))

        ShortR5: Parties performing self-payment (new)
        Comments

        Element Coverage.paymentBy.party is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.party has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.party has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

        Control1..1
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Requirements

        Element Coverage.paymentBy.party is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.party has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.party has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

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

          The list of parties providing non-insurance payment for the treatment costs.

          ShortParties performing self-payment
          Control1..1
          TypeReference(Cross-version Profile for R5.Patient for use in FHIR R4, Patient, Cross-version Profile for R5.RelatedPerson for use in FHIR R4, RelatedPerson, Cross-version Profile for R5.Organization for use in FHIR R4, Organization)
          [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()))
          16. Extension.extension:responsibility
          Slice Nameresponsibility
          Definition

          R5: Coverage.paymentBy.responsibility (new:string)

          ShortR5: Party's responsibility (new)
          Comments

          Element Coverage.paymentBy.responsibility is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.responsibility has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.responsibility has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

          Control0..1
          TypeExtension
          Is Modifierfalse
          Summaryfalse
          Requirements

          Element Coverage.paymentBy.responsibility is part of an existing definition because parent element Coverage.paymentBy requires a cross-version extension. Element Coverage.paymentBy.responsibility has a context of Coverage based on following the parent source element upwards and mapping to Coverage. Element Coverage.paymentBy.responsibility has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

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

            Description of the financial responsibility.

            ShortParty's responsibility
            Control0..1
            Typestring
            [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            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
            Is Modifierfalse
            XML FormatIn the XML format, this property is represented as an attribute.
            Summaryfalse
            Fixed Valuehttp://hl7.org/fhir/5.0/StructureDefinition/extension-Coverage.paymentBy
            28. Extension.value[x]
            Definition

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

            ShortValue of extension
            Control0..0
            TypeChoice of: base64Binary, boolean, canonical, code, date, dateTime, decimal, id, instant, integer, markdown, oid, positiveInt, string, time, unsignedInt, uri, url, uuid, Address, Age, Annotation, Attachment, CodeableConcept, Coding, ContactPoint, Count, Distance, Duration, HumanName, Identifier, Money, Period, Quantity, Range, Ratio, Reference, SampledData, Signature, Timing, ContactDetail, Contributor, DataRequirement, Expression, ParameterDefinition, RelatedArtifact, TriggerDefinition, UsageContext, Dosage, Meta
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summaryfalse
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))